add v1.29.4 changelog

garajonai · Mar 15, 2024 · 2a79ee2 · 2a79ee2
1 parent 7285805
commit 2a79ee2
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,18 @@
 
+<a name="v1.29.4"></a>
+## [v1.29.4](https://github.com/garajonai/proto/compare/v1.29.3...v1.29.4)
+
+> 2024-03-15
+
+### Change
+
+* **ci:** update secrets
+
+### Feat
+
+* **ci:** add reviewdog
+
+
 <a name="v1.29.3"></a>
 ## [v1.29.3](https://github.com/garajonai/proto/compare/v1.29.1...v1.29.3)
 

diff --git a/...oc-registry/src/content/docs/proto/iam-roots-account/api/v1/accountapi/index.md b/...oc-registry/src/content/docs/proto/iam-roots-account/api/v1/accountapi/index.md
@@ -29,12 +29,12 @@ title: Accountapi
 
 
 ### IAMRootsAccountApi
-*Description comment will be shown here*
+IAMRootsAccountApi BFF service
 
 | Method Name | Description |
 | ----------- | ------------|
-| `StartWebauthnRegistration` <br /><br /> Request: [StartWebauthnRegistrationRequest](#garajonai.platform.iamrootsaccount.api.bff.v1.StartWebauthnRegistrationRequest) <br /> Response: [StartWebauthnRegistrationResponse](#garajonai.platform.iamrootsaccount.api.bff.v1.StartWebauthnRegistrationRequest) | <para></para> |
-| `FinishWebauthnRegistration` <br /><br /> Request: [FinishWebauthnRegistrationRequest](#garajonai.platform.iamrootsaccount.api.bff.v1.FinishWebauthnRegistrationRequest) <br /> Response: [FinishWebauthnRegistrationResponse](#garajonai.platform.iamrootsaccount.api.bff.v1.FinishWebauthnRegistrationRequest) | <para></para> |
+| `StartWebauthnRegistration` <br /><br /> Request: [StartWebauthnRegistrationRequest](#garajonai.platform.iamrootsaccount.api.bff.v1.StartWebauthnRegistrationRequest) <br /> Response: [StartWebauthnRegistrationResponse](#garajonai.platform.iamrootsaccount.api.bff.v1.StartWebauthnRegistrationRequest) | <para>StartWebauthnRegistration starts a WebAuthn registration process</para> |
+| `FinishWebauthnRegistration` <br /><br /> Request: [FinishWebauthnRegistrationRequest](#garajonai.platform.iamrootsaccount.api.bff.v1.FinishWebauthnRegistrationRequest) <br /> Response: [FinishWebauthnRegistrationResponse](#garajonai.platform.iamrootsaccount.api.bff.v1.FinishWebauthnRegistrationRequest) | <para>FinishWebauthnRegistration finishes a WebAuthn registration process</para> |
 
 
 
@@ -50,7 +50,7 @@ title: Accountapi
 <!-- ------  Messages ------ -->
 <a name="garajonai.platform.iamrootsaccount.api.bff.v1.FinishWebauthnRegistrationRequest"></a>
 ### FinishWebauthnRegistrationRequest
-*Description comment will be shown here (markdown supported)*
+FinishWebauthnRegistrationRequest is the request message for FinishWebauthnRegistration
 
 
 #### Fields
@@ -69,7 +69,7 @@ title: Accountapi
 
 <a name="garajonai.platform.iamrootsaccount.api.bff.v1.FinishWebauthnRegistrationResponse"></a>
 ### FinishWebauthnRegistrationResponse
-*Description comment will be shown here (markdown supported)*
+FinishWebauthnRegistrationResponse is the response message for FinishWebauthnRegistration
 
 
 #### Fields
@@ -83,7 +83,7 @@ title: Accountapi
 
 <a name="garajonai.platform.iamrootsaccount.api.bff.v1.StartWebauthnRegistrationRequest"></a>
 ### StartWebauthnRegistrationRequest
-*Description comment will be shown here (markdown supported)*
+StartWebauthnRegistrationRequest is the request message for StartWebauthnRegistration
 
 
 #### Fields
@@ -97,7 +97,7 @@ title: Accountapi
 
 <a name="garajonai.platform.iamrootsaccount.api.bff.v1.StartWebauthnRegistrationResponse"></a>
 ### StartWebauthnRegistrationResponse
-*Description comment will be shown here (markdown supported)*
+StartWebauthnRegistrationResponse is the response message for StartWebauthnRegistration
 
 
 #### Fields

diff --git a/scripts/doc-registry/src/content/docs/proto/iam-roots-account/api/v1/index.md b/scripts/doc-registry/src/content/docs/proto/iam-roots-account/api/v1/index.md
@@ -94,19 +94,19 @@ title: Error, Session_management, User_account, Webauthn
 
 
 ### UserAccount
-*Description comment will be shown here*
+UserAccount is the service that provides user account information.
 
 | Method Name | Description |
 | ----------- | ------------|
-| `GetUserInfo` <br /><br /> Request: [GetUserInfoRequest](#garajonai.platform.iamrootsaccount.api.v1.GetUserInfoRequest) <br /> Response: [GetUserInfoResponse](#garajonai.platform.iamrootsaccount.api.v1.GetUserInfoRequest) | <para></para> |
-| `InsertUserInfo` <br /><br /> Request: [InsertUserInfoRequest](#garajonai.platform.iamrootsaccount.api.v1.InsertUserInfoRequest) <br /> Response: [InsertUserInfoResponse](#garajonai.platform.iamrootsaccount.api.v1.InsertUserInfoRequest) | <para></para> |
-| `DeleteUserInfo` <br /><br /> Request: [DeleteUserInfoRequest](#garajonai.platform.iamrootsaccount.api.v1.DeleteUserInfoRequest) <br /> Response: [DeleteUserInfoResponse](#garajonai.platform.iamrootsaccount.api.v1.DeleteUserInfoRequest) | <para></para> |
+| `GetUserInfo` <br /><br /> Request: [GetUserInfoRequest](#garajonai.platform.iamrootsaccount.api.v1.GetUserInfoRequest) <br /> Response: [GetUserInfoResponse](#garajonai.platform.iamrootsaccount.api.v1.GetUserInfoRequest) | <para>GetUserInfo returns the user information.</para> |
+| `InsertUserInfo` <br /><br /> Request: [InsertUserInfoRequest](#garajonai.platform.iamrootsaccount.api.v1.InsertUserInfoRequest) <br /> Response: [InsertUserInfoResponse](#garajonai.platform.iamrootsaccount.api.v1.InsertUserInfoRequest) | <para>InsertUserInfo inserts the user information.</para> |
+| `DeleteUserInfo` <br /><br /> Request: [DeleteUserInfoRequest](#garajonai.platform.iamrootsaccount.api.v1.DeleteUserInfoRequest) <br /> Response: [DeleteUserInfoResponse](#garajonai.platform.iamrootsaccount.api.v1.DeleteUserInfoRequest) | <para>DeleteUserInfo deletes the user information.</para> |
 
 
 
 
 ### Webauthn
-*Description comment will be shown here*
+Webauthn service is used to register and revoke Webauthn credentials.
 
 | Method Name | Description |
 | ----------- | ------------|
@@ -229,7 +229,7 @@ Error type for Webauthn
 <!-- ------  Messages ------ -->
 <a name="garajonai.platform.iamrootsaccount.api.v1.DeleteUserInfoRequest"></a>
 ### DeleteUserInfoRequest
-*Description comment will be shown here (markdown supported)*
+DeleteUserInfoRequest is the request message for DeleteUserInfo.
 
 
 #### Fields
@@ -243,14 +243,14 @@ Error type for Webauthn
 
 <a name="garajonai.platform.iamrootsaccount.api.v1.DeleteUserInfoResponse"></a>
 ### DeleteUserInfoResponse
-*Description comment will be shown here (markdown supported)*
+DeleteUserInfoResponse is the response message for DeleteUserInfo.
 
 
 
 
 <a name="garajonai.platform.iamrootsaccount.api.v1.GetUserInfoRequest"></a>
 ### GetUserInfoRequest
-*Description comment will be shown here (markdown supported)*
+GetUserInfoRequest is the request message for GetUserInfo.
 
 
 #### Fields
@@ -264,14 +264,14 @@ Error type for Webauthn
 
 <a name="garajonai.platform.iamrootsaccount.api.v1.GetUserInfoResponse"></a>
 ### GetUserInfoResponse
-*Description comment will be shown here (markdown supported)*
+GetUserInfoResponse is the response message for GetUserInfo.
 
 
 
 
 <a name="garajonai.platform.iamrootsaccount.api.v1.InsertUserInfoRequest"></a>
 ### InsertUserInfoRequest
-*Description comment will be shown here (markdown supported)*
+InsertUserInfoRequest is the request message for InsertUserInfo.
 
 
 #### Fields
@@ -286,7 +286,7 @@ Error type for Webauthn
 
 <a name="garajonai.platform.iamrootsaccount.api.v1.InsertUserInfoResponse"></a>
 ### InsertUserInfoResponse
-*Description comment will be shown here (markdown supported)*
+InsertUserInfoResponse is the response message for InsertUserInfo.
 
 
 

diff --git a/scripts/doc-registry/src/openapi/proto/iam-roots-account/api/v1/accountapi/openapi.yaml b/scripts/doc-registry/src/openapi/proto/iam-roots-account/api/v1/accountapi/openapi.yaml
@@ -4,12 +4,14 @@
 openapi: 3.0.3
 info:
     title: IAMRootsAccountApi API
+    description: IAMRootsAccountApi BFF service
     version: 0.0.1
 paths:
     /registration/webauthn/finish:
         post:
             tags:
                 - IAMRootsAccountApi
+            description: FinishWebauthnRegistration finishes a WebAuthn registration process
             operationId: IAMRootsAccountApi_FinishWebauthnRegistration
             requestBody:
                 content:
@@ -28,6 +30,7 @@ paths:
         post:
             tags:
                 - IAMRootsAccountApi
+            description: StartWebauthnRegistration starts a WebAuthn registration process
             operationId: IAMRootsAccountApi_StartWebauthnRegistration
             requestBody:
                 content:
@@ -62,21 +65,25 @@ components:
                         type: string
                 response:
                     $ref: '#/components/schemas/garajonai.platform.iamrootsaccount.api.v1.AttestationResponse'
+            description: FinishWebauthnRegistrationRequest is the request message for FinishWebauthnRegistration
         garajonai.platform.iamrootsaccount.api.bff.v1.FinishWebauthnRegistrationResponse:
             type: object
             properties:
                 status:
                     type: string
+            description: FinishWebauthnRegistrationResponse is the response message for FinishWebauthnRegistration
         garajonai.platform.iamrootsaccount.api.bff.v1.StartWebauthnRegistrationRequest:
             type: object
             properties:
                 email:
                     type: string
+            description: StartWebauthnRegistrationRequest is the request message for StartWebauthnRegistration
         garajonai.platform.iamrootsaccount.api.bff.v1.StartWebauthnRegistrationResponse:
             type: object
             properties:
                 publicKey:
                     $ref: '#/components/schemas/garajonai.platform.iamrootsaccount.api.v1.PublicKey'
+            description: StartWebauthnRegistrationResponse is the response message for StartWebauthnRegistration
         garajonai.platform.iamrootsaccount.api.v1.AttestationResponse:
             type: object
             properties: