From 18dfc860af17c8f1db51ecabfdc740b520d6bb83 Mon Sep 17 00:00:00 2001 From: "botanibit[bot]" <852671+botanibit[bot]@users.noreply.github.com> Date: Fri, 28 Jun 2024 02:29:56 +0000 Subject: [PATCH] add v1.30.0 changelog --- CHANGELOG.md | 10 +++++++ .../docs/proto/greenspace/api/v1/index.md | 14 +++++----- .../proto/iam-roots-account/api/v1/index.md | 28 +++++++++---------- .../api/v1/accountapi/openapi.yaml | 5 ++++ 4 files changed, 36 insertions(+), 21 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index db27f93..653fe37 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,14 @@ + +## [v1.30.0](https://github.com/garajonai/proto/compare/v1.29.4...v1.30.0) + +> 2024-03-15 + +### Fix + +* **proto:** reviewdog lint + + ## [v1.29.4](https://github.com/garajonai/proto/compare/v1.29.3...v1.29.4) diff --git a/scripts/doc-registry/src/content/docs/proto/greenspace/api/v1/index.md b/scripts/doc-registry/src/content/docs/proto/greenspace/api/v1/index.md index 7c6ac59..2faaeee 100644 --- a/scripts/doc-registry/src/content/docs/proto/greenspace/api/v1/index.md +++ b/scripts/doc-registry/src/content/docs/proto/greenspace/api/v1/index.md @@ -177,13 +177,13 @@ Condition, the condition of the water. In house algorithm to define the conditio | Name | Number | Description | | ---- | ------ | ----------- | -| GOOD | 0 | | -| MODERATE | 1 | | -| CONTAMINATED | 2 | | -| UNKNOWN | 3 | | -| RADIATION | 4 | | -| DANGER | 5 | | -| PROTECTED | 6 | | +| GOOD | 0 | The water is good. | +| MODERATE | 1 | The water is moderate. | +| CONTAMINATED | 2 | The water is contaminated. | +| UNKNOWN | 3 | The condition of the water is unknown. | +| RADIATION | 4 | The water has radiation. | +| DANGER | 5 | The water is in danger due to a natural disaster, human activity or danger animal lives there. | +| PROTECTED | 6 | The water is protected due to its natural beauty, flora, fauna or geological formations. | 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 index 2638674..826324f 100644 --- 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 @@ -110,9 +110,9 @@ Webauthn service is used to register and revoke Webauthn credentials. | Method Name | Description | | ----------- | ------------| -| `StartRegistration`

