Skip to content

Commit

Permalink
Update Swagger REST API doc
Browse files Browse the repository at this point in the history
  • Loading branch information
cb-github-robot authored and web-flow committed Aug 25, 2024
1 parent 65dfa55 commit 28217a8
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 17 deletions.
8 changes: 4 additions & 4 deletions src/api/rest/docs/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ const docTemplate = `{
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"termsOfService": "https://github.com/cloud-barista/cb-tumblebug/blob/main/README.md",
"contact": {
"name": "API Support",
"url": "http://cloud-barista.github.io",
"email": "contact-to-cloud-barista@googlegroups.com"
"url": "https://github.com/cloud-barista/cb-tumblebug/issues/new/choose"
},
"license": {
"name": "Apache 2.0",
Expand Down Expand Up @@ -554,7 +554,7 @@ const docTemplate = `{
},
"/credential": {
"post": {
"description": "This API registers credential information using hybrid encryption. 1. First, compress and encrypt sensitive data using a client generated AES with a 256-bit key. 2. Then, encrypt the AES key using an RSA public key obtained from ` + "`" + `GET /credential/publicKey` + "`" + `. 3. RSA encryption uses a 4096-bit key with OAEP padding and SHA-256 as the hash function. Ensure that all values are base64 encoded before sending them in the request. The public key token ID must be included in the request to allow the server to decrypt the data.",
"description": "This API registers credential information using hybrid encryption. The process involves compressing and encrypting sensitive data with AES-256, encrypting the AES key with a 4096-bit RSA public key (retrieved via ` + "`" + `GET /credential/publicKey` + "`" + `), and using OAEP padding with SHA-256. All values, including the AES key, must be base64 encoded before sending, and the public key token ID must be included in the request.",
"consumes": [
"application/json"
],
Expand Down Expand Up @@ -13568,7 +13568,7 @@ var SwaggerInfo = &swag.Spec{
BasePath: "/tumblebug",
Schemes: []string{},
Title: "CB-Tumblebug REST API",
Description: "CB-Tumblebug REST API",
Description: "CB-Tumblebug is an open source system for managing multi-cloud infrastructure consisting of resources from multiple cloud service providers. (Cloud-Barista)",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
LeftDelim: "{{",
Expand Down
8 changes: 4 additions & 4 deletions src/api/rest/docs/swagger.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"swagger": "2.0",
"info": {
"description": "CB-Tumblebug REST API",
"description": "CB-Tumblebug is an open source system for managing multi-cloud infrastructure consisting of resources from multiple cloud service providers. (Cloud-Barista)",
"title": "CB-Tumblebug REST API",
"termsOfService": "https://github.com/cloud-barista/cb-tumblebug/blob/main/README.md",
"contact": {
"name": "API Support",
"url": "http://cloud-barista.github.io",
"email": "contact-to-cloud-barista@googlegroups.com"
"url": "https://github.com/cloud-barista/cb-tumblebug/issues/new/choose"
},
"license": {
"name": "Apache 2.0",
Expand Down Expand Up @@ -547,7 +547,7 @@
},
"/credential": {
"post": {
"description": "This API registers credential information using hybrid encryption. 1. First, compress and encrypt sensitive data using a client generated AES with a 256-bit key. 2. Then, encrypt the AES key using an RSA public key obtained from `GET /credential/publicKey`. 3. RSA encryption uses a 4096-bit key with OAEP padding and SHA-256 as the hash function. Ensure that all values are base64 encoded before sending them in the request. The public key token ID must be included in the request to allow the server to decrypt the data.",
"description": "This API registers credential information using hybrid encryption. The process involves compressing and encrypting sensitive data with AES-256, encrypting the AES key with a 4096-bit RSA public key (retrieved via `GET /credential/publicKey`), and using OAEP padding with SHA-256. All values, including the AES key, must be base64 encoded before sending, and the public key token ID must be included in the request.",
"consumes": [
"application/json"
],
Expand Down
18 changes: 9 additions & 9 deletions src/api/rest/docs/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3220,13 +3220,14 @@ definitions:
type: object
info:
contact:
email: contact-to-cloud-barista@googlegroups.com
name: API Support
url: http://cloud-barista.github.io
description: CB-Tumblebug REST API
url: https://github.com/cloud-barista/cb-tumblebug/issues/new/choose
description: CB-Tumblebug is an open source system for managing multi-cloud infrastructure
consisting of resources from multiple cloud service providers. (Cloud-Barista)
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
termsOfService: https://github.com/cloud-barista/cb-tumblebug/blob/main/README.md
title: CB-Tumblebug REST API
version: latest
paths:
Expand Down Expand Up @@ -3590,12 +3591,11 @@ paths:
consumes:
- application/json
description: This API registers credential information using hybrid encryption.
1. First, compress and encrypt sensitive data using a client generated AES
with a 256-bit key. 2. Then, encrypt the AES key using an RSA public key obtained
from `GET /credential/publicKey`. 3. RSA encryption uses a 4096-bit key with
OAEP padding and SHA-256 as the hash function. Ensure that all values are
base64 encoded before sending them in the request. The public key token ID
must be included in the request to allow the server to decrypt the data.
The process involves compressing and encrypting sensitive data with AES-256,
encrypting the AES key with a 4096-bit RSA public key (retrieved via `GET
/credential/publicKey`), and using OAEP padding with SHA-256. All values,
including the AES key, must be base64 encoded before sending, and the public
key token ID must be included in the request.
operationId: RegisterCredential
parameters:
- description: Credential request info
Expand Down

0 comments on commit 28217a8

Please sign in to comment.