docs: fix proto option generation (#1972)

* docs: fix proto option generation

* update

Co-authored-by: Livio Amstutz <livio.a@gmail.com>

docs/docs/apis/proto/admin.md

@@ -17,6 +17,8 @@ It respondes as soon as ZITADEL started
 
 
 
+    GET: /healthz
+
 
 ### IsOrgUnique
 
@@ -27,6 +29,8 @@ Checks whether an organisation exists by the given parameters
 
 
 
+    GET: /orgs/_is_unique
+
 
 ### GetOrgByID
 
@@ -37,6 +41,8 @@ Returns an organisation by id
 
 
 
+    GET: /orgs/{id}
+
 
 ### ListOrgs
 
@@ -48,6 +54,8 @@ all queries need to match (AND)
 
 
 
+    POST: /orgs/_search
+
 
 ### SetUpOrg
 
@@ -59,6 +67,8 @@ and adds the user to the orgs members as ORG_OWNER
 
 
 
+    POST: /orgs/_setup
+
 
 ### GetIDPByID
 
@@ -69,6 +79,8 @@ Returns a identity provider configuration of the IAM
 
 
 
+    GET: /idps/{id}
+
 
 ### ListIDPs
 
@@ -79,6 +91,8 @@ Returns all identity provider configurations of the IAM
 
 
 
+    POST: /idps/_search
+
 
 ### AddOIDCIDP
 
@@ -89,6 +103,8 @@ Adds a new oidc identity provider configuration the IAM
 
 
 
+    POST: /idps/oidc
+
 
 ### UpdateIDP
 
@@ -100,6 +116,8 @@ all fields are updated. If no value is provided the field will be empty afterwar
 
 
 
+    PUT: /idps/{idp_id}
+
 
 ### DeactivateIDP
 
@@ -111,6 +129,8 @@ the state MUST be IDP_STATE_ACTIVE for this call
 
 
 
+    POST: /idps/{idp_id}/_deactivate
+
 
 ### ReactivateIDP
 
@@ -122,6 +142,8 @@ the state MUST be IDP_STATE_INACTIVE for this call
 
 
 
+    POST: /idps/{idp_id}/_reactivate
+
 
 ### RemoveIDP
 
@@ -132,6 +154,8 @@ RemoveIDP deletes the IDP permanetly
 
 
 
+    DELETE: /idps/{idp_id}
+
 
 ### UpdateIDPOIDCConfig
 
@@ -143,6 +167,8 @@ all fields are updated. If no value is provided the field will be empty afterwar
 
 
 
+    PUT: /idps/{idp_id}/oidc_config
+
 
 ### GetDefaultFeatures
 
@@ -153,6 +179,8 @@ all fields are updated. If no value is provided the field will be empty afterwar
 
 
 
+    GET: /features
+
 
 ### SetDefaultFeatures
 
@@ -163,6 +191,8 @@ all fields are updated. If no value is provided the field will be empty afterwar
 
 
 
+    PUT: /features
+
 
 ### GetOrgFeatures
 
@@ -173,6 +203,8 @@ all fields are updated. If no value is provided the field will be empty afterwar
 
 
 
+    GET: /orgs/{org_id}/features
+
 
 ### SetOrgFeatures
 
@@ -183,6 +215,8 @@ all fields are updated. If no value is provided the field will be empty afterwar
 
 
 
+    PUT: /orgs/{org_id}/features
+
 
 ### ResetOrgFeatures
 
@@ -193,6 +227,8 @@ all fields are updated. If no value is provided the field will be empty afterwar
 
 
 
+    DELETE: /orgs/{org_id}/features
+
 
 ### GetOrgIAMPolicy
 
@@ -203,6 +239,8 @@ Returns the IAM policy defined by the administrators of ZITADEL
 
 
 
+    GET: /policies/orgiam
+
 
 ### UpdateOrgIAMPolicy
 
@@ -214,6 +252,8 @@ it impacts all organisations without a customised policy
 
 
 
+    PUT: /policies/orgiam
+
 
 ### GetCustomOrgIAMPolicy
 
@@ -224,6 +264,8 @@ Returns the customised policy or the default if not customised
 
 
 
+    GET: /orgs/{org_id}/policies/orgiam
+
 
 ### AddCustomOrgIAMPolicy
 
@@ -234,6 +276,8 @@ Defines a custom ORGIAM policy as specified
 
 
 
+    POST: /orgs/{org_id}/policies/orgiam
+
 
 ### UpdateCustomOrgIAMPolicy
 
@@ -244,6 +288,8 @@ Updates a custom ORGIAM policy as specified
 
 
 
+    PUT: /orgs/{org_id}/policies/orgiam
+
 
 ### ResetCustomOrgIAMPolicyToDefault
 
@@ -255,6 +301,8 @@ ZITADEL will fallback to the default policy defined by the ZITADEL administrator
 
 
 
+    DELETE: /orgs/{org_id}/policies/orgiam
+
 
 ### GetLabelPolicy
 
@@ -265,6 +313,8 @@ Returns the label policy defined by the administrators of ZITADEL
 
 
 
+    GET: /policies/label
+
 
 ### GetPreviewLabelPolicy
 
@@ -275,6 +325,8 @@ Returns the preview label policy defined by the administrators of ZITADEL
 
 
 
+    GET: /policies/label/_preview
+
 
 ### UpdateLabelPolicy
 
@@ -286,6 +338,8 @@ it impacts all organisations without a customised policy
 
 
 
+    PUT: /policies/label
+
 
 ### ActivateLabelPolicy
 
@@ -296,6 +350,8 @@ Activates all changes of the label policy
 
 
 
+    POST: /policies/label/_activate
+
 
 ### RemoveLabelPolicyLogo
 
@@ -306,6 +362,8 @@ Removes the logo of the label policy
 
 
 
+    DELETE: /policies/label/logo
+
 
 ### RemoveLabelPolicyLogoDark
 
@@ -316,6 +374,8 @@ Removes the logo dark of the label policy
 
 
 
+    DELETE: /policies/label/logo_dark
+
 
 ### RemoveLabelPolicyIcon
 
@@ -326,6 +386,8 @@ Removes the icon of the label policy
 
 
 
+    DELETE: /policies/label/icon
+
 
 ### RemoveLabelPolicyIconDark
 
@@ -336,6 +398,8 @@ Removes the logo dark of the label policy
 
 
 
+    DELETE: /policies/label/icon_dark
+
 
 ### RemoveLabelPolicyFont
 
@@ -346,6 +410,8 @@ Removes the font of the label policy
 
 
 
+    DELETE: /policies/label/font
+
 
 ### GetLoginPolicy
 
@@ -356,6 +422,8 @@ Returns the login policy defined by the administrators of ZITADEL
 
 
 
+    GET: /policies/login
+
 
 ### UpdateLoginPolicy
 
@@ -367,6 +435,8 @@ it impacts all organisations without a customised policy
 
 
 
+    PUT: /policies/login
+
 
 ### ListLoginPolicyIDPs
 
@@ -378,6 +448,8 @@ defined by the administrators of ZITADEL
 
 
 
+    POST: /policies/login/idps/_search
+
 
 ### AddIDPToLoginPolicy
 
@@ -389,6 +461,8 @@ It impacts all organisations without a customised policy
 
 
 
+    POST: /policies/login/idps
+
 
 ### RemoveIDPFromLoginPolicy
 
@@ -400,6 +474,8 @@ It impacts all organisations without a customised policy
 
 
 
+    DELETE: /policies/login/idps/{idp_id}
+
 
 ### ListLoginPolicySecondFactors
 
@@ -410,6 +486,8 @@ Returns the available second factors defined by the administrators of ZITADEL
 
 
 
+    POST: /policies/login/second_factors/_search
+
 
 ### AddSecondFactorToLoginPolicy
 
@@ -421,6 +499,8 @@ It impacts all organisations without a customised policy
 
 
 
+    POST: /policies/login/second_factors
+
 
 ### RemoveSecondFactorFromLoginPolicy
 
@@ -432,6 +512,8 @@ It impacts all organisations without a customised policy
 
 
 
+    DELETE: /policies/login/second_factors/{type}
+
 
 ### ListLoginPolicyMultiFactors
 
@@ -442,6 +524,8 @@ Returns the available multi factors defined by the administrators of ZITADEL
 
 
 
+    POST: /policies/login/multi_factors/_search
+
 
 ### AddMultiFactorToLoginPolicy
 
@@ -453,6 +537,8 @@ It impacts all organisations without a customised policy
 
 
 
+    POST: /policies/login/multi_factors
+
 
 ### RemoveMultiFactorFromLoginPolicy
 
@@ -464,6 +550,8 @@ It impacts all organisations without a customised policy
 
 
 
+    DELETE: /policies/login/multi_factors/{type}
+
 
 ### GetPasswordComplexityPolicy
 
@@ -474,6 +562,8 @@ Returns the password complexity policy defined by the administrators of ZITADEL
 
 
 
+    GET: /policies/password/complexity
+
 
 ### UpdatePasswordComplexityPolicy
 
@@ -485,6 +575,8 @@ it impacts all organisations without a customised policy
 
 
 
+    PUT: /policies/password/complexity
+
 
 ### GetPasswordAgePolicy
 
@@ -495,6 +587,8 @@ Returns the password age policy defined by the administrators of ZITADEL
 
 
 
+    GET: /policies/password/age
+
 
 ### UpdatePasswordAgePolicy
 
@@ -506,6 +600,8 @@ it impacts all organisations without a customised policy
 
 
 
+    PUT: /policies/password/age
+
 
 ### GetPasswordLockoutPolicy
 
@@ -516,6 +612,8 @@ Returns the password lockout policy defined by the administrators of ZITADEL
 
 
 
+    GET: /policies/password/lockout
+
 
 ### UpdatePasswordLockoutPolicy
 
@@ -527,6 +625,8 @@ it impacts all organisations without a customised policy
 
 
 
+    PUT: /policies/password/lockout
+
 
 ### GetPrivacyPolicy
 
@@ -537,6 +637,8 @@ Returns the privacy policy defined by the administrators of ZITADEL
 
 
 
+    GET: /policies/privacy
+
 
 ### UpdatePrivacyPolicy
 
@@ -548,6 +650,8 @@ it impacts all organisations without a customised policy
 
 
 
+    PUT: /policies/privacy
+
 
 ### GetDefaultInitMessageText
 
@@ -558,6 +662,8 @@ Returns the custom text for initial message
 
 
 
+    GET: /text/message/init/{language}
+
 
 ### SetDefaultInitMessageText
 
@@ -571,6 +677,8 @@ The Following Variables can be used:
 
 
 
+    PUT: /text/message/init/{language}
+
 
 ### GetDefaultPasswordResetMessageText
 
@@ -581,6 +689,8 @@ Returns the custom text for password reset message
 
 
 
+    GET: /text/message/passwordreset/{language}
+
 
 ### SetDefaultPasswordResetMessageText
 
@@ -594,6 +704,8 @@ The Following Variables can be used:
 
 
 
+    PUT: /text/message/passwordreset/{language}
+
 
 ### GetDefaultVerifyEmailMessageText
 
@@ -604,6 +716,8 @@ Returns the custom text for verify email message
 
 
 
+    GET: /text/message/verifyemail/{language}
+
 
 ### SetDefaultVerifyEmailMessageText
 
@@ -617,6 +731,8 @@ The Following Variables can be used:
 
 
 
+    PUT: /text/message/verifyemail/{language}
+
 
 ### GetDefaultVerifyPhoneMessageText
 
@@ -627,6 +743,8 @@ Returns the custom text for verify phone message
 
 
 
+    GET: /text/message/verifyphone/{language}
+
 
 ### SetDefaultVerifyPhoneMessageText
 
@@ -640,6 +758,8 @@ The Following Variables can be used:
 
 
 
+    PUT: /text/message/verifyphone/{language}
+
 
 ### GetDefaultDomainClaimedMessageText
 
@@ -650,6 +770,8 @@ Returns the custom text for domain claimed message
 
 
 
+    GET: /text/message/domainclaimed/{language}
+
 
 ### SetDefaultDomainClaimedMessageText
 
@@ -663,6 +785,8 @@ The Following Variables can be used:
 
 
 
+    PUT: /text/message/verifyphone/{language}
+
 
 ### GetDefaultLoginTexts
 
@@ -673,6 +797,8 @@ Returns the default custom texts for login ui
 
 
 
+    GET: /text/default/login/{language}
+
 
 ### GetCustomLoginTexts
 
@@ -683,6 +809,8 @@ Returns the custom texts for login ui
 
 
 
+    GET: /text/login/{language}
+
 
 ### SetCustomLoginText
 
@@ -694,6 +822,8 @@ it impacts all organisations without customized login ui texts
 
 
 
+    PUT: /text/login/{language}
+
 
 ### ListIAMMemberRoles
 
@@ -704,6 +834,8 @@ Returns the IAM roles visible for the requested user
 
 
 
+    POST: /members/roles/_search
+
 
 ### ListIAMMembers
 
@@ -715,6 +847,8 @@ all queries need to match (ANDed)
 
 
 
+    POST: /members/_search
+
 
 ### AddIAMMember
 
@@ -726,6 +860,8 @@ undefined roles will be dropped
 
 
 
+    POST: /members
+
 
 ### UpdateIAMMember
 
@@ -737,6 +873,8 @@ The member has only roles provided by this call
 
 
 
+    PUT: /members/{user_id}
+
 
 ### RemoveIAMMember
 
@@ -747,6 +885,8 @@ Removes the user from the membership list of ZITADEL
 
 
 
+    DELETE: /members/{user_id}
+
 
 ### ListViews
 
@@ -759,6 +899,8 @@ they represent the delta of the event happend on the objects
 
 
 
+    POST: /views/_search
+
 
 ### ClearView
 
@@ -772,6 +914,8 @@ Search requests will return wrong results until all deltas are recomputed
 
 
 
+    POST: /views/{database}/{view_name}
+
 
 ### ListFailedEvents
 
@@ -784,6 +928,8 @@ For example if the SMTP-API wasn't able to send an email at the first time
 
 
 
+    POST: /failedevents/_search
+
 
 ### RemoveFailedEvent
 
@@ -798,6 +944,8 @@ failed event. You can find out if it worked on the `failure_count`
 
 
 
+    DELETE: /failedevents/{database}/{view_name}/{failed_sequence}
+
 
 
 

docs/docs/apis/proto/auth.md

@@ -16,6 +16,8 @@ title: zitadel/auth.proto
 
 
 
+    GET: /healthz
+
 
 ### GetMyUser
 
@@ -26,6 +28,8 @@ Returns my full blown user
 
 
 
+    GET: /users/me
+
 
 ### ListMyUserChanges
 
@@ -36,6 +40,8 @@ Returns the history of the authorized user (each event)
 
 
 
+    POST: /users/me/changes/_search
+
 
 ### ListMyUserSessions
 
@@ -46,6 +52,8 @@ Returns the user sessions of the authorized user of the current useragent
 
 
 
+    POST: /users/me/sessions/_search
+
 
 ### ListMyRefreshTokens
 
@@ -56,6 +64,8 @@ Returns the refresh tokens of the authorized user
 
 
 
+    POST: /users/me/tokens/refresh/_search
+
 
 ### RevokeMyRefreshToken
 
@@ -66,6 +76,8 @@ Revokes a single refresh token of the authorized user by its (token) id
 
 
 
+    DELETE: /users/me/tokens/refresh/{id}
+
 
 ### RevokeAllMyRefreshTokens
 
@@ -76,6 +88,8 @@ Revokes all refresh tokens of the authorized user
 
 
 
+    POST: /users/me/tokens/refresh/_revoke_all
+
 
 ### UpdateMyUserName
 
@@ -86,6 +100,8 @@ Change the user name of the authorize user
 
 
 
+    PUT: /users/me/username
+
 
 ### GetMyPasswordComplexityPolicy
 
@@ -97,6 +113,8 @@ This policy defines how the password should look
 
 
 
+    GET: /policies/passwords/complexity
+
 
 ### UpdateMyPassword
 
@@ -107,6 +125,8 @@ Change the password of the authorized user
 
 
 
+    PUT: /users/me/password
+
 
 ### GetMyProfile
 
@@ -117,6 +137,8 @@ Returns the profile information of the authorized user
 
 
 
+    GET: /users/me/profile
+
 
 ### UpdateMyProfile
 
@@ -127,6 +149,8 @@ Changes the profile information of the authorized user
 
 
 
+    PUT: /users/me/profile
+
 
 ### GetMyEmail
 
@@ -137,6 +161,8 @@ Returns the email address of the authorized user
 
 
 
+    GET: /users/me/email
+
 
 ### SetMyEmail
 
@@ -148,6 +174,8 @@ An email is sent to the given address, to verify it
 
 
 
+    PUT: /users/me/email
+
 
 ### VerifyMyEmail
 
@@ -158,6 +186,8 @@ Sets the email address to verified
 
 
 
+    POST: /users/me/email/_verify
+
 
 ### ResendMyEmailVerification
 
@@ -168,6 +198,8 @@ Sends a new email to the last given address to verify it
 
 
 
+    POST: /users/me/email/_resend_verification
+
 
 ### GetMyPhone
 
@@ -178,6 +210,8 @@ Returns the phone number of the authorized user
 
 
 
+    GET: /users/me/phone
+
 
 ### SetMyPhone
 
@@ -189,6 +223,8 @@ An sms is sent to the number with a verification code
 
 
 
+    PUT: /users/me/phone
+
 
 ### VerifyMyPhone
 
@@ -199,6 +235,8 @@ Sets the phone number to verified
 
 
 
+    POST: /users/me/phone/_verify
+
 
 ### ResendMyPhoneVerification
 
@@ -209,6 +247,8 @@ Resends a sms to the last given phone number, to verify it
 
 
 
+    POST: /users/me/phone/_resend_verification
+
 
 ### RemoveMyPhone
 
@@ -219,6 +259,8 @@ Removed the phone number of the authorized user
 
 
 
+    DELETE: /users/me/phone
+
 
 ### RemoveMyAvatar
 
@@ -229,6 +271,8 @@ Remove my avatar
 
 
 
+    DELETE: /users/me/avatar
+
 
 ### ListMyLinkedIDPs
 
@@ -239,6 +283,8 @@ Returns a list of all linked identity providers (social logins, eg. Google, Micr
 
 
 
+    POST: /users/me/idps/_search
+
 
 ### RemoveMyLinkedIDP
 
@@ -249,6 +295,8 @@ Removes a linked identity provider (social logins, eg. Google, Microsoft, AD, et
 
 
 
+    DELETE: /users/me/idps/{idp_id}/{linked_user_id}
+
 
 ### ListMyAuthFactors
 
@@ -259,6 +307,8 @@ Returns all configured authentication factors (second and multi)
 
 
 
+    POST: /users/me/auth_factors/_search
+
 
 ### AddMyAuthFactorOTP
 
@@ -270,6 +320,8 @@ Only one OTP can be configured per user
 
 
 
+    POST: /users/me/auth_factors/otp
+
 
 ### VerifyMyAuthFactorOTP
 
@@ -280,6 +332,8 @@ Verify the last added OTP (One Time Password)
 
 
 
+    POST: /users/me/auth_factors/otp/_verify
+
 
 ### RemoveMyAuthFactorOTP
 
@@ -290,6 +344,8 @@ Removed the configured OTP (One Time Password) Factor
 
 
 
+    DELETE: /users/me/auth_factors/otp
+
 
 ### AddMyAuthFactorU2F
 
@@ -301,6 +357,8 @@ Multiple U2Fs can be configured
 
 
 
+    POST: /users/me/auth_factors/u2f
+
 
 ### VerifyMyAuthFactorU2F
 
@@ -311,6 +369,8 @@ Verifies the last added U2F (Universal Second Factor) of the authorized user
 
 
 
+    POST: /users/me/auth_factors/u2f/_verify
+
 
 ### RemoveMyAuthFactorU2F
 
@@ -321,6 +381,8 @@ Removes the U2F Authentication from the authorized user
 
 
 
+    DELETE: /users/me/auth_factors/u2f/{token_id}
+
 
 ### ListMyPasswordless
 
@@ -331,6 +393,8 @@ Returns all configured passwordless authentications of the authorized user
 
 
 
+    POST: /users/me/passwordless/_search
+
 
 ### AddMyPasswordless
 
@@ -342,6 +406,8 @@ Multiple passwordless authentications can be configured
 
 
 
+    POST: /users/me/passwordless
+
 
 ### VerifyMyPasswordless
 
@@ -352,6 +418,8 @@ Verifies the last added passwordless configuration
 
 
 
+    POST: /users/me/passwordless/_verify
+
 
 ### RemoveMyPasswordless
 
@@ -362,6 +430,8 @@ Removes the passwordless configuration from the authorized user
 
 
 
+    DELETE: /users/me/passwordless/{token_id}
+
 
 ### ListMyUserGrants
 
@@ -372,6 +442,8 @@ Returns all user grants (authorizations) of the authorized user
 
 
 
+    POST: /usergrants/me/_search
+
 
 ### ListMyProjectOrgs
 
@@ -382,6 +454,8 @@ Returns a list of organisations where the authorized user has a user grant (auth
 
 
 
+    POST: /global/projectorgs/_search
+
 
 ### ListMyZitadelFeatures
 
@@ -392,6 +466,8 @@ Returns a list of features, which are allowed on these organisation based on the
 
 
 
+    POST: /features/zitadel/me/_search
+
 
 ### ListMyZitadelPermissions
 
@@ -402,6 +478,8 @@ Returns the permissions the authorized user has in ZITADEL based on his manager
 
 
 
+    POST: /permissions/zitadel/me/_search
+
 
 ### ListMyProjectPermissions
 
@@ -412,6 +490,8 @@ Returns a list of roles for the authorized user and project
 
 
 
+    POST: /permissions/me/_search
+
 
 
 

proto/zitadel/docs/zitadel-md.tmpl

@@ -16,7 +16,7 @@ title: {{.Name}}
 
 {{ .Description}}
 
-{{$httpOption := .Option "validate.rules"}}
+{{$httpOption := .Option "google.api.http"}}
 {{range $httpOption.Rules}}
     {{ .Method }}: {{ .Pattern }}
 {{end}}