Request: [StartRegistrationRequest](#garajonai.platform.iamrootsaccount.api.v1.StartRegistrationRequest)
Response: [StartRegistrationResponse](#garajonai.platform.iamrootsaccount.api.v1.StartRegistrationRequest) | | -| `FinishRegistration`

Request: [FinishRegistrationRequest](#garajonai.platform.iamrootsaccount.api.v1.FinishRegistrationRequest)
Response: [FinishRegistrationResponse](#garajonai.platform.iamrootsaccount.api.v1.FinishRegistrationRequest) | | -| `RevokeConnection`

Request: [RevokeConnectionRequest](#garajonai.platform.iamrootsaccount.api.v1.RevokeConnectionRequest)
Response: [RevokeConnectionResponse](#garajonai.platform.iamrootsaccount.api.v1.RevokeConnectionRequest) | | +| `StartRegistration`

Request: [StartRegistrationRequest](#garajonai.platform.iamrootsaccount.api.v1.StartRegistrationRequest)
Response: [StartRegistrationResponse](#garajonai.platform.iamrootsaccount.api.v1.StartRegistrationRequest) | StartRegistration is used to start the registration of a Webauthn credential. | +| `FinishRegistration`

Request: [FinishRegistrationRequest](#garajonai.platform.iamrootsaccount.api.v1.FinishRegistrationRequest)
Response: [FinishRegistrationResponse](#garajonai.platform.iamrootsaccount.api.v1.FinishRegistrationRequest) | FinishRegistration is used to finish the registration of a Webauthn credential. | +| `RevokeConnection`

Request: [RevokeConnectionRequest](#garajonai.platform.iamrootsaccount.api.v1.RevokeConnectionRequest)
Response: [RevokeConnectionResponse](#garajonai.platform.iamrootsaccount.api.v1.RevokeConnectionRequest) | RevokeConnection is used to revoke a Webauthn credential. | @@ -322,7 +322,7 @@ Candidate to be rewritten ### AttestationResponse -*Description comment will be shown here (markdown supported)* +AttestationResponse is the response from the Webauthn authenticator. #### Fields @@ -337,7 +337,7 @@ Candidate to be rewritten ### AuthenticatorSelection -*Description comment will be shown here (markdown supported)* +AuthenticatorSelection is the selection of the authenticator. #### Fields @@ -353,7 +353,7 @@ Candidate to be rewritten ### FinishRegistrationRequest -*Description comment will be shown here (markdown supported)* +FinishRegistrationRequest is the request to finish the registration of a Webauthn credential. #### Fields @@ -372,7 +372,7 @@ Candidate to be rewritten ### FinishRegistrationResponse -*Description comment will be shown here (markdown supported)* +FinishRegistrationResponse is the response to the FinishRegistrationRequest. #### Fields @@ -386,7 +386,7 @@ Candidate to be rewritten ### PuKeyCredParams -*Description comment will be shown here (markdown supported)* +PuKeyCredParams is the public key credential parameters. #### Fields @@ -401,7 +401,7 @@ Candidate to be rewritten ### PublicKey -*Description comment will be shown here (markdown supported)* +PublicKey is the public key used to register a Webauthn credential. #### Fields @@ -421,7 +421,7 @@ Candidate to be rewritten ### ReplyingParty -*Description comment will be shown here (markdown supported)* +ReplyingParty is the party that is replying to the Webauthn request. #### Fields @@ -436,7 +436,7 @@ Candidate to be rewritten ### RevokeConnectionRequest -*Description comment will be shown here (markdown supported)* +RevokeConnectionRequest is the request to revoke a Webauthn credential. #### Fields @@ -451,7 +451,7 @@ Candidate to be rewritten ### RevokeConnectionResponse -*Description comment will be shown here (markdown supported)* +RevokeConnectionResponse is the response to the RevokeConnectionRequest. #### Fields @@ -465,7 +465,7 @@ Candidate to be rewritten ### StartRegistrationRequest -*Description comment will be shown here (markdown supported)* +StartRegistrationRequest is the request to start the registration of a Webauthn credential. #### Fields @@ -479,7 +479,7 @@ Candidate to be rewritten ### StartRegistrationResponse -*Description comment will be shown here (markdown supported)* +StartRegistrationResponse is the response to the StartRegistrationRequest. #### Fields 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 index 71142f3..5721c6c 100644 --- 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 @@ -91,6 +91,7 @@ components: type: string attestationObject: type: string + description: AttestationResponse is the response from the Webauthn authenticator. garajonai.platform.iamrootsaccount.api.v1.AuthenticatorSelection: type: object properties: @@ -100,6 +101,7 @@ components: type: boolean userVerification: type: string + description: AuthenticatorSelection is the selection of the authenticator. garajonai.platform.iamrootsaccount.api.v1.PuKeyCredParams: type: object properties: @@ -108,6 +110,7 @@ components: alg: type: integer format: int32 + description: PuKeyCredParams is the public key credential parameters. garajonai.platform.iamrootsaccount.api.v1.PublicKey: type: object properties: @@ -129,6 +132,7 @@ components: format: int32 attestation: type: string + description: PublicKey is the public key used to register a Webauthn credential. garajonai.platform.iamrootsaccount.api.v1.ReplyingParty: type: object properties: @@ -136,6 +140,7 @@ components: type: string name: type: string + description: ReplyingParty is the party that is replying to the Webauthn request. garajonai.platform.iamrootsaccount.api.v1.User: type: object properties: