Major Jetbrains HTTP Client upgrade. Move to BETA (#15779)

* Add notes to requests for better readability

* Adds extra configs for jetbrains http client for testing

* Adding new sample data

* Changes

* Setting up test infrastructure

* Adds body to requests.

* Fixing some bugs in map traversal

It'd be much better to use a proper library for this though

* Adding secret file to gitignore

* Adds github spec, for complex example.

Add null check to avoid errors in example extraction

* Add support for custom variables in request body

* Add support for all basic Auth headers

* Not sure whaet happened with my api mustache file

* Add support for custom headers

* Fixes empty lines issue

* Adds support for Accept header

* Adding many tests, deleting experiment files

* Updates generator doc

* Completes README file with extra information

* Runs generate-samples and export docs

* Running sample generation

* Adding missing files to samples

* Removing forgotten stdout statements

* Ignore one test making the docker image generation fail
This commit is contained in:
julien Lengrand-Lambert 2024-03-09 09:56:26 +01:00 committed by GitHub
parent 93d5fc646b
commit f1fcceb375
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
123 changed files with 395596 additions and 100 deletions

1
.gitignore vendored
View File

@ -283,3 +283,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

View File

@ -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"

View File

@ -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"

View File

@ -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"

View File

@ -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"

View File

@ -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.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|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.|<dl><dt>**false**</dt><dd>No changes to the enum's are made, this is the default option.</dd><dt>**true**</dt><dd>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.</dd></dl>|false|
|legacyDiscriminatorBehavior|Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).|<dl><dt>**true**</dt><dd>The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.</dd><dt>**false**</dt><dd>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.</dd></dl>|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

View File

@ -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<String> bodyVariables = new ArrayList<>();
public static final String CUSTOM_HEADERS = "customHeaders";
public List<String> customHeaders = new ArrayList<>();
public CodegenType getTag() {
return CodegenType.CLIENT;
}
@ -74,6 +96,26 @@ public class JetbrainsHttpClientClientCodegen extends DefaultCodegen implements
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
@ -94,25 +136,262 @@ public class JetbrainsHttpClientClientCodegen extends DefaultCodegen implements
}
}
@Override
public Map<String, Object> postProcessSupportingFileData(Map<String, Object> bundle) {
return bundle;
}
@Override
public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels) {
return super.postProcessOperationsWithModels(objs, allModels);
OperationsMap results = super.postProcessOperationsWithModels(objs, allModels);
OperationMap ops = results.getOperations();
List<CodegenOperation> opList = ops.getOperation();
for(CodegenOperation codegenOperation : opList) {
List<RequestItem> 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;
}
List<RequestItem> getRequests(CodegenOperation codegenOperation) {
List<RequestItem> 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<String, Example> 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<RequestItem> handleCustomVariablesInRequests(List<RequestItem> 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<String, Object> linkedHashMap) {
String ret = "";
return traverseMap(linkedHashMap, ret);
}
private String traverseMap(LinkedHashMap<String, Object> linkedHashMap, String ret) {
ret = ret + "{" + JSON_ESCAPE_NEW_LINE + " ";
int numVars = linkedHashMap.entrySet().size();
int counter = 1;
for (Map.Entry<String, Object> 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<String, Object>) 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;
}
}

View File

@ -162,7 +162,6 @@ public class PostmanCollectionCodegen extends DefaultCodegen implements CodegenC
@Override
public void processOpts() {
super.processOpts();
if(additionalProperties().containsKey(FOLDER_STRATEGY)) {
folderStrategy = additionalProperties().get(FOLDER_STRATEGY).toString();
}

View File

@ -1,6 +1,6 @@
# {{appName}} - Jetbrains API Client
## OpenAPI File description
## General API description
{{#appDescription}}{{appDescription}}{{/appDescription}}
@ -10,7 +10,8 @@
## Documentation for API Endpoints
{{#generateApiDocs}}
All URIs are relative to *{{{basePath}}}*, but will link to the `.http` file that contains the endpoint definition
All URIs are relative to *{{{basePath}}}*, 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
------------ | ------------- | ------------- | -------------
@ -18,5 +19,29 @@ Class | Method | HTTP request | Description
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
{{/generateApiDocs}}
## Usage
_This client was generated by the jetbrains-http-client of OpenAPI Generator_
### 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 `{{VAR}}` 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 -> {{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_

View File

@ -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}}
{{#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}}

View File

@ -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.");
}
}

View File

@ -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<File> 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<File> 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<File> 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<File> 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<File> 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<File> 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&#39;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<File> 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&#39;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<File> 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&#39;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<File> 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<File> 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<File> 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&#39;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<File> 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&#39;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" +
"}");
}
}

View File

@ -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

View File

@ -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"
}
}
}
}
}
}

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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"
}
}
}
}
}

