docs: generate admin api (#1584)

* fix: generate admin api

* fix: generate admin api

* fix: generate admin api

* fix: http option

* fix: admin api

* fix: md files

* fix: correct headers

* fix: proto definitions

* fix: proto api

* fix: proto api

* fix: proto api

* fix: proto api

proto/zitadel/admin.proto

@@ -1679,7 +1679,7 @@ message HealthzRequest {}
 
 message HealthzResponse {}
 
-// parameters are ORed
+// if name or domain is already in use, org is not unique
 message IsOrgUniqueRequest {
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {
 		json_schema: {
@@ -2284,7 +2284,7 @@ message AddCustomOrgIAMPolicyRequest {
         (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
             description: "the username has to end with the domain of it's organisation"
         }
-    ];
+    ]; // the username has to end with the domain of it's organisation (uniqueness is organisation based)
 }
 
 message AddCustomOrgIAMPolicyResponse {
@@ -2442,7 +2442,7 @@ message AddIDPToLoginPolicyRequest {
             min_length: 1;
             max_length: 200;
         }
-    ];
+    ]; // Id of the predefined idp configuration
 }
 
 message AddIDPToLoginPolicyResponse {
@@ -2617,7 +2617,7 @@ message UpdatePasswordLockoutPolicyRequest {
             example: "\"10\""
         }
     ];
-    // TODO: how to describe?
+    // If an error should be displayed during a lockout or not
     bool show_lockout_failure = 2;
 }
 
@@ -2805,7 +2805,7 @@ message View {
             example: "\"2019-04-01T08:45:00.000000Z\"";
             description: "The timestamp the event occured";
         }
-    ];
+    ]; // The timestamp the event occured
     google.protobuf.Timestamp last_successful_spooler_run = 5 [
         (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
             description: "The timestamp the event occured";

proto/zitadel/docs/zitadel-md.tmpl

@@ -0,0 +1,58 @@
+{{range .Files}}---
+title: {{.Name}}
+---
+> This document reflects the state from API 1.0 (available from 20.04.2021)
+
+{{if .HasServices}}
+{{range .Services -}}
+## {{.Name}} {#{{.FullName | lower | replace "." ""}}}
+{{.Description}}
+
+{{range .Methods -}}
+### {{.Name}}
+
+> **rpc** {{.Name}}([{{.RequestLongType}}](#{{.RequestLongType | lower | replace "." ""}}))
+[{{.ResponseLongType}}](#{{.ResponseLongType | lower | replace "." ""}})
+
+{{ .Description}}
+
+{{$httpOption := .Option "google.api.http"}}
+{{range $httpOption.Rules}}
+    {{ .Method }}: {{ .Pattern }}
+{{end}}
+
+{{end}}
+{{end}}
+{{end}}
+
+{{if .HasServices}}
+## Messages
+{{range .Messages}}
+
+### {{.LongName}}
+{{.Description}}
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+{{range .Fields -}}
+| {{if .IsOneof}}[**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) {{.OneofDecl}}.{{end}}{{.Name}} | {{if .IsMap}}map {{else}}{{.Label}} {{end}}{{.LongType}} | {{if .Description}}{{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}}{{else}}-{{end}} |
+{{end}}
+{{end}}
+{{end}}
+
+{{if .HasEnums }}
+## Enums
+{{range .Enums}}
+
+### {{.LongName}} {#{{.LongName | lower | replace "." ""}}}
+{{.Description}}
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+{{range .Values -}}
+| {{.Name}} | {{.Number}} | {{if .Description}}{{nobr .Description}}{{else}}-{{end}} |
+{{end}}
+
+{{end}}
+{{end}}
+{{end}}

proto/zitadel/features.proto

@@ -1,7 +1,6 @@
 syntax = "proto3";
 
 import "zitadel/object.proto";
-import "google/protobuf/timestamp.proto";
 import "google/protobuf/duration.proto";
 
 package zitadel.features.v1;