docs: add auth header to new api docs (#6421)

This commit is contained in:
Fabi 2023-08-23 09:25:14 +02:00 committed by GitHub
parent efcabed04f
commit 37c527f18e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 2950 additions and 1922 deletions

File diff suppressed because it is too large Load Diff

View File

@ -46,7 +46,36 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
description: "Detailed information about ZITADEL", description: "Detailed information about ZITADEL",
url: "https://zitadel.com/docs" url: "https://zitadel.com/docs"
} }
security_definitions: {
security: {
key: "OAuth2";
value: {
type: TYPE_OAUTH2;
flow: FLOW_ACCESS_CODE;
authorization_url: "$ZITADEL_DOMAIN/oauth/v2/authorize";
token_url: "$ZITADEL_DOMAIN/oauth/v2/token";
scopes: {
scope: {
key: "openid";
value: "openid";
}
scope: {
key: "urn:zitadel:iam:org:project:id:zitadel:aud";
value: "urn:zitadel:iam:org:project:id:zitadel:aud";
}
}
}
}
}
security: {
security_requirement: {
key: "OAuth2";
value: {
scope: "openid";
scope: "urn:zitadel:iam:org:project:id:zitadel:aud";
}
}
}
responses: { responses: {
key: "403"; key: "403";
value: { value: {

View File

@ -55,7 +55,36 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
description: "Detailed information about ZITADEL", description: "Detailed information about ZITADEL",
url: "https://zitadel.com/docs" url: "https://zitadel.com/docs"
} }
security_definitions: {
security: {
key: "OAuth2";
value: {
type: TYPE_OAUTH2;
flow: FLOW_ACCESS_CODE;
authorization_url: "$ZITADEL_DOMAIN/oauth/v2/authorize";
token_url: "$ZITADEL_DOMAIN/oauth/v2/token";
scopes: {
scope: {
key: "openid";
value: "openid";
}
scope: {
key: "urn:zitadel:iam:org:project:id:zitadel:aud";
value: "urn:zitadel:iam:org:project:id:zitadel:aud";
}
}
}
}
}
security: {
security_requirement: {
key: "OAuth2";
value: {
scope: "openid";
scope: "urn:zitadel:iam:org:project:id:zitadel:aud";
}
}
}
responses: { responses: {
key: "403"; key: "403";
value: { value: {

View File

@ -49,7 +49,36 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
description: "Detailed information about ZITADEL", description: "Detailed information about ZITADEL",
url: "https://zitadel.com/docs" url: "https://zitadel.com/docs"
} }
security_definitions: {
security: {
key: "OAuth2";
value: {
type: TYPE_OAUTH2;
flow: FLOW_ACCESS_CODE;
authorization_url: "$ZITADEL_DOMAIN/oauth/v2/authorize";
token_url: "$ZITADEL_DOMAIN/oauth/v2/token";
scopes: {
scope: {
key: "openid";
value: "openid";
}
scope: {
key: "urn:zitadel:iam:org:project:id:zitadel:aud";
value: "urn:zitadel:iam:org:project:id:zitadel:aud";
}
}
}
}
}
security: {
security_requirement: {
key: "OAuth2";
value: {
scope: "openid";
scope: "urn:zitadel:iam:org:project:id:zitadel:aud";
}
}
}
responses: { responses: {
key: "403"; key: "403";
value: { value: {

View File

@ -51,7 +51,36 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
description: "Detailed information about ZITADEL", description: "Detailed information about ZITADEL",
url: "https://zitadel.com/docs" url: "https://zitadel.com/docs"
} }
security_definitions: {
security: {
key: "OAuth2";
value: {
type: TYPE_OAUTH2;
flow: FLOW_ACCESS_CODE;
authorization_url: "$ZITADEL_DOMAIN/oauth/v2/authorize";
token_url: "$ZITADEL_DOMAIN/oauth/v2/token";
scopes: {
scope: {
key: "openid";
value: "openid";
}
scope: {
key: "urn:zitadel:iam:org:project:id:zitadel:aud";
value: "urn:zitadel:iam:org:project:id:zitadel:aud";
}
}
}
}
}
security: {
security_requirement: {
key: "OAuth2";
value: {
scope: "openid";
scope: "urn:zitadel:iam:org:project:id:zitadel:aud";
}
}
}
responses: { responses: {
key: "403"; key: "403";
value: { value: {

View File

@ -53,7 +53,36 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
description: "Detailed information about ZITADEL", description: "Detailed information about ZITADEL",
url: "https://zitadel.com/docs" url: "https://zitadel.com/docs"
} }
security_definitions: {
security: {
key: "OAuth2";
value: {
type: TYPE_OAUTH2;
flow: FLOW_ACCESS_CODE;
authorization_url: "$ZITADEL_DOMAIN/oauth/v2/authorize";
token_url: "$ZITADEL_DOMAIN/oauth/v2/token";
scopes: {
scope: {
key: "openid";
value: "openid";
}
scope: {
key: "urn:zitadel:iam:org:project:id:zitadel:aud";
value: "urn:zitadel:iam:org:project:id:zitadel:aud";
}
}
}
}
}
security: {
security_requirement: {
key: "OAuth2";
value: {
scope: "openid";
scope: "urn:zitadel:iam:org:project:id:zitadel:aud";
}
}
}
responses: { responses: {
key: "403"; key: "403";
value: { value: {