File diff suppressed because it is too large Load Diff

View File

@ -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

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -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

View File

@ -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

View File

@ -0,0 +1 @@
7.4.0-SNAPSHOT

View File

@ -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"
}

View File

@ -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

View File

@ -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"
}

View File

@ -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

View File

@ -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"
} ]
}
}

View File

@ -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

View File

@ -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"
}

View File

@ -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

View File

@ -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"
}

View File

@ -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

View File

@ -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."
}

View File

@ -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

View File

@ -0,0 +1,6 @@
## EmojisApi
### Get emojis
## Get emojis
GET https://api.github.com/emojis
Accept: application/json

View File

@ -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"
}

View File

@ -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
}

View File

@ -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

View File

@ -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"
}

View File

@ -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"
}

View File

@ -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

View File

@ -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**"
}

View File

@ -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

View File

@ -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"
}

View File

@ -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" ]
}

View File

@ -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" : "********"
}

View File

@ -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&#39;s namespace
## List packages for the authenticated user&#39;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

View File

@ -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"
}

View File

@ -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!"
}

View File

@ -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

View File

@ -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

File diff suppressed because it is too large Load Diff

View File

@ -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

View File

@ -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"
}

View File

@ -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"
}

View File

@ -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"
}

View File

@ -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"
}

View File

@ -0,0 +1,974 @@
# GitHub v3 REST API - Jetbrains API Client
## General API description
GitHub&#39;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_

View File

@ -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

View File

@ -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

View File

@ -0,0 +1 @@
7.4.0-SNAPSHOT

View File

@ -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"
}

View File

@ -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"
}

View File

@ -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"
}

View File

@ -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"
}

View File

@ -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"
}
}

View File

@ -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}"]
}

View File

@ -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}}

View File

@ -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"]
}

View File

@ -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 &#x60;X-API-Key&#x60; header value, for example: &#x60;&#x60;&#x60; curl -H \&quot;Content-Type: application/json\&quot; \\ -H \&quot;X-API-Key: YOUR_API_KEY\&quot; \\ ... &#x60;&#x60;&#x60; ## 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: \&quot;vXX\&quot;, where XX is the version number. For example: &#x60;&#x60;&#x60; https://checkout-test.adyen.com/v71/payments &#x60;&#x60;&#x60; ## 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: &#x60;&#x60;&#x60; https://{PREFIX}-checkout-live.adyenpayments.com/checkout/v71/payments &#x60;&#x60;&#x60; Get your &#x60;{PREFIX}&#x60; from your live Customer Area under **Developers** &gt; **API URLs** &gt; **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&#39;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&#x3D;api&amp;version&#x3D;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_

View File

@ -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

View File

@ -0,0 +1,2 @@
Apis/PaymentsApi.http
README.md

View File

@ -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&#39;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"
}

View File

@ -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_

View File

@ -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

View File

@ -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

View File

@ -0,0 +1 @@
7.4.0-SNAPSHOT

View File

@ -0,0 +1,6 @@
## BenchmarksApi
### GET /benchmarks
## GET /benchmarks
GET https://api.opendota.com/api/benchmarks
Accept: application/json; charset=utf-8

View File

@ -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

View File

@ -0,0 +1,6 @@
## DistributionsApi
### GET /distributions
## GET /distributions
GET https://api.opendota.com/api/distributions
Accept: application/json; charset=utf-8

View File

@ -0,0 +1,6 @@
## ExplorerApi
### GET /explorer
## GET /explorer
GET https://api.opendota.com/api/explorer
Accept: application/json; charset=utf-8

View File

@ -0,0 +1,6 @@
## FindMatchesApi
### GET /
## GET /
GET https://api.opendota.com/api/findMatches
Accept: application/json; charset=utf-8

View File

@ -0,0 +1,6 @@
## HealthApi
### GET /health
## GET /health
GET https://api.opendota.com/api/health
Accept: application/json; charset=utf-8

View File

@ -0,0 +1,6 @@
## HeroStatsApi
### GET /heroStats
## GET /heroStats
GET https://api.opendota.com/api/heroStats
Accept: application/json; charset=utf-8

View File

@ -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

View File

@ -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

Some files were not shown because too many files have changed in this diff Show More