-
Notifications
You must be signed in to change notification settings - Fork 587
feat: copy encryption endpoints (vibed hard on this one) #3710
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -94,6 +94,57 @@ components: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: Processing status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| example: "OK" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| InternalVaultDecryptRequestBody: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| required: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - keyring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - encrypted | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| properties: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| keyring: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: The keyring identifier used for encryption | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| example: "user_data" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| encrypted: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: Base64 encoded encrypted data to decrypt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| example: "eyJhbGdvcml0aG0iOiJBRVMtMjU2LUdDTSIsIm5vbmNlIjoi..." | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+97
to
+110
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧹 Nitpick (assertive) Mark base-64 blob fields with an explicit OpenAPI uses - encrypted:
- type: string
+ encrypted:
+ type: string
+ format: byte(Do the same for any other 📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| InternalVaultDecryptResponseBody: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| required: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - plaintext | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| properties: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plaintext: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: The decrypted plaintext data | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| example: "sensitive information" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| InternalVaultEncryptRequestBody: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| required: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - keyring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - data | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| properties: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| keyring: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: The keyring identifier to use for encryption | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| example: "user_data" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| data: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: The plaintext data to encrypt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| example: "sensitive information" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| InternalVaultEncryptResponseBody: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| required: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - encrypted | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - keyId | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| properties: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| encrypted: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: Base64 encoded encrypted data | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| example: "eyJhbGdvcml0aG0iOiJBRVMtMjU2LUdDTSIsIm5vbmNlIjoi..." | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| keyId: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: The ID of the data encryption key used | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| example: "dek_12345" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+140
to
+147
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧹 Nitpick (assertive) Repeat the Same reasoning as above – generators and clients benefit from the correct semantic hint. - encrypted:
- type: string
+ encrypted:
+ type: string
+ format: byte📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| V2ApisCreateApiRequestBody: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| required: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
@@ -3149,6 +3200,82 @@ paths: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - chproxy | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| x-excluded: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| x-speakeasy-ignore: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| /_internal/vault/decrypt: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| post: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: |- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Internal endpoint for decrypting data using the vault service. This endpoint is used internally by the API and should not be used by external clients. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| This endpoint bypasses normal authentication and validation as it's intended for internal use only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| operationId: internalVaultDecrypt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| requestBody: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| content: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| application/json: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| schema: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ref: '#/components/schemas/InternalVaultDecryptRequestBody' | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| required: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| responses: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "200": | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| content: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| application/json: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| schema: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ref: '#/components/schemas/InternalVaultDecryptResponseBody' | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: Data successfully decrypted | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "400": | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| content: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| application/json: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| schema: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ref: '#/components/schemas/BadRequestErrorResponse' | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: Invalid request body | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "500": | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| content: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| application/json: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| schema: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ref: '#/components/schemas/InternalServerErrorResponse' | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: Internal server error during decryption | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| security: [] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+3203
to
+3235
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Spec is missing 401 response & security scheme despite token enforcement. Handlers reject requests when the static vault token is absent or wrong, yet the spec declares security: []
+ responses:
+ "401":
+ description: Invalid or missing Vault auth token
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UnauthorizedErrorResponse'
+
+ security:
+ - VaultStaticToken: []Add a If the endpoint truly must stay undocumented, keep
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| summary: Internal vault decryption endpoint | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tags: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - _internal | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| x-excluded: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| x-speakeasy-ignore: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| /_internal/vault/encrypt: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| post: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: |- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Internal endpoint for encrypting data using the vault service. This endpoint is used internally by the API and should not be used by external clients. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| This endpoint bypasses normal authentication and validation as it's intended for internal use only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| operationId: internalVaultEncrypt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| requestBody: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| content: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| application/json: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| schema: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ref: '#/components/schemas/InternalVaultEncryptRequestBody' | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| required: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| responses: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "200": | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| content: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| application/json: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| schema: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ref: '#/components/schemas/InternalVaultEncryptResponseBody' | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: Data successfully encrypted | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "400": | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| content: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| application/json: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| schema: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ref: '#/components/schemas/BadRequestErrorResponse' | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: Invalid request body | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "500": | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| content: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| application/json: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| schema: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $ref: '#/components/schemas/InternalServerErrorResponse' | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: Internal server error during encryption | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| security: [] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| summary: Internal vault encryption endpoint | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+3242
to
+3274
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same 401 / security concern for the encryption endpoint. Apply the identical 401 response and 🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tags: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - _internal | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| x-excluded: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| x-speakeasy-ignore: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| /v2/apis.createApi: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| post: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,13 @@ | ||||||||||||||||||||||||||||
| type: object | ||||||||||||||||||||||||||||
| required: | ||||||||||||||||||||||||||||
| - keyring | ||||||||||||||||||||||||||||
| - encrypted | ||||||||||||||||||||||||||||
| properties: | ||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we just make this an array to support decrypting multiple data pieces? This would help with the listKeys endpoin to just do a single req |
||||||||||||||||||||||||||||
| keyring: | ||||||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||||||
| description: The keyring identifier used for encryption | ||||||||||||||||||||||||||||
| example: "user_data" | ||||||||||||||||||||||||||||
|
Comment on lines
+6
to
+9
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧹 Nitpick (assertive) Fix inconsistent keyring example and missing newline. The keyring example "user_data" is inconsistent with the encrypt schema, which states the keyring is "always the workspace id" with example "ws_123". Consider aligning the examples for consistency. keyring:
type: string
description: The keyring identifier used for encryption
- example: "user_data"
+ example: "ws_123"
encrypted:
type: string
description: Base64 encoded encrypted data to decrypt
- example: "eyJhbGdvcml0aG0iOiJBRVMtMjU2LUdDTSIsIm5vbmNlIjoi..."
+ example: "eyJhbGdvcml0aG0iOiJBRVMtMjU2LUdDTSIsIm5vbmNlIjoi..."
+📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||
| encrypted: | ||||||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||||||
| description: Base64 encoded encrypted data to decrypt | ||||||||||||||||||||||||||||
| example: "eyJhbGdvcml0aG0iOiJBRVMtMjU2LUdDTSIsIm5vbmNlIjoi..." | ||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| type: object | ||
| required: | ||
| - plaintext | ||
| properties: | ||
| plaintext: | ||
| type: string | ||
| description: The decrypted plaintext data | ||
| example: "sensitive information" | ||
|
Comment on lines
+1
to
+8
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add missing newline at end of file. The YAML file is missing a newline character at the end, which is flagged by YAMLlint. This is commonly required by YAML standards and many linters. properties:
plaintext:
type: string
description: The decrypted plaintext data
- example: "sensitive information"
+ example: "sensitive information"
+🧰 Tools🪛 YAMLlint (1.37.1)[error] 8-8: no new line character at the end of file (new-line-at-end-of-file) 🤖 Prompt for AI Agents |
||
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,37 @@ | ||||||||
| post: | ||||||||
| x-speakeasy-ignore: true | ||||||||
| x-excluded: true | ||||||||
| tags: | ||||||||
| - _internal | ||||||||
| security: [] | ||||||||
| operationId: internalVaultDecrypt | ||||||||
| summary: Internal vault decryption endpoint | ||||||||
| description: |- | ||||||||
| Internal endpoint for decrypting data using the vault service. This endpoint is used internally by the API and should not be used by external clients. | ||||||||
| This endpoint bypasses normal authentication and validation as it's intended for internal use only. | ||||||||
| requestBody: | ||||||||
| required: true | ||||||||
| content: | ||||||||
| application/json: | ||||||||
| schema: | ||||||||
| "$ref": "./InternalVaultDecryptRequestBody.yaml" | ||||||||
| responses: | ||||||||
| "200": | ||||||||
| content: | ||||||||
| application/json: | ||||||||
| schema: | ||||||||
| "$ref": "./InternalVaultDecryptResponseBody.yaml" | ||||||||
| description: Data successfully decrypted | ||||||||
| "400": | ||||||||
| content: | ||||||||
| application/json: | ||||||||
| schema: | ||||||||
| $ref: "../../../../error/BadRequestErrorResponse.yaml" | ||||||||
| description: Invalid request body | ||||||||
| "500": | ||||||||
| content: | ||||||||
| application/json: | ||||||||
| schema: | ||||||||
| $ref: "../../../../error/InternalServerErrorResponse.yaml" | ||||||||
| description: Internal server error during decryption | ||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧹 Nitpick (assertive) Add missing newline at end of file. Static analysis detected a missing newline character at the end of the file. - description: Internal server error during decryption
+ description: Internal server error during decryption
+📝 Committable suggestion
Suggested change
🧰 Tools🪛 YAMLlint (1.37.1)[error] 37-37: no new line character at the end of file (new-line-at-end-of-file) 🤖 Prompt for AI Agents |
||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| type: object | ||
| required: | ||
| - keyring | ||
| - data | ||
| properties: | ||
| keyring: | ||
| type: string | ||
| description: The keyring identifier to use for encryption. This is always the workspace id. | ||
| example: "ws_123" | ||
| data: | ||
| type: string | ||
| description: The plaintext data to encrypt | ||
| example: "sensitive information" |
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,13 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| required: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - encrypted | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - keyId | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| properties: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| encrypted: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: Base64 encoded encrypted data | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| example: "eyJhbGdvcml0aG0iOiJBRVMtMjU2LUdDTSIsIm5vbmNlIjoi..." | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| keyId: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description: The ID of the data encryption key used | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| example: "dek_12345" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+1
to
+13
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧹 Nitpick (assertive) Well-designed response schema with minor formatting fix needed. The schema correctly defines the essential properties for an encryption response - the encrypted data and key ID. The descriptions and examples are clear and helpful. keyId:
type: string
description: The ID of the data encryption key used
example: "dek_12345"
+📝 Committable suggestion
Suggested change
🧰 Tools🪛 YAMLlint (1.37.1)[error] 13-13: no new line character at the end of file (new-line-at-end-of-file) 🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Uh oh!
There was an error while loading. Please reload this page.