docs(api): additional openapi v2 information (#2739)

This commit is contained in:
Silvan
2021-11-29 08:29:53 +01:00
committed by GitHub
parent 144e6e4b57
commit 77a3f848e5
3 changed files with 29 additions and 1 deletions

View File

@@ -47,9 +47,17 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
produces: "application/json";
produces: "application/grpc";
host: "api.zitadel.io";
consumes: "application/grpc-web+proto";
produces: "application/grpc-web+proto";
host: "api.zitadel.ch";
base_path: "/admin/v1";
external_docs: {
description: "Detailed information about ZITADEL",
url: "https://docs.zitadel.ch"
}
security_definitions: {
security: {
key: "BasicAuth";

View File

@@ -38,9 +38,19 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
consumes: "application/json";
consumes: "application/grpc";
consumes: "application/grpc-web+proto";
produces: "application/json";
produces: "application/grpc";
produces: "application/grpc-web+proto";
host: "api.zitadel.ch";
base_path: "/auth/v1";
external_docs: {
description: "Detailed information about ZITADEL",
url: "https://docs.zitadel.ch"
}
};

View File

@@ -45,6 +45,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
};
schemes: HTTPS;
consumes: "application/json";
produces: "application/json";
@@ -54,11 +55,20 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
consumes: "application/grpc-web+proto";
produces: "application/grpc-web+proto";
host: "api.zitadel.ch";
base_path: "/management/v1";
external_docs: {
description: "Detailed information about ZITADEL",
url: "https://docs.zitadel.ch"
}
extensions: {
key: "x-zitadel-orgid";
value: {
string_value: "your-org-id";
}
}
};