forked from loafle/openapi-generator-original
JetBrains HTTP Client - Adds support for query and header params and env file (#18844)
* Adds basic support for query params. * Need to parameterize them * Need to add tests * Need to add option to skip, maybe * Need to add support for header params too * Parameterizes query param values * Need to add tests * Need to add option to skip, maybe * Need to add support for header params too * Remove extra empty line * Adds support for header params * Also fixes extra end of line bug. * Fixing failing test * Adding tests for query params * Adding tests for header params * Adding basic support for env file * Add support for env file for path variables and custom header variables * TODO : Add tests * Adding tests for env generation * Adding generated test files * Fix namefile
This commit is contained in:
parent
1c787babad
commit
42c78403cb
@ -31,6 +31,8 @@ import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.io.Writer;
|
||||
import java.util.*;
|
||||
import java.util.regex.Matcher;
|
||||
import java.util.regex.Pattern;
|
||||
|
||||
import org.openapitools.codegen.meta.GeneratorMetadata;
|
||||
import org.openapitools.codegen.meta.Stability;
|
||||
@ -66,6 +68,9 @@ public class JetbrainsHttpClientClientCodegen extends DefaultCodegen implements
|
||||
|
||||
public List<String> customHeaders = new ArrayList<>();
|
||||
|
||||
// A map is nice, because that way I easily override variables across APIs, for pagination for example. This should add nice defaults
|
||||
private final Map<String, Object> customVariables = new HashMap<>();
|
||||
|
||||
|
||||
public CodegenType getTag() {
|
||||
return CodegenType.CLIENT;
|
||||
@ -96,6 +101,7 @@ public class JetbrainsHttpClientClientCodegen extends DefaultCodegen implements
|
||||
embeddedTemplateDir = templateDir = "jetbrains-http-client";
|
||||
apiPackage = "Apis";
|
||||
supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
|
||||
supportingFiles.add(new SupportingFile("http-client.template.env.mustache", "Apis", "http-client.template.env.json"));
|
||||
|
||||
|
||||
cliOptions.clear();
|
||||
@ -116,6 +122,14 @@ public class JetbrainsHttpClientClientCodegen extends DefaultCodegen implements
|
||||
if (additionalProperties.containsKey(CUSTOM_HEADERS)) {
|
||||
customHeaders = Arrays.asList(additionalProperties.get(CUSTOM_HEADERS).toString().split("&"));
|
||||
}
|
||||
|
||||
bodyVariables.forEach(variable -> customVariables.put(variable, ""));
|
||||
for(String header: customHeaders) {
|
||||
List<String> variables = extractDoubleCurlyBraces(header);
|
||||
if(!variables.isEmpty()) {
|
||||
variables.forEach(v -> customVariables.put(v, ""));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
@ -152,9 +166,17 @@ public class JetbrainsHttpClientClientCodegen extends DefaultCodegen implements
|
||||
codegenOperation.vendorExtensions.put("customHeaders", customHeaders);
|
||||
}
|
||||
}
|
||||
|
||||
return results;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Map<String, Object> postProcessSupportingFileData(Map<String, Object> objs) {
|
||||
var variables = new ArrayList<>(customVariables.keySet());
|
||||
objs.put("vendorExtensionsVariables", variables);
|
||||
return objs;
|
||||
}
|
||||
|
||||
List<RequestItem> getRequests(CodegenOperation codegenOperation) {
|
||||
List<RequestItem> items = new ArrayList<>();
|
||||
|
||||
@ -195,10 +217,42 @@ public class JetbrainsHttpClientClientCodegen extends DefaultCodegen implements
|
||||
items.add(new RequestItem(codegenOperation.summary, null));
|
||||
}
|
||||
|
||||
codegenOperation.headerParams.forEach(param -> customVariables.put(param.baseName, ""));
|
||||
codegenOperation.queryParams.forEach(param -> customVariables.put(param.paramName, ""));
|
||||
|
||||
// I also need to grab the parameters from the path
|
||||
List<String> pathVariables = extractSingleCurlyBraces(codegenOperation.path);
|
||||
pathVariables.forEach(pv -> customVariables.put(pv, ""));
|
||||
|
||||
// Handling custom variables now
|
||||
return handleCustomVariablesInRequests(items);
|
||||
}
|
||||
|
||||
public static List<String> extractDoubleCurlyBraces(String input) {
|
||||
List<String> result = new ArrayList<>();
|
||||
Pattern pattern = Pattern.compile("\\{\\{([^}]+)\\}\\}");
|
||||
Matcher matcher = pattern.matcher(input);
|
||||
|
||||
while (matcher.find()) {
|
||||
result.add(matcher.group(1));
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
public static List<String> extractSingleCurlyBraces(String input) {
|
||||
List<String> result = new ArrayList<>();
|
||||
Pattern pattern = Pattern.compile("\\{([^}]+)\\}");
|
||||
Matcher matcher = pattern.matcher(input);
|
||||
|
||||
while (matcher.find()) {
|
||||
result.add(matcher.group(1));
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
private List<RequestItem> handleCustomVariablesInRequests(List<RequestItem> items) {
|
||||
if (!bodyVariables.isEmpty()) {
|
||||
for (var item : items) {
|
||||
@ -220,7 +274,7 @@ public class JetbrainsHttpClientClientCodegen extends DefaultCodegen implements
|
||||
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("# 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) #");
|
||||
|
@ -5,13 +5,16 @@
|
||||
{{#vendorExtensions.requests}}
|
||||
### {{#summary}}{{summary}}{{/summary}}
|
||||
## {{name}}
|
||||
{{httpMethod}} {{basePath}}{{#lambda.doubleMustache}}{{path}}{{/lambda.doubleMustache}}{{#authMethods}}{{#isKeyInQuery}}?{{keyParamName}}={{#lambda.doubleMustache}}{queryKey}{{/lambda.doubleMustache}}{{/isKeyInQuery}}{{/authMethods}}
|
||||
{{httpMethod}} {{basePath}}{{#lambda.doubleMustache}}{{path}}{{/lambda.doubleMustache}}{{>queryParams}}
|
||||
{{#consumes}}
|
||||
Content-Type: {{{mediaType}}}
|
||||
{{/consumes}}
|
||||
{{#produces}}
|
||||
Accept: {{{mediaType}}}
|
||||
{{/produces}}
|
||||
{{#headerParams}}
|
||||
{{baseName}}: {{=<% %>=}}{{<%paramName%>}}<%={{ }}=%>
|
||||
{{/headerParams}}
|
||||
{{#vendorExtensions.customHeaders}}
|
||||
{{{.}}}
|
||||
{{/vendorExtensions.customHeaders}}
|
||||
|
@ -0,0 +1,7 @@
|
||||
{
|
||||
"dev": {
|
||||
{{#vendorExtensionsVariables}}
|
||||
"{{.}}" : ""{{^-last}},{{/-last}}
|
||||
{{/vendorExtensionsVariables}}
|
||||
}
|
||||
}
|
1
modules/openapi-generator/src/main/resources/jetbrains-http-client/queryParams.mustache
vendored
Normal file
1
modules/openapi-generator/src/main/resources/jetbrains-http-client/queryParams.mustache
vendored
Normal file
@ -0,0 +1 @@
|
||||
{{! Case where there is no query params, auth does everything}}{{^queryParams}}{{#authMethods}}{{#isKeyInQuery}}?{{keyParamName}}={{#lambda.doubleMustache}}{queryKey}{{/lambda.doubleMustache}}{{/isKeyInQuery}}{{/authMethods}}{{/queryParams}}{{#queryParams}}{{! If there are query params, auth has no logic}}{{#-first}}?{{/-first}}{{paramName}}={{=<% %>=}}{{<%paramName%>}}<%={{ }}=%>{{^-last}}&{{/-last}}{{#-last}}{{#authMethods}}{{#isKeyInQuery}}&{{keyParamName}}={{#lambda.doubleMustache}}{queryKey}{{/lambda.doubleMustache}}{{/isKeyInQuery}}{{/authMethods}}{{/-last}}{{/queryParams}}
|
@ -1,7 +1,7 @@
|
||||
package org.openapitools.codegen.jetbrains.http.client;
|
||||
|
||||
import org.junit.jupiter.api.Disabled;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.testng.annotations.Ignore;
|
||||
import org.testng.annotations.Test;
|
||||
import org.openapitools.codegen.*;
|
||||
import org.openapitools.codegen.config.CodegenConfigurator;
|
||||
import org.openapitools.codegen.languages.JetbrainsHttpClientClientCodegen;
|
||||
@ -16,7 +16,6 @@ import java.util.List;
|
||||
import static org.openapitools.codegen.TestUtils.assertFileExists;
|
||||
|
||||
public class JetbrainsHttpClientClientCodegenTest {
|
||||
|
||||
@Test
|
||||
public void testBasicGenerationYaml() throws IOException {
|
||||
|
||||
@ -403,7 +402,7 @@ public class JetbrainsHttpClientClientCodegenTest {
|
||||
}
|
||||
|
||||
@Test
|
||||
@Disabled // For some reason this test fails during Docker image generation. Investigate one day.
|
||||
@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();
|
||||
@ -481,4 +480,300 @@ public class JetbrainsHttpClientClientCodegenTest {
|
||||
" \"channel\" : \"Android\"\n" +
|
||||
"}");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testBasicGenerationQueryParams() 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/SampleProjectWithAuthQuery.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/DefaultApi.http");
|
||||
assertFileExists(path);
|
||||
|
||||
// Checking with extra params
|
||||
TestUtils.assertFileContains(path, "### Get User Info by Query Param\n" +
|
||||
"## Get User Info by Query Param\n" +
|
||||
"GET http://localhost:5000/v1/users/?page={{page}}&pUserId={{pUserId}}&api_key={{queryKey}}\n" +
|
||||
"Accept: application/json\n" +
|
||||
"Custom-Header: {{customHeader}}\n" +
|
||||
"Another-Custom-Header: {{anotherCustomHeader}}");
|
||||
|
||||
// Checking without extra params
|
||||
TestUtils.assertFileContains(path, "### Get User Info by User ID\n" +
|
||||
"## Get User Info by User ID\n" +
|
||||
"GET http://localhost:5000/v1/users/{{userId}}?api_key={{queryKey}}\n" +
|
||||
"Accept: application/json\n" +
|
||||
"strCode: {{strCode}}\n" +
|
||||
"strCode2: {{strCode2}}");
|
||||
|
||||
// Checking with only auth
|
||||
TestUtils.assertFileContains(path, "### Get User Info by User ID\n" +
|
||||
"## Get User Info by User ID\n" +
|
||||
"GET http://localhost:5000/v1/users/{{userId}}?api_key={{queryKey}}\n" +
|
||||
"Accept: application/json\n" +
|
||||
"strCode: {{strCode}}\n" +
|
||||
"strCode2: {{strCode2}}");
|
||||
|
||||
// Checking with only param
|
||||
TestUtils.assertFileContains(path, "### Update User Information\n" +
|
||||
"## Update User Information\n" +
|
||||
"PATCH http://localhost:5000/v1/users/{{userId}}?page={{page}}\n" +
|
||||
"Content-Type: application/json\n" +
|
||||
"Accept: application/json\n" +
|
||||
"strCode: {{strCode}}\n" +
|
||||
"strCode2: {{strCode2}}\n" +
|
||||
"\n" +
|
||||
"{\n" +
|
||||
" \"firstName\" : \"Rebecca\"\n" +
|
||||
"}");
|
||||
|
||||
// Checking when there is nothing
|
||||
TestUtils.assertFileContains(path, "### Create New User\n" +
|
||||
"## Example request for Get User\n" +
|
||||
"POST http://localhost:5000/v1/user\n" +
|
||||
"Content-Type: application/json\n" +
|
||||
"Accept: application/json\n" +
|
||||
"\n" +
|
||||
"{\n" +
|
||||
" \"id\": 777,\n" +
|
||||
" \"firstName\": \"Alotta\",\n" +
|
||||
" \"lastName\": \"Rotta\",\n" +
|
||||
" \"email\": \"alotta.rotta@gmail.com\",\n" +
|
||||
" \"dateOfBirth\": \"1997-10-31\",\n" +
|
||||
" \"emailVerified\": true,\n" +
|
||||
" \"createDate\": \"2019-08-24\"\n" +
|
||||
"}");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testBasicGenerationHeaderParams() 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/SampleProjectWithHeaderParams.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/DefaultApi.http");
|
||||
assertFileExists(path);
|
||||
|
||||
// Checking with extra headers and header security
|
||||
TestUtils.assertFileContains(path, "### Get User Info by Query Param\n" +
|
||||
"## Get User Info by Query Param\n" +
|
||||
"GET http://localhost:5000/v1/users/?page={{page}}&pUserId={{pUserId}}\n" +
|
||||
"Accept: application/json\n" +
|
||||
"Custom-Header: {{customHeader}}\n" +
|
||||
"Another-Custom-Header: {{anotherCustomHeader}}\n" +
|
||||
"X-API-Key: {{apiKey}}");
|
||||
|
||||
// Checking with only header security
|
||||
TestUtils.assertFileContains(path, "### Update User Information\n" +
|
||||
"## Update User Information\n" +
|
||||
"PATCH http://localhost:5000/v1/users/{{userId}}?page={{page}}\n" +
|
||||
"Content-Type: application/json\n" +
|
||||
"Accept: application/json\n" +
|
||||
"strCode: {{strCode}}\n" +
|
||||
"strCode2: {{strCode2}}\n" +
|
||||
"X-API-Key: {{apiKey}}");
|
||||
|
||||
// Checking with only extra headers
|
||||
TestUtils.assertFileContains(path, "### Get group by ID\n" +
|
||||
"## Get group by ID\n" +
|
||||
"GET http://localhost:5000/v1/groups/{{groupId}}\n" +
|
||||
"Accept: application/json\n" +
|
||||
"Custom-Header: {{customHeader}}\n" +
|
||||
"Another-Custom-Header: {{anotherCustomHeader}}\n");
|
||||
|
||||
TestUtils.assertFileContains(path, "### Create New User\n" +
|
||||
"## Example request for Get User\n" +
|
||||
"POST http://localhost:5000/v1/user\n" +
|
||||
"Content-Type: application/json\n" +
|
||||
"Accept: application/json");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testTemplateEnvironmentFileGenerationEmpty() 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/environmentgeneration/Simple.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//http-client.template.env.json");
|
||||
assertFileExists(path);
|
||||
|
||||
TestUtils.assertFileContains(path, "{\n" +
|
||||
" \"dev\": {\n" +
|
||||
" }\n" +
|
||||
"}");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testTemplateEnvironmentFileGenerationPath() 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/environmentgeneration/Path.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//http-client.template.env.json");
|
||||
assertFileExists(path);
|
||||
|
||||
TestUtils.assertFileContains(path, "{\n" +
|
||||
" \"dev\": {\n" +
|
||||
" \"resource\" : \"\"\n" +
|
||||
" }\n" +
|
||||
"}");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testTemplateEnvironmentFileGenerationQueryParam() 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/environmentgeneration/QueryParam.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//http-client.template.env.json");
|
||||
assertFileExists(path);
|
||||
|
||||
TestUtils.assertFileContains(path, "{\n" +
|
||||
" \"dev\": {\n" +
|
||||
" \"laneRole\" : \"\",\n" +
|
||||
" \"heroId\" : \"\"\n" +
|
||||
" }\n" +
|
||||
"}");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testTemplateEnvironmentFileGenerationHeader() 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/environmentgeneration/Header.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//http-client.template.env.json");
|
||||
assertFileExists(path);
|
||||
|
||||
TestUtils.assertFileContains(path, "{\n" +
|
||||
" \"dev\": {\n" +
|
||||
" \"Custom-Header\" : \"\",\n" +
|
||||
" \"Another-Custom-Header\" : \"\"\n" +
|
||||
" }\n" +
|
||||
"}");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testTemplateEnvironmentFileGenerationCustomVariable() 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/environmentgeneration/CustomVariable.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//http-client.template.env.json");
|
||||
assertFileExists(path);
|
||||
|
||||
TestUtils.assertFileContains(path, "{\n" +
|
||||
" \"dev\": {\n" +
|
||||
" \"MY_VAR_LAST_NAME\" : \"\",\n" +
|
||||
" \"MY_VAR_NAME\" : \"\"\n" +
|
||||
" }\n" +
|
||||
"}");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testTemplateEnvironmentFileGenerationCustomHeaders() 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/environmentgeneration/CustomHeaders.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//http-client.template.env.json");
|
||||
assertFileExists(path);
|
||||
|
||||
TestUtils.assertFileContains(path, "{\n" +
|
||||
" \"dev\": {\n" +
|
||||
" \"cookieKey\" : \"\"\n" +
|
||||
" }\n" +
|
||||
"}");
|
||||
}
|
||||
|
||||
}
|
||||
|
@ -44,6 +44,13 @@ paths:
|
||||
tags:
|
||||
- basic
|
||||
parameters:
|
||||
- description: Page length
|
||||
name: page
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: 50
|
||||
- description: Query Id.
|
||||
name: pUserId
|
||||
in: query
|
||||
|
@ -0,0 +1,378 @@
|
||||
openapi: 3.1.0
|
||||
info:
|
||||
title: Sample project
|
||||
version: '1.0'
|
||||
contact:
|
||||
name: Julien Lengrand-Lambert
|
||||
email: fake@email.com
|
||||
url: 'https://github.com/jlengrand'
|
||||
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.
|
||||
security:
|
||||
- ApiKeyAuthQuery: [ ]
|
||||
parameters:
|
||||
- description: Page length
|
||||
name: page
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: 50
|
||||
- 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
|
||||
security:
|
||||
- ApiKeyAuthQuery: [ ]
|
||||
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
|
||||
parameters:
|
||||
- description: Page length
|
||||
name: page
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: 50
|
||||
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.
|
||||
'/groups/{groupId}':
|
||||
get:
|
||||
summary: Get group by ID
|
||||
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
|
||||
ApiKeyAuthQuery:
|
||||
in: query
|
||||
name: api_key
|
||||
type: apiKey
|
||||
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
|
@ -0,0 +1,391 @@
|
||||
openapi: 3.1.0
|
||||
info:
|
||||
title: Sample project
|
||||
version: '1.0'
|
||||
contact:
|
||||
name: Julien Lengrand-Lambert
|
||||
email: fake@email.com
|
||||
url: 'https://github.com/jlengrand'
|
||||
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.
|
||||
security:
|
||||
- ApiKeyAuth: [ ]
|
||||
parameters:
|
||||
- description: Page length
|
||||
name: page
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: 50
|
||||
- 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
|
||||
security:
|
||||
- ApiKeyAuth: [ ]
|
||||
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
|
||||
security:
|
||||
- ApiKeyAuth: [ ]
|
||||
parameters:
|
||||
- description: Page length
|
||||
name: page
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: 50
|
||||
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.
|
||||
'/groups/{groupId}':
|
||||
get:
|
||||
summary: Get group by ID
|
||||
parameters:
|
||||
- description: group Id
|
||||
name: groupId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
default: 1
|
||||
- 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: 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
|
||||
ApiKeyAuthQuery:
|
||||
in: query
|
||||
name: api_key
|
||||
type: apiKey
|
||||
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 it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -33,4 +33,5 @@ Apis/SecretScanningApi.http
|
||||
Apis/SecurityAdvisoriesApi.http
|
||||
Apis/TeamsApi.http
|
||||
Apis/UsersApi.http
|
||||
Apis/http-client.template.env.json
|
||||
README.md
|
||||
|
@ -156,7 +156,7 @@ 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
|
||||
DELETE https://api.github.com/repos/{{owner}}/{{repo}}/actions/caches?key={{key}}&ref={{ref}}
|
||||
Accept: application/json
|
||||
|
||||
### Delete an artifact
|
||||
@ -272,7 +272,7 @@ Accept: application/json
|
||||
|
||||
### List GitHub Actions caches for a repository
|
||||
## List GitHub Actions caches for a repository
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/caches
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/caches?perPage={{perPage}}&page={{page}}&ref={{ref}}&key={{key}}&sort={{sort}}&direction={{direction}}
|
||||
Accept: application/json
|
||||
|
||||
### Get GitHub Actions cache usage for a repository
|
||||
@ -282,7 +282,7 @@ 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
|
||||
GET https://api.github.com/orgs/{{org}}/actions/cache/usage-by-repository?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Get GitHub Actions cache usage for an organization
|
||||
@ -413,12 +413,12 @@ Accept: application/json
|
||||
|
||||
### Get a workflow run
|
||||
## Get a workflow run
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}?excludePullRequests={{excludePullRequests}}
|
||||
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}}
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/attempts/{{attempt_number}}?excludePullRequests={{excludePullRequests}}
|
||||
Accept: application/json
|
||||
|
||||
### Get workflow run usage
|
||||
@ -433,27 +433,27 @@ Accept: application/json
|
||||
|
||||
### List artifacts for a repository
|
||||
## List artifacts for a repository
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/artifacts
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/artifacts?perPage={{perPage}}&page={{page}}&name={{name}}
|
||||
Accept: application/json
|
||||
|
||||
### List environment secrets
|
||||
## List environment secrets
|
||||
GET https://api.github.com/repositories/{{repository_id}}/environments/{{environment_name}}/secrets
|
||||
GET https://api.github.com/repositories/{{repository_id}}/environments/{{environment_name}}/secrets?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List environment variables
|
||||
## List environment variables
|
||||
GET https://api.github.com/repositories/{{repository_id}}/environments/{{environment_name}}/variables
|
||||
GET https://api.github.com/repositories/{{repository_id}}/environments/{{environment_name}}/variables?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/jobs?filter={{filter}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/attempts/{{attempt_number}}/jobs?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List labels for a self-hosted runner for an organization
|
||||
@ -468,37 +468,37 @@ Accept: application/json
|
||||
|
||||
### List organization secrets
|
||||
## List organization secrets
|
||||
GET https://api.github.com/orgs/{{org}}/actions/secrets
|
||||
GET https://api.github.com/orgs/{{org}}/actions/secrets?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List organization variables
|
||||
## List organization variables
|
||||
GET https://api.github.com/orgs/{{org}}/actions/variables
|
||||
GET https://api.github.com/orgs/{{org}}/actions/variables?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repository organization secrets
|
||||
## List repository organization secrets
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/organization-secrets
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/organization-secrets?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repository organization variables
|
||||
## List repository organization variables
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/organization-variables
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/organization-variables?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repository secrets
|
||||
## List repository secrets
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/secrets
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/secrets?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repository variables
|
||||
## List repository variables
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/variables
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/variables?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repository workflows
|
||||
## List repository workflows
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/workflows
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/workflows?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List runner applications for an organization
|
||||
@ -513,42 +513,42 @@ 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
|
||||
GET https://api.github.com/orgs/{{org}}/actions/secrets/{{secret_name}}/repositories?page={{page}}&perPage={{perPage}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/actions/variables/{{name}}/repositories?page={{page}}&perPage={{perPage}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/actions/permissions/repositories?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/actions/runners?name={{name}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runners?name={{name}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List workflow run artifacts
|
||||
## List workflow run artifacts
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/artifacts
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/artifacts?perPage={{perPage}}&page={{page}}&name={{name}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/workflows/{{workflow_id}}/runs?actor={{actor}}&branch={{branch}}&event={{event}}&status={{status}}&perPage={{perPage}}&page={{page}}&created={{created}}&excludePullRequests={{excludePullRequests}}&checkSuiteId={{checkSuiteId}}&headSha={{headSha}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs?actor={{actor}}&branch={{branch}}&event={{event}}&status={{status}}&perPage={{perPage}}&page={{page}}&created={{created}}&excludePullRequests={{excludePullRequests}}&checkSuiteId={{checkSuiteId}}&headSha={{headSha}}
|
||||
Accept: application/json
|
||||
|
||||
|
||||
|
@ -36,88 +36,88 @@ Accept: application/json
|
||||
|
||||
### List events for the authenticated user
|
||||
## List events for the authenticated user
|
||||
GET https://api.github.com/users/{{username}}/events
|
||||
GET https://api.github.com/users/{{username}}/events?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List notifications for the authenticated user
|
||||
## List notifications for the authenticated user
|
||||
GET https://api.github.com/notifications
|
||||
GET https://api.github.com/notifications?all={{all}}&participating={{participating}}&since={{since}}&before={{before}}&page={{page}}&perPage={{perPage}}
|
||||
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}}
|
||||
GET https://api.github.com/users/{{username}}/events/orgs/{{org}}?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List public events
|
||||
## List public events
|
||||
GET https://api.github.com/events
|
||||
GET https://api.github.com/events?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/networks/{{owner}}/{{repo}}/events?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List public events for a user
|
||||
## List public events for a user
|
||||
GET https://api.github.com/users/{{username}}/events/public
|
||||
GET https://api.github.com/users/{{username}}/events/public?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List public organization events
|
||||
## List public organization events
|
||||
GET https://api.github.com/orgs/{{org}}/events
|
||||
GET https://api.github.com/orgs/{{org}}/events?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/users/{{username}}/received_events?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/users/{{username}}/received_events/public?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repository events
|
||||
## List repository events
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/events
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/events?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/notifications?all={{all}}&participating={{participating}}&since={{since}}&before={{before}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repositories starred by the authenticated user
|
||||
## List repositories starred by the authenticated user
|
||||
GET https://api.github.com/user/starred
|
||||
GET https://api.github.com/user/starred?sort={{sort}}&direction={{direction}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/users/{{username}}/starred?sort={{sort}}&direction={{direction}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repositories watched by a user
|
||||
## List repositories watched by a user
|
||||
GET https://api.github.com/users/{{username}}/subscriptions
|
||||
GET https://api.github.com/users/{{username}}/subscriptions?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List stargazers
|
||||
## List stargazers
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/stargazers
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/stargazers?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repositories watched by the authenticated user
|
||||
## List repositories watched by the authenticated user
|
||||
GET https://api.github.com/user/subscriptions
|
||||
GET https://api.github.com/user/subscriptions?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List watchers
|
||||
## List watchers
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/subscribers
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/subscribers?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Mark notifications as read
|
||||
|
@ -116,62 +116,62 @@ 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
|
||||
GET https://api.github.com/marketplace_listing/plans/{{plan_id}}/accounts?sort={{sort}}&direction={{direction}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/marketplace_listing/stubbed/plans/{{plan_id}}/accounts?sort={{sort}}&direction={{direction}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/user/installations/{{installation_id}}/repositories?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/app/installation-requests?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List installations for the authenticated app
|
||||
## List installations for the authenticated app
|
||||
GET https://api.github.com/app/installations
|
||||
GET https://api.github.com/app/installations?perPage={{perPage}}&page={{page}}&since={{since}}&outdated={{outdated}}
|
||||
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
|
||||
GET https://api.github.com/user/installations?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List plans
|
||||
## List plans
|
||||
GET https://api.github.com/marketplace_listing/plans
|
||||
GET https://api.github.com/marketplace_listing/plans?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List plans (stubbed)
|
||||
## List plans (stubbed)
|
||||
GET https://api.github.com/marketplace_listing/stubbed/plans
|
||||
GET https://api.github.com/marketplace_listing/stubbed/plans?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repositories accessible to the app installation
|
||||
## List repositories accessible to the app installation
|
||||
GET https://api.github.com/installation/repositories
|
||||
GET https://api.github.com/installation/repositories?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List subscriptions for the authenticated user
|
||||
## List subscriptions for the authenticated user
|
||||
GET https://api.github.com/user/marketplace_purchases
|
||||
GET https://api.github.com/user/marketplace_purchases?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/user/marketplace_purchases/stubbed?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List deliveries for an app webhook
|
||||
## List deliveries for an app webhook
|
||||
GET https://api.github.com/app/hook/deliveries
|
||||
GET https://api.github.com/app/hook/deliveries?perPage={{perPage}}&cursor={{cursor}}&redelivery={{redelivery}}
|
||||
Accept: application/json
|
||||
Accept: application/scim+json
|
||||
|
||||
|
@ -43,22 +43,22 @@ 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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/check-runs/{{check_run_id}}/annotations?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{ref}}/check-runs?checkName={{checkName}}&status={{status}}&filter={{filter}}&perPage={{perPage}}&page={{page}}&appId={{appId}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/check-suites/{{check_suite_id}}/check-runs?checkName={{checkName}}&status={{status}}&filter={{filter}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{ref}}/check-suites?appId={{appId}}&checkName={{checkName}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Rerequest a check run
|
||||
|
@ -17,15 +17,15 @@ 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
|
||||
GET https://api.github.com/assignments/{{assignment_id}}/accepted_assignments?page={{page}}&perPage={{perPage}}
|
||||
Accept: application/json
|
||||
|
||||
### List assignments for a classroom
|
||||
## List assignments for a classroom
|
||||
GET https://api.github.com/classrooms/{{classroom_id}}/assignments
|
||||
GET https://api.github.com/classrooms/{{classroom_id}}/assignments?page={{page}}&perPage={{perPage}}
|
||||
Accept: application/json
|
||||
|
||||
### List classrooms
|
||||
## List classrooms
|
||||
GET https://api.github.com/classrooms
|
||||
GET https://api.github.com/classrooms?page={{page}}&perPage={{perPage}}
|
||||
Accept: application/json
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
### 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}}
|
||||
DELETE https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/analyses/{{analysis_id}}?confirmDelete={{confirmDelete}}
|
||||
Accept: application/json
|
||||
Accept: application/scim+json
|
||||
|
||||
@ -34,17 +34,17 @@ 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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/alerts/{{alert_number}}/instances?page={{page}}&perPage={{perPage}}&ref={{ref}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/code-scanning/alerts?toolName={{toolName}}&toolGuid={{toolGuid}}&before={{before}}&after={{after}}&page={{page}}&perPage={{perPage}}&direction={{direction}}&state={{state}}&sort={{sort}}&severity={{severity}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/alerts?toolName={{toolName}}&toolGuid={{toolGuid}}&page={{page}}&perPage={{perPage}}&ref={{ref}}&direction={{direction}}&sort={{sort}}&state={{state}}&severity={{severity}}
|
||||
Accept: application/json
|
||||
|
||||
### List CodeQL databases for a repository
|
||||
@ -54,7 +54,7 @@ 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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/analyses?toolName={{toolName}}&toolGuid={{toolGuid}}&page={{page}}&perPage={{perPage}}&ref={{ref}}&sarifId={{sarifId}}&direction={{direction}}&sort={{sort}}
|
||||
Accept: application/json
|
||||
|
||||
### Update a code scanning alert
|
||||
|
@ -12,7 +12,7 @@ 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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/permissions_check?ref={{ref}}&devcontainerPath={{devcontainerPath}}
|
||||
Accept: application/json
|
||||
|
||||
### List machine types for a codespace
|
||||
@ -138,7 +138,7 @@ 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
|
||||
GET https://api.github.com/orgs/{{org}}/members/{{username}}/codespaces?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Get details about a codespace export
|
||||
@ -183,33 +183,33 @@ 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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/devcontainers?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/user/codespaces?perPage={{perPage}}&page={{page}}&repositoryId={{repositoryId}}
|
||||
Accept: application/json
|
||||
|
||||
### List codespaces for the organization
|
||||
## List codespaces for the organization
|
||||
GET https://api.github.com/orgs/{{org}}/codespaces
|
||||
GET https://api.github.com/orgs/{{org}}/codespaces?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List organization secrets
|
||||
## List organization secrets
|
||||
GET https://api.github.com/orgs/{{org}}/codespaces/secrets
|
||||
GET https://api.github.com/orgs/{{org}}/codespaces/secrets?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repository secrets
|
||||
## List repository secrets
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/secrets
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/secrets?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List selected repositories for a user secret
|
||||
@ -219,17 +219,17 @@ Accept: application/json
|
||||
|
||||
### List secrets for the authenticated user
|
||||
## List secrets for the authenticated user
|
||||
GET https://api.github.com/user/codespaces/secrets
|
||||
GET https://api.github.com/user/codespaces/secrets?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/codespaces/secrets/{{secret_name}}/repositories?page={{page}}&perPage={{perPage}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/new?ref={{ref}}&clientIp={{clientIp}}
|
||||
Accept: application/json
|
||||
|
||||
### Create a repository from an unpublished codespace
|
||||
@ -256,7 +256,7 @@ 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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/machines?location={{location}}&clientIp={{clientIp}}&ref={{ref}}
|
||||
Accept: application/json
|
||||
|
||||
### Manage access control for organization codespaces
|
||||
|
@ -56,5 +56,5 @@ 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
|
||||
GET https://api.github.com/orgs/{{org}}/copilot/billing/seats?page={{page}}&perPage={{perPage}}
|
||||
Accept: application/json
|
||||
|
@ -65,34 +65,34 @@ Accept: application/json
|
||||
|
||||
### List Dependabot alerts for an enterprise
|
||||
## List Dependabot alerts for an enterprise
|
||||
GET https://api.github.com/enterprises/{{enterprise}}/dependabot/alerts
|
||||
GET https://api.github.com/enterprises/{{enterprise}}/dependabot/alerts?state={{state}}&severity={{severity}}&ecosystem={{ecosystem}}&package={{package}}&scope={{scope}}&sort={{sort}}&direction={{direction}}&before={{before}}&after={{after}}&first={{first}}&last={{last}}&perPage={{perPage}}
|
||||
Accept: application/json
|
||||
|
||||
### List Dependabot alerts for an organization
|
||||
## List Dependabot alerts for an organization
|
||||
GET https://api.github.com/orgs/{{org}}/dependabot/alerts
|
||||
GET https://api.github.com/orgs/{{org}}/dependabot/alerts?state={{state}}&severity={{severity}}&ecosystem={{ecosystem}}&package={{package}}&scope={{scope}}&sort={{sort}}&direction={{direction}}&before={{before}}&after={{after}}&first={{first}}&last={{last}}&perPage={{perPage}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/dependabot/alerts?state={{state}}&severity={{severity}}&ecosystem={{ecosystem}}&package={{package}}&manifest={{manifest}}&scope={{scope}}&sort={{sort}}&direction={{direction}}&page={{page}}&perPage={{perPage}}&before={{before}}&after={{after}}&first={{first}}&last={{last}}
|
||||
Accept: application/json
|
||||
Accept: application/scim+json
|
||||
|
||||
### List organization secrets
|
||||
## List organization secrets
|
||||
GET https://api.github.com/orgs/{{org}}/dependabot/secrets
|
||||
GET https://api.github.com/orgs/{{org}}/dependabot/secrets?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repository secrets
|
||||
## List repository secrets
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/dependabot/secrets
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/dependabot/secrets?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/dependabot/secrets/{{secret_name}}/repositories?page={{page}}&perPage={{perPage}}
|
||||
Accept: application/json
|
||||
|
||||
### Remove selected repository from an organization secret
|
||||
|
@ -46,7 +46,7 @@ Accept: application/json
|
||||
|
||||
### 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}}
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/dependency-graph/compare/{{basehead}}?name={{name}}
|
||||
Accept: application/json
|
||||
|
||||
### Export a software bill of materials (SBOM) for a repository.
|
||||
|
@ -65,37 +65,37 @@ Accept: application/json
|
||||
|
||||
### List gists for the authenticated user
|
||||
## List gists for the authenticated user
|
||||
GET https://api.github.com/gists
|
||||
GET https://api.github.com/gists?since={{since}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List gist comments
|
||||
## List gist comments
|
||||
GET https://api.github.com/gists/{{gist_id}}/comments
|
||||
GET https://api.github.com/gists/{{gist_id}}/comments?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List gist commits
|
||||
## List gist commits
|
||||
GET https://api.github.com/gists/{{gist_id}}/commits
|
||||
GET https://api.github.com/gists/{{gist_id}}/commits?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List gists for a user
|
||||
## List gists for a user
|
||||
GET https://api.github.com/users/{{username}}/gists
|
||||
GET https://api.github.com/users/{{username}}/gists?since={{since}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List gist forks
|
||||
## List gist forks
|
||||
GET https://api.github.com/gists/{{gist_id}}/forks
|
||||
GET https://api.github.com/gists/{{gist_id}}/forks?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List public gists
|
||||
## List public gists
|
||||
GET https://api.github.com/gists/public
|
||||
GET https://api.github.com/gists/public?since={{since}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List starred gists
|
||||
## List starred gists
|
||||
GET https://api.github.com/gists/starred
|
||||
GET https://api.github.com/gists/starred?since={{since}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Star a gist
|
||||
|
@ -106,7 +106,7 @@ Accept: application/json
|
||||
|
||||
### Get a tree
|
||||
## Get a tree
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/git/trees/{{tree_sha}}
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/git/trees/{{tree_sha}}?recursive={{recursive}}
|
||||
Accept: application/json
|
||||
|
||||
### List matching references
|
||||
|
@ -126,72 +126,72 @@ Accept: application/json
|
||||
|
||||
### List issues assigned to the authenticated user
|
||||
## List issues assigned to the authenticated user
|
||||
GET https://api.github.com/issues
|
||||
GET https://api.github.com/issues?filter={{filter}}&state={{state}}&labels={{labels}}&sort={{sort}}&direction={{direction}}&since={{since}}&collab={{collab}}&orgs={{orgs}}&owned={{owned}}&pulls={{pulls}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List assignees
|
||||
## List assignees
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/assignees
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/assignees?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List issue comments
|
||||
## List issue comments
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/comments
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/comments?since={{since}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/comments?sort={{sort}}&direction={{direction}}&since={{since}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List issue events
|
||||
## List issue events
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/events
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/events?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/events?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/timeline?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/user/issues?filter={{filter}}&state={{state}}&labels={{labels}}&sort={{sort}}&direction={{direction}}&since={{since}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/issues?filter={{filter}}&state={{state}}&labels={{labels}}&sort={{sort}}&direction={{direction}}&since={{since}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repository issues
|
||||
## List repository issues
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/issues
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/issues?milestone={{milestone}}&state={{state}}&assignee={{assignee}}&creator={{creator}}&mentioned={{mentioned}}&labels={{labels}}&sort={{sort}}&direction={{direction}}&since={{since}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/milestones/{{milestone_number}}/labels?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List labels for a repository
|
||||
## List labels for a repository
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/labels
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/labels?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/labels?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List milestones
|
||||
## List milestones
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/milestones
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/milestones?state={{state}}&sort={{sort}}&direction={{direction}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Lock an issue
|
||||
|
@ -7,10 +7,10 @@ Accept: application/json
|
||||
|
||||
### Get all commonly used licenses
|
||||
## Get all commonly used licenses
|
||||
GET https://api.github.com/licenses
|
||||
GET https://api.github.com/licenses?featured={{featured}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Get the license for a repository
|
||||
## Get the license for a repository
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/license
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/license?ref={{ref}}
|
||||
Accept: application/json
|
||||
|
@ -12,7 +12,7 @@ Accept: application/json
|
||||
|
||||
### Get Octocat
|
||||
## Get Octocat
|
||||
GET https://api.github.com/octocat
|
||||
GET https://api.github.com/octocat?s={{s}}
|
||||
Accept: application/octocat-stream
|
||||
|
||||
### Get the Zen of GitHub
|
||||
|
@ -27,7 +27,7 @@ Accept: application/json
|
||||
|
||||
### Get commit authors
|
||||
## Get commit authors
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/import/authors
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/import/authors?since={{since}}
|
||||
Accept: application/json
|
||||
|
||||
### Get an import status
|
||||
@ -42,32 +42,32 @@ Accept: application/json
|
||||
|
||||
### Get a user migration status
|
||||
## Get a user migration status
|
||||
GET https://api.github.com/user/migrations/{{migration_id}}
|
||||
GET https://api.github.com/user/migrations/{{migration_id}}?exclude={{exclude}}
|
||||
Accept: application/json
|
||||
|
||||
### Get an organization migration status
|
||||
## Get an organization migration status
|
||||
GET https://api.github.com/orgs/{{org}}/migrations/{{migration_id}}
|
||||
GET https://api.github.com/orgs/{{org}}/migrations/{{migration_id}}?exclude={{exclude}}
|
||||
Accept: application/json
|
||||
|
||||
### List user migrations
|
||||
## List user migrations
|
||||
GET https://api.github.com/user/migrations
|
||||
GET https://api.github.com/user/migrations?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List organization migrations
|
||||
## List organization migrations
|
||||
GET https://api.github.com/orgs/{{org}}/migrations
|
||||
GET https://api.github.com/orgs/{{org}}/migrations?perPage={{perPage}}&page={{page}}&exclude={{exclude}}
|
||||
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
|
||||
GET https://api.github.com/user/migrations/{{migration_id}}/repositories?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/migrations/{{migration_id}}/repositories?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Map a commit author
|
||||
|
@ -214,62 +214,62 @@ Accept: application/scim+json
|
||||
|
||||
### List organizations
|
||||
## List organizations
|
||||
GET https://api.github.com/organizations
|
||||
GET https://api.github.com/organizations?since={{since}}&perPage={{perPage}}
|
||||
Accept: application/json
|
||||
|
||||
### List app installations for an organization
|
||||
## List app installations for an organization
|
||||
GET https://api.github.com/orgs/{{org}}/installations
|
||||
GET https://api.github.com/orgs/{{org}}/installations?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List users blocked by an organization
|
||||
## List users blocked by an organization
|
||||
GET https://api.github.com/orgs/{{org}}/blocks
|
||||
GET https://api.github.com/orgs/{{org}}/blocks?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/properties/values?perPage={{perPage}}&page={{page}}&repositoryQuery={{repositoryQuery}}
|
||||
Accept: application/json
|
||||
|
||||
### List failed organization invitations
|
||||
## List failed organization invitations
|
||||
GET https://api.github.com/orgs/{{org}}/failed_invitations
|
||||
GET https://api.github.com/orgs/{{org}}/failed_invitations?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List organizations for the authenticated user
|
||||
## List organizations for the authenticated user
|
||||
GET https://api.github.com/user/orgs
|
||||
GET https://api.github.com/user/orgs?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List organizations for a user
|
||||
## List organizations for a user
|
||||
GET https://api.github.com/users/{{username}}/orgs
|
||||
GET https://api.github.com/users/{{username}}/orgs?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List organization invitation teams
|
||||
## List organization invitation teams
|
||||
GET https://api.github.com/orgs/{{org}}/invitations/{{invitation_id}}/teams
|
||||
GET https://api.github.com/orgs/{{org}}/invitations/{{invitation_id}}/teams?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List organization members
|
||||
## List organization members
|
||||
GET https://api.github.com/orgs/{{org}}/members
|
||||
GET https://api.github.com/orgs/{{org}}/members?filter={{filter}}&role={{role}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/user/memberships/orgs?state={{state}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/organization-roles/{{role_id}}/teams?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/organization-roles/{{role_id}}/users?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Get all organization roles for an organization
|
||||
@ -284,37 +284,37 @@ Accept: application/json
|
||||
|
||||
### List outside collaborators for an organization
|
||||
## List outside collaborators for an organization
|
||||
GET https://api.github.com/orgs/{{org}}/outside_collaborators
|
||||
GET https://api.github.com/orgs/{{org}}/outside_collaborators?filter={{filter}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/personal-access-tokens/{{pat_id}}/repositories?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/personal-access-token-requests/{{pat_request_id}}/repositories?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/personal-access-token-requests?perPage={{perPage}}&page={{page}}&sort={{sort}}&direction={{direction}}&owner={{owner}}&repository={{repository}}&permission={{permission}}&lastUsedBefore={{lastUsedBefore}}&lastUsedAfter={{lastUsedAfter}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/personal-access-tokens?perPage={{perPage}}&page={{page}}&sort={{sort}}&direction={{direction}}&owner={{owner}}&repository={{repository}}&permission={{permission}}&lastUsedBefore={{lastUsedBefore}}&lastUsedAfter={{lastUsedAfter}}
|
||||
Accept: application/json
|
||||
|
||||
### List pending organization invitations
|
||||
## List pending organization invitations
|
||||
GET https://api.github.com/orgs/{{org}}/invitations
|
||||
GET https://api.github.com/orgs/{{org}}/invitations?perPage={{perPage}}&page={{page}}&role={{role}}&invitationSource={{invitationSource}}
|
||||
Accept: application/json
|
||||
|
||||
### List public organization members
|
||||
## List public organization members
|
||||
GET https://api.github.com/orgs/{{org}}/public_members
|
||||
GET https://api.github.com/orgs/{{org}}/public_members?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List security manager teams
|
||||
@ -324,13 +324,13 @@ 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
|
||||
GET https://api.github.com/orgs/{{org}}/hooks/{{hook_id}}/deliveries?perPage={{perPage}}&cursor={{cursor}}&redelivery={{redelivery}}
|
||||
Accept: application/json
|
||||
Accept: application/scim+json
|
||||
|
||||
### List organization webhooks
|
||||
## List organization webhooks
|
||||
GET https://api.github.com/orgs/{{org}}/hooks
|
||||
GET https://api.github.com/orgs/{{org}}/hooks?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Update a custom organization role
|
||||
|
@ -32,12 +32,12 @@ 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
|
||||
GET https://api.github.com/user/packages/{{package_type}}/{{package_name}}/versions?page={{page}}&perPage={{perPage}}&state={{state}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/packages/{{package_type}}/{{package_name}}/versions?page={{page}}&perPage={{perPage}}&state={{state}}
|
||||
Accept: application/json
|
||||
|
||||
### List package versions for a package owned by a user
|
||||
@ -92,32 +92,32 @@ Accept: application/json
|
||||
|
||||
### List packages for the authenticated user's namespace
|
||||
## List packages for the authenticated user's namespace
|
||||
GET https://api.github.com/user/packages
|
||||
GET https://api.github.com/user/packages?packageType={{packageType}}&visibility={{visibility}}&page={{page}}&perPage={{perPage}}
|
||||
Accept: application/json
|
||||
|
||||
### List packages for an organization
|
||||
## List packages for an organization
|
||||
GET https://api.github.com/orgs/{{org}}/packages
|
||||
GET https://api.github.com/orgs/{{org}}/packages?packageType={{packageType}}&visibility={{visibility}}&page={{page}}&perPage={{perPage}}
|
||||
Accept: application/json
|
||||
|
||||
### List packages for a user
|
||||
## List packages for a user
|
||||
GET https://api.github.com/users/{{username}}/packages
|
||||
GET https://api.github.com/users/{{username}}/packages?packageType={{packageType}}&visibility={{visibility}}&page={{page}}&perPage={{perPage}}
|
||||
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
|
||||
POST https://api.github.com/user/packages/{{package_type}}/{{package_name}}/restore?token={{token}}
|
||||
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
|
||||
POST https://api.github.com/orgs/{{org}}/packages/{{package_type}}/{{package_name}}/restore?token={{token}}
|
||||
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
|
||||
POST https://api.github.com/users/{{username}}/packages/{{package_type}}/{{package_name}}/restore?token={{token}}
|
||||
Accept: application/json
|
||||
|
||||
### Restore a package version for the authenticated user
|
||||
|
@ -106,32 +106,32 @@ Accept: application/json
|
||||
|
||||
### List project cards
|
||||
## List project cards
|
||||
GET https://api.github.com/projects/columns/{{column_id}}/cards
|
||||
GET https://api.github.com/projects/columns/{{column_id}}/cards?archivedState={{archivedState}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List project collaborators
|
||||
## List project collaborators
|
||||
GET https://api.github.com/projects/{{project_id}}/collaborators
|
||||
GET https://api.github.com/projects/{{project_id}}/collaborators?affiliation={{affiliation}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List project columns
|
||||
## List project columns
|
||||
GET https://api.github.com/projects/{{project_id}}/columns
|
||||
GET https://api.github.com/projects/{{project_id}}/columns?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List organization projects
|
||||
## List organization projects
|
||||
GET https://api.github.com/orgs/{{org}}/projects
|
||||
GET https://api.github.com/orgs/{{org}}/projects?state={{state}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repository projects
|
||||
## List repository projects
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/projects
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/projects?state={{state}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List user projects
|
||||
## List user projects
|
||||
GET https://api.github.com/users/{{username}}/projects
|
||||
GET https://api.github.com/users/{{username}}/projects?state={{state}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Move a project card
|
||||
|
@ -103,22 +103,22 @@ Accept: application/json
|
||||
|
||||
### List pull requests
|
||||
## List pull requests
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls?state={{state}}&head={{head}}&base={{base}}&sort={{sort}}&direction={{direction}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/reviews/{{review_id}}/comments?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/commits?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List pull requests files
|
||||
## List pull requests files
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/files
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/files?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Get all requested reviewers for a pull request
|
||||
@ -128,17 +128,17 @@ 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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/comments?sort={{sort}}&direction={{direction}}&since={{since}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/comments?sort={{sort}}&direction={{direction}}&since={{since}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/reviews?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Merge a pull request
|
||||
|
@ -129,45 +129,45 @@ DELETE https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{dis
|
||||
|
||||
### List reactions for a commit comment
|
||||
## List reactions for a commit comment
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/comments/{{comment_id}}/reactions
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/comments/{{comment_id}}/reactions?content={{content}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/reactions?content={{content}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/comments/{{comment_id}}/reactions?content={{content}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/comments/{{comment_id}}/reactions?content={{content}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/releases/{{release_id}}/reactions?content={{content}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}/comments/{{comment_number}}/reactions?content={{content}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}/comments/{{comment_number}}/reactions?content={{content}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}/reactions?content={{content}}&perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}/reactions?content={{content}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
@ -80,12 +80,12 @@ GET https://api.github.com/repos/{{owner}}/{{repo}}/vulnerability-alerts
|
||||
|
||||
### List CODEOWNERS errors
|
||||
## List CODEOWNERS errors
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/codeowners/errors
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/codeowners/errors?ref={{ref}}
|
||||
Accept: application/json
|
||||
|
||||
### Compare two commits
|
||||
## Compare two commits
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/compare/{{basehead}}
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/compare/{{basehead}}?page={{page}}&perPage={{perPage}}
|
||||
Accept: application/json
|
||||
|
||||
### Create an autolink reference for a repository
|
||||
@ -665,7 +665,7 @@ Accept: application/json
|
||||
|
||||
### List environments
|
||||
## List environments
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/environments
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/environments?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Get all status check contexts
|
||||
@ -675,7 +675,7 @@ Accept: application/json
|
||||
|
||||
### Get all repository topics
|
||||
## Get all repository topics
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/topics
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/topics?page={{page}}&perPage={{perPage}}
|
||||
Accept: application/json
|
||||
|
||||
### Get apps with access to the protected branch
|
||||
@ -700,12 +700,12 @@ Accept: application/json
|
||||
|
||||
### Get rules for a branch
|
||||
## Get rules for a branch
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/rules/branches/{{branch}}
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/rules/branches/{{branch}}?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Get repository clones
|
||||
## Get repository clones
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/traffic/clones
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/traffic/clones?per={{per}}
|
||||
Accept: application/json
|
||||
|
||||
### Get the weekly commit activity
|
||||
@ -720,12 +720,12 @@ Accept: application/json
|
||||
|
||||
### Get the combined status for a specific reference
|
||||
## Get the combined status for a specific reference
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{ref}}/status
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{ref}}/status?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Get a commit
|
||||
## Get a commit
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{ref}}
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{ref}}?page={{page}}&perPage={{perPage}}
|
||||
Accept: application/json
|
||||
|
||||
### Get the last year of commit activity
|
||||
@ -750,7 +750,7 @@ Accept: application/json
|
||||
|
||||
### Get repository content
|
||||
## Get repository content
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/contents/{{path}}
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/contents/{{path}}?ref={{ref}}
|
||||
Accept: application/vnd.github.object
|
||||
Accept: application/json
|
||||
|
||||
@ -811,7 +811,7 @@ Accept: application/json
|
||||
|
||||
### List organization rule suites
|
||||
## List organization rule suites
|
||||
GET https://api.github.com/orgs/{{org}}/rulesets/rule-suites
|
||||
GET https://api.github.com/orgs/{{org}}/rulesets/rule-suites?repositoryName={{repositoryName}}&timePeriod={{timePeriod}}&actorName={{actorName}}&ruleSuiteResult={{ruleSuiteResult}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Get an organization repository ruleset
|
||||
@ -821,7 +821,7 @@ Accept: application/json
|
||||
|
||||
### Get all organization repository rulesets
|
||||
## Get all organization repository rulesets
|
||||
GET https://api.github.com/orgs/{{org}}/rulesets
|
||||
GET https://api.github.com/orgs/{{org}}/rulesets?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Get a GitHub Pages site
|
||||
@ -861,12 +861,12 @@ Accept: application/json
|
||||
|
||||
### Get a repository README
|
||||
## Get a repository README
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/readme
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/readme?ref={{ref}}
|
||||
Accept: application/json
|
||||
|
||||
### Get a repository README for a directory
|
||||
## Get a repository README for a directory
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/readme/{{dir}}
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/readme/{{dir}}?ref={{ref}}
|
||||
Accept: application/json
|
||||
|
||||
### Get a release
|
||||
@ -891,17 +891,17 @@ Accept: application/json
|
||||
|
||||
### List repository rule suites
|
||||
## List repository rule suites
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/rulesets/rule-suites
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/rulesets/rule-suites?ref={{ref}}&timePeriod={{timePeriod}}&actorName={{actorName}}&ruleSuiteResult={{ruleSuiteResult}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Get a repository ruleset
|
||||
## Get a repository ruleset
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/rulesets/{{ruleset_id}}
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/rulesets/{{ruleset_id}}?includesParents={{includesParents}}
|
||||
Accept: application/json
|
||||
|
||||
### Get all repository rulesets
|
||||
## Get all repository rulesets
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/rulesets
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/rulesets?perPage={{perPage}}&page={{page}}&includesParents={{includesParents}}
|
||||
Accept: application/json
|
||||
|
||||
### Get status checks protection
|
||||
@ -931,7 +931,7 @@ Accept: application/json
|
||||
|
||||
### Get page views
|
||||
## Get page views
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/traffic/views
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/traffic/views?per={{per}}
|
||||
Accept: application/json
|
||||
|
||||
### Get a repository webhook
|
||||
@ -952,7 +952,7 @@ Accept: application/scim+json
|
||||
|
||||
### List repository activities
|
||||
## List repository activities
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/activity
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/activity?direction={{direction}}&perPage={{perPage}}&before={{before}}&after={{after}}&ref={{ref}}&actor={{actor}}&timePeriod={{timePeriod}}&activityType={{activityType}}
|
||||
Accept: application/json
|
||||
|
||||
### Get all autolinks of a repository
|
||||
@ -962,7 +962,7 @@ Accept: application/json
|
||||
|
||||
### List branches
|
||||
## List branches
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/branches
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/branches?protected={{protected}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List branches for HEAD commit
|
||||
@ -972,89 +972,89 @@ Accept: application/json
|
||||
|
||||
### List repository collaborators
|
||||
## List repository collaborators
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/collaborators
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/collaborators?affiliation={{affiliation}}&permission={{permission}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List commit comments
|
||||
## List commit comments
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{commit_sha}}/comments
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{commit_sha}}/comments?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List commit comments for a repository
|
||||
## List commit comments for a repository
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/comments
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/comments?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List commit statuses for a reference
|
||||
## List commit statuses for a reference
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{ref}}/statuses
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{ref}}/statuses?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List commits
|
||||
## List commits
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/commits
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/commits?sha={{sha}}&path={{path}}&author={{author}}&committer={{committer}}&since={{since}}&until={{until}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
Accept: application/scim+json
|
||||
|
||||
### List repository contributors
|
||||
## List repository contributors
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/contributors
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/contributors?anon={{anon}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List custom deployment rule integrations available for an environment
|
||||
## List custom deployment rule integrations available for an environment
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}/deployment_protection_rules/apps
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}/deployment_protection_rules/apps?page={{page}}&perPage={{perPage}}
|
||||
Accept: application/json
|
||||
|
||||
### List deploy keys
|
||||
## List deploy keys
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/keys
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/keys?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List deployment branch policies
|
||||
## List deployment branch policies
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}/deployment-branch-policies
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}/deployment-branch-policies?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List deployment statuses
|
||||
## List deployment statuses
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/deployments/{{deployment_id}}/statuses
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/deployments/{{deployment_id}}/statuses?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List deployments
|
||||
## List deployments
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/deployments
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/deployments?sha={{sha}}&ref={{ref}}&task={{task}}&environment={{environment}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repositories for the authenticated user
|
||||
## List repositories for the authenticated user
|
||||
GET https://api.github.com/user/repos
|
||||
GET https://api.github.com/user/repos?visibility={{visibility}}&affiliation={{affiliation}}&type={{type}}&sort={{sort}}&direction={{direction}}&perPage={{perPage}}&page={{page}}&since={{since}}&before={{before}}
|
||||
Accept: application/json
|
||||
|
||||
### List organization repositories
|
||||
## List organization repositories
|
||||
GET https://api.github.com/orgs/{{org}}/repos
|
||||
GET https://api.github.com/orgs/{{org}}/repos?type={{type}}&sort={{sort}}&direction={{direction}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repositories for a user
|
||||
## List repositories for a user
|
||||
GET https://api.github.com/users/{{username}}/repos
|
||||
GET https://api.github.com/users/{{username}}/repos?type={{type}}&sort={{sort}}&direction={{direction}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List forks
|
||||
## List forks
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/forks
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/forks?sort={{sort}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
Accept: application/scim+json
|
||||
|
||||
### List repository invitations
|
||||
## List repository invitations
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/invitations
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/invitations?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repository invitations for the authenticated user
|
||||
## List repository invitations for the authenticated user
|
||||
GET https://api.github.com/user/repository_invitations
|
||||
GET https://api.github.com/user/repository_invitations?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repository languages
|
||||
@ -1064,27 +1064,27 @@ Accept: application/json
|
||||
|
||||
### List GitHub Pages builds
|
||||
## List GitHub Pages builds
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/pages/builds
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/pages/builds?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List public repositories
|
||||
## List public repositories
|
||||
GET https://api.github.com/repositories
|
||||
GET https://api.github.com/repositories?since={{since}}
|
||||
Accept: application/json
|
||||
|
||||
### List pull requests associated with a commit
|
||||
## List pull requests associated with a commit
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{commit_sha}}/pulls
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{commit_sha}}/pulls?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List release assets
|
||||
## List release assets
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/releases/{{release_id}}/assets
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/releases/{{release_id}}/assets?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List releases
|
||||
## List releases
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/releases
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/releases?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List tag protection states for a repository
|
||||
@ -1094,23 +1094,23 @@ Accept: application/json
|
||||
|
||||
### List repository tags
|
||||
## List repository tags
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/tags
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/tags?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List repository teams
|
||||
## List repository teams
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/teams
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/teams?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List deliveries for a repository webhook
|
||||
## List deliveries for a repository webhook
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/hooks/{{hook_id}}/deliveries
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/hooks/{{hook_id}}/deliveries?perPage={{perPage}}&cursor={{cursor}}&redelivery={{redelivery}}
|
||||
Accept: application/json
|
||||
Accept: application/scim+json
|
||||
|
||||
### List repository webhooks
|
||||
## List repository webhooks
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/hooks
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/hooks?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Merge a branch
|
||||
@ -1559,7 +1559,7 @@ Accept: application/json
|
||||
|
||||
### Upload a release asset
|
||||
## Upload a release asset
|
||||
POST https://api.github.com/repos/{{owner}}/{{repo}}/releases/{{release_id}}/assets
|
||||
POST https://api.github.com/repos/{{owner}}/{{repo}}/releases/{{release_id}}/assets?name={{name}}&label={{label}}
|
||||
Content-Type: application/octet-stream
|
||||
Accept: application/json
|
||||
|
||||
|
@ -2,35 +2,35 @@
|
||||
|
||||
### Search code
|
||||
## Search code
|
||||
GET https://api.github.com/search/code
|
||||
GET https://api.github.com/search/code?q={{q}}&sort={{sort}}&order={{order}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Search commits
|
||||
## Search commits
|
||||
GET https://api.github.com/search/commits
|
||||
GET https://api.github.com/search/commits?q={{q}}&sort={{sort}}&order={{order}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Search issues and pull requests
|
||||
## Search issues and pull requests
|
||||
GET https://api.github.com/search/issues
|
||||
GET https://api.github.com/search/issues?q={{q}}&sort={{sort}}&order={{order}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Search labels
|
||||
## Search labels
|
||||
GET https://api.github.com/search/labels
|
||||
GET https://api.github.com/search/labels?repositoryId={{repositoryId}}&q={{q}}&sort={{sort}}&order={{order}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Search repositories
|
||||
## Search repositories
|
||||
GET https://api.github.com/search/repositories
|
||||
GET https://api.github.com/search/repositories?q={{q}}&sort={{sort}}&order={{order}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Search topics
|
||||
## Search topics
|
||||
GET https://api.github.com/search/topics
|
||||
GET https://api.github.com/search/topics?q={{q}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Search users
|
||||
## Search users
|
||||
GET https://api.github.com/search/users
|
||||
GET https://api.github.com/search/users?q={{q}}&sort={{sort}}&order={{order}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
@ -7,22 +7,22 @@ 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
|
||||
GET https://api.github.com/enterprises/{{enterprise}}/secret-scanning/alerts?state={{state}}&secretType={{secretType}}&resolution={{resolution}}&sort={{sort}}&direction={{direction}}&perPage={{perPage}}&before={{before}}&after={{after}}&validity={{validity}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/secret-scanning/alerts?state={{state}}&secretType={{secretType}}&resolution={{resolution}}&sort={{sort}}&direction={{direction}}&page={{page}}&perPage={{perPage}}&before={{before}}&after={{after}}&validity={{validity}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/secret-scanning/alerts?state={{state}}&secretType={{secretType}}&resolution={{resolution}}&sort={{sort}}&direction={{direction}}&page={{page}}&perPage={{perPage}}&before={{before}}&after={{after}}&validity={{validity}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/secret-scanning/alerts/{{alert_number}}/locations?page={{page}}&perPage={{perPage}}
|
||||
Accept: application/json
|
||||
|
||||
### Update a secret scanning alert
|
||||
|
@ -78,18 +78,18 @@ Accept: application/json
|
||||
|
||||
### List global security advisories
|
||||
## List global security advisories
|
||||
GET https://api.github.com/advisories
|
||||
GET https://api.github.com/advisories?ghsaId={{ghsaId}}&type={{type}}&cveId={{cveId}}&ecosystem={{ecosystem}}&severity={{severity}}&cwes={{cwes}}&isWithdrawn={{isWithdrawn}}&affects={{affects}}&published={{published}}&updated={{updated}}&modified={{modified}}&before={{before}}&after={{after}}&direction={{direction}}&perPage={{perPage}}&sort={{sort}}
|
||||
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
|
||||
GET https://api.github.com/orgs/{{org}}/security-advisories?direction={{direction}}&sort={{sort}}&before={{before}}&after={{after}}&perPage={{perPage}}&state={{state}}
|
||||
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
|
||||
GET https://api.github.com/repos/{{owner}}/{{repo}}/security-advisories?direction={{direction}}&sort={{sort}}&before={{before}}&after={{after}}&perPage={{perPage}}&state={{state}}
|
||||
Accept: application/json
|
||||
Accept: application/scim+json
|
||||
|
||||
|
@ -222,82 +222,82 @@ Accept: application/json
|
||||
|
||||
### List teams
|
||||
## List teams
|
||||
GET https://api.github.com/orgs/{{org}}/teams
|
||||
GET https://api.github.com/orgs/{{org}}/teams?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List child teams
|
||||
## List child teams
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/teams
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/teams?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List child teams (Legacy)
|
||||
## List child teams (Legacy)
|
||||
GET https://api.github.com/teams/{{team_id}}/teams
|
||||
GET https://api.github.com/teams/{{team_id}}/teams?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List discussion comments
|
||||
## List discussion comments
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}/comments
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}/comments?direction={{direction}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List discussion comments (Legacy)
|
||||
## List discussion comments (Legacy)
|
||||
GET https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}/comments
|
||||
GET https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}/comments?direction={{direction}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List discussions
|
||||
## List discussions
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions?direction={{direction}}&perPage={{perPage}}&page={{page}}&pinned={{pinned}}
|
||||
Accept: application/json
|
||||
|
||||
### List discussions (Legacy)
|
||||
## List discussions (Legacy)
|
||||
GET https://api.github.com/teams/{{team_id}}/discussions
|
||||
GET https://api.github.com/teams/{{team_id}}/discussions?direction={{direction}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List teams for the authenticated user
|
||||
## List teams for the authenticated user
|
||||
GET https://api.github.com/user/teams
|
||||
GET https://api.github.com/user/teams?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List team members
|
||||
## List team members
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/members
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/members?role={{role}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List team members (Legacy)
|
||||
## List team members (Legacy)
|
||||
GET https://api.github.com/teams/{{team_id}}/members
|
||||
GET https://api.github.com/teams/{{team_id}}/members?role={{role}}&perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List pending team invitations
|
||||
## List pending team invitations
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/invitations
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/invitations?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List pending team invitations (Legacy)
|
||||
## List pending team invitations (Legacy)
|
||||
GET https://api.github.com/teams/{{team_id}}/invitations
|
||||
GET https://api.github.com/teams/{{team_id}}/invitations?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List team projects
|
||||
## List team projects
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/projects
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/projects?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List team projects (Legacy)
|
||||
## List team projects (Legacy)
|
||||
GET https://api.github.com/teams/{{team_id}}/projects
|
||||
GET https://api.github.com/teams/{{team_id}}/projects?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List team repositories
|
||||
## List team repositories
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/repos
|
||||
GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/repos?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List team repositories (Legacy)
|
||||
## List team repositories (Legacy)
|
||||
GET https://api.github.com/teams/{{team_id}}/repos
|
||||
GET https://api.github.com/teams/{{team_id}}/repos?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Remove team member (Legacy)
|
||||
|
@ -131,7 +131,7 @@ Accept: application/json
|
||||
|
||||
### Get contextual information for a user
|
||||
## Get contextual information for a user
|
||||
GET https://api.github.com/users/{{username}}/hovercard
|
||||
GET https://api.github.com/users/{{username}}/hovercard?subjectType={{subjectType}}&subjectId={{subjectId}}
|
||||
Accept: application/json
|
||||
|
||||
### Get a GPG key for the authenticated user
|
||||
@ -151,82 +151,82 @@ Accept: application/json
|
||||
|
||||
### List users
|
||||
## List users
|
||||
GET https://api.github.com/users
|
||||
GET https://api.github.com/users?since={{since}}&perPage={{perPage}}
|
||||
Accept: application/json
|
||||
|
||||
### List users blocked by the authenticated user
|
||||
## List users blocked by the authenticated user
|
||||
GET https://api.github.com/user/blocks
|
||||
GET https://api.github.com/user/blocks?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List email addresses for the authenticated user
|
||||
## List email addresses for the authenticated user
|
||||
GET https://api.github.com/user/emails
|
||||
GET https://api.github.com/user/emails?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List the people the authenticated user follows
|
||||
## List the people the authenticated user follows
|
||||
GET https://api.github.com/user/following
|
||||
GET https://api.github.com/user/following?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List followers of the authenticated user
|
||||
## List followers of the authenticated user
|
||||
GET https://api.github.com/user/followers
|
||||
GET https://api.github.com/user/followers?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List followers of a user
|
||||
## List followers of a user
|
||||
GET https://api.github.com/users/{{username}}/followers
|
||||
GET https://api.github.com/users/{{username}}/followers?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List the people a user follows
|
||||
## List the people a user follows
|
||||
GET https://api.github.com/users/{{username}}/following
|
||||
GET https://api.github.com/users/{{username}}/following?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/user/gpg_keys?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List GPG keys for a user
|
||||
## List GPG keys for a user
|
||||
GET https://api.github.com/users/{{username}}/gpg_keys
|
||||
GET https://api.github.com/users/{{username}}/gpg_keys?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/user/public_emails?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List public keys for a user
|
||||
## List public keys for a user
|
||||
GET https://api.github.com/users/{{username}}/keys
|
||||
GET https://api.github.com/users/{{username}}/keys?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/user/keys?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/user/social_accounts?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### List social accounts for a user
|
||||
## List social accounts for a user
|
||||
GET https://api.github.com/users/{{username}}/social_accounts
|
||||
GET https://api.github.com/users/{{username}}/social_accounts?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/user/ssh_signing_keys?perPage={{perPage}}&page={{page}}
|
||||
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
|
||||
GET https://api.github.com/users/{{username}}/ssh_signing_keys?perPage={{perPage}}&page={{page}}
|
||||
Accept: application/json
|
||||
|
||||
### Set primary email visibility for the authenticated user
|
||||
|
@ -0,0 +1,198 @@
|
||||
{
|
||||
"dev": {
|
||||
"review_id" : "",
|
||||
"discussion_number" : "",
|
||||
"actorName" : "",
|
||||
"team_id" : "",
|
||||
"artifact_id" : "",
|
||||
"checkName" : "",
|
||||
"invitationSource" : "",
|
||||
"cwes" : "",
|
||||
"branch" : "",
|
||||
"resolution" : "",
|
||||
"subjectId" : "",
|
||||
"path" : "",
|
||||
"secret_name" : "",
|
||||
"status_id" : "",
|
||||
"protected" : "",
|
||||
"state" : "",
|
||||
"repositoryQuery" : "",
|
||||
"tree_sha" : "",
|
||||
"labels" : "",
|
||||
"perPage" : "",
|
||||
"build_id" : "",
|
||||
"lastUsedBefore" : "",
|
||||
"assignee" : "",
|
||||
"orgs" : "",
|
||||
"runner_id" : "",
|
||||
"role" : "",
|
||||
"gist_id" : "",
|
||||
"custom_property_name" : "",
|
||||
"devcontainerPath" : "",
|
||||
"ruleSuiteResult" : "",
|
||||
"milestone_number" : "",
|
||||
"reaction_id" : "",
|
||||
"after" : "",
|
||||
"key" : "",
|
||||
"run_id" : "",
|
||||
"actor" : "",
|
||||
"q" : "",
|
||||
"account_id" : "",
|
||||
"event_id" : "",
|
||||
"s" : "",
|
||||
"isWithdrawn" : "",
|
||||
"clientIp" : "",
|
||||
"target_user" : "",
|
||||
"validity" : "",
|
||||
"featured" : "",
|
||||
"language" : "",
|
||||
"dir" : "",
|
||||
"packageType" : "",
|
||||
"subjectType" : "",
|
||||
"client_id" : "",
|
||||
"ref" : "",
|
||||
"outdated" : "",
|
||||
"committer" : "",
|
||||
"codespace_name" : "",
|
||||
"project_id" : "",
|
||||
"affiliation" : "",
|
||||
"appId" : "",
|
||||
"exclude" : "",
|
||||
"autolink_id" : "",
|
||||
"pat_id" : "",
|
||||
"last" : "",
|
||||
"visibility" : "",
|
||||
"key_id" : "",
|
||||
"cveId" : "",
|
||||
"export_id" : "",
|
||||
"sha" : "",
|
||||
"pulls" : "",
|
||||
"column_id" : "",
|
||||
"name" : "",
|
||||
"page" : "",
|
||||
"updated" : "",
|
||||
"cursor" : "",
|
||||
"pinned" : "",
|
||||
"delivery_id" : "",
|
||||
"team_slug" : "",
|
||||
"content" : "",
|
||||
"cache_id" : "",
|
||||
"attempt_number" : "",
|
||||
"scope" : "",
|
||||
"repo_name" : "",
|
||||
"environment_name" : "",
|
||||
"owner" : "",
|
||||
"severity" : "",
|
||||
"anon" : "",
|
||||
"comment_number" : "",
|
||||
"org" : "",
|
||||
"archivedState" : "",
|
||||
"affects" : "",
|
||||
"permission" : "",
|
||||
"label" : "",
|
||||
"confirmDelete" : "",
|
||||
"ghsa_id" : "",
|
||||
"environment" : "",
|
||||
"owned" : "",
|
||||
"hook_id" : "",
|
||||
"package_name" : "",
|
||||
"location" : "",
|
||||
"username" : "",
|
||||
"base" : "",
|
||||
"ecosystem" : "",
|
||||
"installation_id" : "",
|
||||
"asset_id" : "",
|
||||
"repository" : "",
|
||||
"type" : "",
|
||||
"commit_sha" : "",
|
||||
"issue_number" : "",
|
||||
"toolGuid" : "",
|
||||
"participating" : "",
|
||||
"per" : "",
|
||||
"ssh_signing_key_id" : "",
|
||||
"toolName" : "",
|
||||
"order" : "",
|
||||
"rule_suite_id" : "",
|
||||
"collab" : "",
|
||||
"tag_sha" : "",
|
||||
"pages_deployment_id" : "",
|
||||
"status" : "",
|
||||
"invitation_id" : "",
|
||||
"file_sha" : "",
|
||||
"enterprise" : "",
|
||||
"repo" : "",
|
||||
"recursive" : "",
|
||||
"template_repo" : "",
|
||||
"gpg_key_id" : "",
|
||||
"archive_format" : "",
|
||||
"event" : "",
|
||||
"basehead" : "",
|
||||
"protection_rule_id" : "",
|
||||
"creator" : "",
|
||||
"comment_id" : "",
|
||||
"repositoryName" : "",
|
||||
"analysis_id" : "",
|
||||
"token" : "",
|
||||
"filter" : "",
|
||||
"secretType" : "",
|
||||
"package_version_id" : "",
|
||||
"checkSuiteId" : "",
|
||||
"plan_id" : "",
|
||||
"first" : "",
|
||||
"workflow_id" : "",
|
||||
"enablement" : "",
|
||||
"alert_number" : "",
|
||||
"before" : "",
|
||||
"package_type" : "",
|
||||
"includesParents" : "",
|
||||
"lastUsedAfter" : "",
|
||||
"thread_id" : "",
|
||||
"app_slug" : "",
|
||||
"security_product" : "",
|
||||
"role_id" : "",
|
||||
"sarifId" : "",
|
||||
"modified" : "",
|
||||
"repository_id" : "",
|
||||
"tag" : "",
|
||||
"excludePullRequests" : "",
|
||||
"all" : "",
|
||||
"check_run_id" : "",
|
||||
"branch_policy_id" : "",
|
||||
"classroom_id" : "",
|
||||
"package" : "",
|
||||
"check_suite_id" : "",
|
||||
"created" : "",
|
||||
"pat_request_id" : "",
|
||||
"author" : "",
|
||||
"sort" : "",
|
||||
"published" : "",
|
||||
"card_id" : "",
|
||||
"license" : "",
|
||||
"task" : "",
|
||||
"migration_id" : "",
|
||||
"template_owner" : "",
|
||||
"timePeriod" : "",
|
||||
"author_id" : "",
|
||||
"since" : "",
|
||||
"release_id" : "",
|
||||
"code" : "",
|
||||
"pull_number" : "",
|
||||
"ruleset_id" : "",
|
||||
"tag_protection_id" : "",
|
||||
"headSha" : "",
|
||||
"head" : "",
|
||||
"ghsaId" : "",
|
||||
"deployment_id" : "",
|
||||
"mentioned" : "",
|
||||
"direction" : "",
|
||||
"manifest" : "",
|
||||
"redelivery" : "",
|
||||
"assignment_id" : "",
|
||||
"milestone" : "",
|
||||
"job_id" : "",
|
||||
"repositoryId" : "",
|
||||
"sarif_id" : "",
|
||||
"until" : "",
|
||||
"activityType" : ""
|
||||
}
|
||||
}
|
@ -6,4 +6,5 @@ Apis/PaymentLinksApi.http
|
||||
Apis/PaymentsApi.http
|
||||
Apis/RecurringApi.http
|
||||
Apis/UtilityApi.http
|
||||
Apis/http-client.template.env.json
|
||||
README.md
|
||||
|
@ -5,6 +5,7 @@
|
||||
POST https://checkout-test.adyen.com/v71/paymentSession
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -29,6 +30,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/paymentSession
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -55,6 +57,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/paymentSession
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -79,6 +82,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/paymentSession
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -117,6 +121,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/paymentSession
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -142,6 +147,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments/result
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
|
@ -5,6 +5,7 @@
|
||||
POST https://checkout-test.adyen.com/v71/donations
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -30,6 +31,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/donations
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
|
@ -5,6 +5,7 @@
|
||||
POST https://checkout-test.adyen.com/v71/cancels
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -20,6 +21,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments/{{paymentPspReference}}/amountUpdates
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -38,6 +40,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments/{{paymentPspReference}}/cancels
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -52,6 +55,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments/{{paymentPspReference}}/captures
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -75,6 +79,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments/{{paymentPspReference}}/refunds
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -93,6 +98,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments/{{paymentPspReference}}/reversals
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
|
@ -5,6 +5,7 @@
|
||||
POST https://checkout-test.adyen.com/v71/orders
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -23,6 +24,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/orders/cancel
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -40,6 +42,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/paymentMethods/balance
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -61,6 +64,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/paymentMethods/balance
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
|
@ -25,6 +25,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/paymentLinks
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
### Get the result of a payment session
|
||||
## Get the result of a payment session
|
||||
GET https://checkout-test.adyen.com/v71/sessions/{{sessionId}}
|
||||
GET https://checkout-test.adyen.com/v71/sessions/{{sessionId}}?sessionResult={{sessionResult}}
|
||||
Accept: application/json
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
@ -12,6 +12,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/cardDetails
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -25,6 +26,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/cardDetails
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -40,6 +42,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/paymentMethods
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -52,6 +55,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/paymentMethods
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -70,6 +74,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/paymentMethods
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -89,6 +94,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -111,6 +117,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -164,6 +171,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -200,6 +208,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -226,6 +235,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -251,6 +261,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -280,6 +291,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -302,6 +314,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -324,6 +337,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -369,6 +383,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -395,6 +410,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -420,6 +436,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -451,6 +468,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -477,6 +495,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -507,6 +526,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments/details
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -521,6 +541,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/payments/details
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -536,6 +557,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/sessions
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -555,6 +577,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/sessions
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -599,6 +622,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/sessions
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -622,6 +646,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/sessions
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
|
@ -2,13 +2,13 @@
|
||||
|
||||
### Delete a token for stored payment details
|
||||
## Delete a token for stored payment details
|
||||
DELETE https://checkout-test.adyen.com/v71/storedPaymentMethods/{{storedPaymentMethodId}}
|
||||
DELETE https://checkout-test.adyen.com/v71/storedPaymentMethods/{{storedPaymentMethodId}}?shopperReference={{shopperReference}}&merchantAccount={{merchantAccount}}
|
||||
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
|
||||
GET https://checkout-test.adyen.com/v71/storedPaymentMethods?shopperReference={{shopperReference}}&merchantAccount={{merchantAccount}}
|
||||
Accept: application/json
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
@ -5,6 +5,7 @@
|
||||
POST https://checkout-test.adyen.com/v71/applePay/sessions
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
@ -20,6 +21,7 @@ X-API-Key: {{apiKey}}
|
||||
POST https://checkout-test.adyen.com/v71/originKeys
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
Idempotency-Key: {{idempotencyKey}}
|
||||
Authorization: Basic: {{username-password}}
|
||||
X-API-Key: {{apiKey}}
|
||||
|
||||
|
@ -0,0 +1,12 @@
|
||||
{
|
||||
"dev": {
|
||||
"linkId" : "",
|
||||
"sessionResult" : "",
|
||||
"merchantAccount" : "",
|
||||
"paymentPspReference" : "",
|
||||
"Idempotency-Key" : "",
|
||||
"storedPaymentMethodId" : "",
|
||||
"sessionId" : "",
|
||||
"shopperReference" : ""
|
||||
}
|
||||
}
|
@ -1,2 +1,3 @@
|
||||
Apis/PaymentsApi.http
|
||||
Apis/http-client.template.env.json
|
||||
README.md
|
||||
|
@ -0,0 +1,5 @@
|
||||
{
|
||||
"dev": {
|
||||
"id" : ""
|
||||
}
|
||||
}
|
@ -25,4 +25,5 @@ Apis/SchemaApi.http
|
||||
Apis/SearchApi.http
|
||||
Apis/StatusApi.http
|
||||
Apis/TeamsApi.http
|
||||
Apis/http-client.template.env.json
|
||||
README.md
|
||||
|
@ -2,5 +2,5 @@
|
||||
|
||||
### GET /benchmarks
|
||||
## GET /benchmarks
|
||||
GET https://api.opendota.com/api/benchmarks
|
||||
GET https://api.opendota.com/api/benchmarks?heroId={{heroId}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
@ -2,5 +2,5 @@
|
||||
|
||||
### GET /explorer
|
||||
## GET /explorer
|
||||
GET https://api.opendota.com/api/explorer
|
||||
GET https://api.opendota.com/api/explorer?sql={{sql}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
@ -2,5 +2,5 @@
|
||||
|
||||
### GET /
|
||||
## GET /
|
||||
GET https://api.opendota.com/api/findMatches
|
||||
GET https://api.opendota.com/api/findMatches?teamA={{teamA}}&teamB={{teamB}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
@ -2,5 +2,5 @@
|
||||
|
||||
### GET /parsedMatches
|
||||
## GET /parsedMatches
|
||||
GET https://api.opendota.com/api/parsedMatches
|
||||
GET https://api.opendota.com/api/parsedMatches?lessThanMatchId={{lessThanMatchId}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
### GET /players/{account_id}/counts
|
||||
## GET /players/{account_id}/counts
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/counts
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/counts?limit={{limit}}&offset={{offset}}&win={{win}}&patch={{patch}}&gameMode={{gameMode}}&lobbyType={{lobbyType}}®ion={{region}}&date={{date}}&laneRole={{laneRole}}&heroId={{heroId}}&isRadiant={{isRadiant}}&includedAccountId={{includedAccountId}}&excludedAccountId={{excludedAccountId}}&withHeroId={{withHeroId}}&againstHeroId={{againstHeroId}}&significant={{significant}}&having={{having}}&sort={{sort}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
||||
### GET /players/{account_id}
|
||||
@ -12,27 +12,27 @@ Accept: application/json; charset=utf-8
|
||||
|
||||
### GET /players/{account_id}/heroes
|
||||
## GET /players/{account_id}/heroes
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/heroes
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/heroes?limit={{limit}}&offset={{offset}}&win={{win}}&patch={{patch}}&gameMode={{gameMode}}&lobbyType={{lobbyType}}®ion={{region}}&date={{date}}&laneRole={{laneRole}}&heroId={{heroId}}&isRadiant={{isRadiant}}&includedAccountId={{includedAccountId}}&excludedAccountId={{excludedAccountId}}&withHeroId={{withHeroId}}&againstHeroId={{againstHeroId}}&significant={{significant}}&having={{having}}&sort={{sort}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
||||
### GET /players/{account_id}/histograms
|
||||
## GET /players/{account_id}/histograms
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/histograms/{{field}}
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/histograms/{{field}}?limit={{limit}}&offset={{offset}}&win={{win}}&patch={{patch}}&gameMode={{gameMode}}&lobbyType={{lobbyType}}®ion={{region}}&date={{date}}&laneRole={{laneRole}}&heroId={{heroId}}&isRadiant={{isRadiant}}&includedAccountId={{includedAccountId}}&excludedAccountId={{excludedAccountId}}&withHeroId={{withHeroId}}&againstHeroId={{againstHeroId}}&significant={{significant}}&having={{having}}&sort={{sort}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
||||
### GET /players/{account_id}/matches
|
||||
## GET /players/{account_id}/matches
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/matches
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/matches?limit={{limit}}&offset={{offset}}&win={{win}}&patch={{patch}}&gameMode={{gameMode}}&lobbyType={{lobbyType}}®ion={{region}}&date={{date}}&laneRole={{laneRole}}&heroId={{heroId}}&isRadiant={{isRadiant}}&includedAccountId={{includedAccountId}}&excludedAccountId={{excludedAccountId}}&withHeroId={{withHeroId}}&againstHeroId={{againstHeroId}}&significant={{significant}}&having={{having}}&sort={{sort}}&project={{project}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
||||
### GET /players/{account_id}/peers
|
||||
## GET /players/{account_id}/peers
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/peers
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/peers?limit={{limit}}&offset={{offset}}&win={{win}}&patch={{patch}}&gameMode={{gameMode}}&lobbyType={{lobbyType}}®ion={{region}}&date={{date}}&laneRole={{laneRole}}&heroId={{heroId}}&isRadiant={{isRadiant}}&includedAccountId={{includedAccountId}}&excludedAccountId={{excludedAccountId}}&withHeroId={{withHeroId}}&againstHeroId={{againstHeroId}}&significant={{significant}}&having={{having}}&sort={{sort}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
||||
### GET /players/{account_id}/pros
|
||||
## GET /players/{account_id}/pros
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/pros
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/pros?limit={{limit}}&offset={{offset}}&win={{win}}&patch={{patch}}&gameMode={{gameMode}}&lobbyType={{lobbyType}}®ion={{region}}&date={{date}}&laneRole={{laneRole}}&heroId={{heroId}}&isRadiant={{isRadiant}}&includedAccountId={{includedAccountId}}&excludedAccountId={{excludedAccountId}}&withHeroId={{withHeroId}}&againstHeroId={{againstHeroId}}&significant={{significant}}&having={{having}}&sort={{sort}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
||||
### GET /players/{account_id}/rankings
|
||||
@ -57,20 +57,20 @@ Accept: application/json; charset=utf-8
|
||||
|
||||
### GET /players/{account_id}/totals
|
||||
## GET /players/{account_id}/totals
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/totals
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/totals?limit={{limit}}&offset={{offset}}&win={{win}}&patch={{patch}}&gameMode={{gameMode}}&lobbyType={{lobbyType}}®ion={{region}}&date={{date}}&laneRole={{laneRole}}&heroId={{heroId}}&isRadiant={{isRadiant}}&includedAccountId={{includedAccountId}}&excludedAccountId={{excludedAccountId}}&withHeroId={{withHeroId}}&againstHeroId={{againstHeroId}}&significant={{significant}}&having={{having}}&sort={{sort}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
||||
### GET /players/{account_id}/wardmap
|
||||
## GET /players/{account_id}/wardmap
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/wardmap
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/wardmap?limit={{limit}}&offset={{offset}}&win={{win}}&patch={{patch}}&gameMode={{gameMode}}&lobbyType={{lobbyType}}®ion={{region}}&date={{date}}&laneRole={{laneRole}}&heroId={{heroId}}&isRadiant={{isRadiant}}&includedAccountId={{includedAccountId}}&excludedAccountId={{excludedAccountId}}&withHeroId={{withHeroId}}&againstHeroId={{againstHeroId}}&significant={{significant}}&having={{having}}&sort={{sort}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
||||
### GET /players/{account_id}/wl
|
||||
## GET /players/{account_id}/wl
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/wl
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/wl?limit={{limit}}&offset={{offset}}&win={{win}}&patch={{patch}}&gameMode={{gameMode}}&lobbyType={{lobbyType}}®ion={{region}}&date={{date}}&laneRole={{laneRole}}&heroId={{heroId}}&isRadiant={{isRadiant}}&includedAccountId={{includedAccountId}}&excludedAccountId={{excludedAccountId}}&withHeroId={{withHeroId}}&againstHeroId={{againstHeroId}}&significant={{significant}}&having={{having}}&sort={{sort}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
||||
### GET /players/{account_id}/wordcloud
|
||||
## GET /players/{account_id}/wordcloud
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/wordcloud
|
||||
GET https://api.opendota.com/api/players/{{account_id}}/wordcloud?limit={{limit}}&offset={{offset}}&win={{win}}&patch={{patch}}&gameMode={{gameMode}}&lobbyType={{lobbyType}}®ion={{region}}&date={{date}}&laneRole={{laneRole}}&heroId={{heroId}}&isRadiant={{isRadiant}}&includedAccountId={{includedAccountId}}&excludedAccountId={{excludedAccountId}}&withHeroId={{withHeroId}}&againstHeroId={{againstHeroId}}&significant={{significant}}&having={{having}}&sort={{sort}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
@ -2,5 +2,5 @@
|
||||
|
||||
### GET /proMatches
|
||||
## GET /proMatches
|
||||
GET https://api.opendota.com/api/proMatches
|
||||
GET https://api.opendota.com/api/proMatches?lessThanMatchId={{lessThanMatchId}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
@ -2,5 +2,5 @@
|
||||
|
||||
### GET /publicMatches
|
||||
## GET /publicMatches
|
||||
GET https://api.opendota.com/api/publicMatches
|
||||
GET https://api.opendota.com/api/publicMatches?mmrAscending={{mmrAscending}}&mmrDescending={{mmrDescending}}&lessThanMatchId={{lessThanMatchId}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
@ -2,5 +2,5 @@
|
||||
|
||||
### GET /rankings
|
||||
## GET /rankings
|
||||
GET https://api.opendota.com/api/rankings
|
||||
GET https://api.opendota.com/api/rankings?heroId={{heroId}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
@ -2,15 +2,15 @@
|
||||
|
||||
### GET /scenarios/itemTimings
|
||||
## GET /scenarios/itemTimings
|
||||
GET https://api.opendota.com/api/scenarios/itemTimings
|
||||
GET https://api.opendota.com/api/scenarios/itemTimings?item={{item}}&heroId={{heroId}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
||||
### GET /scenarios/laneRoles
|
||||
## GET /scenarios/laneRoles
|
||||
GET https://api.opendota.com/api/scenarios/laneRoles
|
||||
GET https://api.opendota.com/api/scenarios/laneRoles?laneRole={{laneRole}}&heroId={{heroId}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
||||
### GET /scenarios/misc
|
||||
## GET /scenarios/misc
|
||||
GET https://api.opendota.com/api/scenarios/misc
|
||||
GET https://api.opendota.com/api/scenarios/misc?scenario={{scenario}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
@ -2,5 +2,5 @@
|
||||
|
||||
### GET /search
|
||||
## GET /search
|
||||
GET https://api.opendota.com/api/search
|
||||
GET https://api.opendota.com/api/search?q={{q}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
### GET /teams
|
||||
## GET /teams
|
||||
GET https://api.opendota.com/api/teams
|
||||
GET https://api.opendota.com/api/teams?page={{page}}
|
||||
Accept: application/json; charset=utf-8
|
||||
|
||||
### GET /teams/{team_id}
|
||||
|
@ -0,0 +1,41 @@
|
||||
{
|
||||
"dev": {
|
||||
"lobbyType" : "",
|
||||
"date" : "",
|
||||
"heroId" : "",
|
||||
"project" : "",
|
||||
"team_id" : "",
|
||||
"includedAccountId" : "",
|
||||
"sql" : "",
|
||||
"patch" : "",
|
||||
"scenario" : "",
|
||||
"teamA" : "",
|
||||
"teamB" : "",
|
||||
"limit" : "",
|
||||
"isRadiant" : "",
|
||||
"hero_id" : "",
|
||||
"win" : "",
|
||||
"item" : "",
|
||||
"having" : "",
|
||||
"offset" : "",
|
||||
"laneRole" : "",
|
||||
"resource" : "",
|
||||
"match_id" : "",
|
||||
"lessThanMatchId" : "",
|
||||
"mmrDescending" : "",
|
||||
"significant" : "",
|
||||
"sort" : "",
|
||||
"jobId" : "",
|
||||
"q" : "",
|
||||
"excludedAccountId" : "",
|
||||
"account_id" : "",
|
||||
"field" : "",
|
||||
"mmrAscending" : "",
|
||||
"page" : "",
|
||||
"gameMode" : "",
|
||||
"region" : "",
|
||||
"withHeroId" : "",
|
||||
"league_id" : "",
|
||||
"againstHeroId" : ""
|
||||
}
|
||||
}
|
@ -1,4 +1,5 @@
|
||||
Apis/PetApi.http
|
||||
Apis/StoreApi.http
|
||||
Apis/UserApi.http
|
||||
Apis/http-client.template.env.json
|
||||
README.md
|
||||
|
@ -21,16 +21,17 @@ Accept: application/json
|
||||
### Deletes a pet
|
||||
## Deletes a pet
|
||||
DELETE http://petstore.swagger.io/v2/pet/{{petId}}
|
||||
api_key: {{apiKey}}
|
||||
|
||||
### Finds Pets by status
|
||||
## Finds Pets by status
|
||||
GET http://petstore.swagger.io/v2/pet/findByStatus
|
||||
GET http://petstore.swagger.io/v2/pet/findByStatus?status={{status}}
|
||||
Accept: application/xml
|
||||
Accept: application/json
|
||||
|
||||
### Finds Pets by tags
|
||||
## Finds Pets by tags
|
||||
GET http://petstore.swagger.io/v2/pet/findByTags
|
||||
GET http://petstore.swagger.io/v2/pet/findByTags?tags={{tags}}
|
||||
Accept: application/xml
|
||||
Accept: application/json
|
||||
|
||||
|
@ -53,7 +53,7 @@ Accept: application/json
|
||||
|
||||
### Logs user into the system
|
||||
## Logs user into the system
|
||||
GET http://petstore.swagger.io/v2/user/login
|
||||
GET http://petstore.swagger.io/v2/user/login?username={{username}}&password={{password}}
|
||||
Accept: application/xml
|
||||
Accept: application/json
|
||||
|
||||
|
@ -0,0 +1,11 @@
|
||||
{
|
||||
"dev": {
|
||||
"password" : "",
|
||||
"petId" : "",
|
||||
"api_key" : "",
|
||||
"orderId" : "",
|
||||
"status" : "",
|
||||
"tags" : "",
|
||||
"username" : ""
|
||||
}
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user