feat:Add /studio/v1/secrets endpoint for managing secrets in AI21 Studio API
#78
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThe changes introduce a new endpoint Changes
Possibly related PRs
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
coderabbitai
bot
changed the title
/studio/v1/secrets endpoint for managing secrets in AI21 Studio API
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (16)
src/libs/AI21/Generated/AI21.Ai21Api.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.IAi21Api.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ISecretsClient.V1SecretStorage.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ISecretsClient.V1SecretStorage2.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ISecretsClient.V1SecretStorage3.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ISecretsClient.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1SecretStorageResponse.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1SecretStorageResponse.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1SecretStorageResponse2.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1SecretStorageResponse2.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1SecretStorageResponse3.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1SecretStorageResponse3.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.SecretsClient.V1SecretStorage.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.SecretsClient.V1SecretStorage2.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.SecretsClient.V1SecretStorage3.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.SecretsClient.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/AI21/openapi.yaml(1 hunks)
Comment on lines
+395
to
+424
| delete: | ||
| tags: | ||
| - Secrets | ||
| summary: Delete Secret | ||
| operationId: v1_secret_storage | ||
| parameters: | ||
| - name: secret_name | ||
| in: query | ||
| required: true | ||
| schema: | ||
| title: Secret Name | ||
| type: string | ||
| - name: request_start_time | ||
| in: query | ||
| schema: | ||
| title: Request Start Time | ||
| type: integer | ||
| default: '1730898900272' | ||
| responses: | ||
| '200': | ||
| description: Successful Response | ||
| content: | ||
| application/json: | ||
| schema: { } | ||
| '422': | ||
| description: Validation Error | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/HTTPValidationError' |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve DELETE operation design
The current DELETE operation design can be improved:
- Resource identifier (secret_name) should be in the path, not query
- Missing appropriate status codes for different scenarios
Implement these improvements:
- /studio/v1/secrets:
+ /studio/v1/secrets/{secret_name}:
delete:
tags:
- Secrets
summary: Delete Secret
operationId: v1_secret_storage
parameters:
- - name: secret_name
- in: query
+ - name: secret_name
+ in: path
required: true
schema:
title: Secret Name
type: string
responses:
'200':
description: Successful Response
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - status
+ properties:
+ status:
+ type: string
+ enum: [success]
+ '404':
+ description: Secret not found
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - error
+ properties:
+ error:
+ type: string
+ enum: [secret_not_found]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| delete: | |
| tags: | |
| - Secrets | |
| summary: Delete Secret | |
| operationId: v1_secret_storage | |
| parameters: | |
| - name: secret_name | |
| in: query | |
| required: true | |
| schema: | |
| title: Secret Name | |
| type: string | |
| - name: request_start_time | |
| in: query | |
| schema: | |
| title: Request Start Time | |
| type: integer | |
| default: '1730898900272' | |
| responses: | |
| '200': | |
| description: Successful Response | |
| content: | |
| application/json: | |
| schema: { } | |
| '422': | |
| description: Validation Error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/HTTPValidationError' | |
| delete: | |
| tags: | |
| - Secrets | |
| summary: Delete Secret | |
| operationId: v1_secret_storage | |
| parameters: | |
| - name: secret_name | |
| in: path | |
| required: true | |
| schema: | |
| title: Secret Name | |
| type: string | |
| - name: request_start_time | |
| in: query | |
| schema: | |
| title: Request Start Time | |
| type: integer | |
| default: '1730898900272' | |
| responses: | |
| '200': | |
| description: Successful Response | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| required: | |
| - status | |
| properties: | |
| status: | |
| type: string | |
| enum: [success] | |
| '404': | |
| description: Secret not found | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| required: | |
| - error | |
| properties: | |
| error: | |
| type: string | |
| enum: [secret_not_found] | |
| '422': | |
| description: Validation Error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/HTTPValidationError' |
Comment on lines
+359
to
+394
| post: | ||
| tags: | ||
| - Secrets | ||
| summary: Save Secret | ||
| operationId: v1_secret_storage | ||
| parameters: | ||
| - name: secret_name | ||
| in: query | ||
| required: true | ||
| schema: | ||
| title: Secret Name | ||
| type: string | ||
| - name: secret_value | ||
| in: query | ||
| required: true | ||
| schema: | ||
| title: Secret Value | ||
| type: string | ||
| - name: request_start_time | ||
| in: query | ||
| schema: | ||
| title: Request Start Time | ||
| type: integer | ||
| default: '1730898900272' | ||
| responses: | ||
| '200': | ||
| description: Successful Response | ||
| content: | ||
| application/json: | ||
| schema: { } | ||
| '422': | ||
| description: Validation Error | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/HTTPValidationError' |
There was a problem hiding this comment.
Security issues in POST operation design
Critical security concerns in the secret creation endpoint:
- Secret values are exposed in query parameters, which:
- Appear in server logs
- Are visible in browser history
- May be cached by proxies
- Missing validation rules for secret names and values
Implement these security improvements:
post:
tags:
- Secrets
summary: Save Secret
operationId: v1_secret_storage
- parameters:
- - name: secret_name
- in: query
- required: true
- schema:
- title: Secret Name
- type: string
- - name: secret_value
- in: query
- required: true
- schema:
- title: Secret Value
- type: string
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - name
+ - value
+ properties:
+ name:
+ type: string
+ pattern: ^[a-zA-Z][a-zA-Z0-9_-]{1,64}$
+ description: Secret name must start with a letter and contain only alphanumeric characters, underscores, and hyphens
+ value:
+ type: string
+ maxLength: 4096
+ description: Secret value with maximum length of 4KB
+ description:
+ type: string
+ maxLength: 1024
+ description: Optional description of the secret📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| post: | |
| tags: | |
| - Secrets | |
| summary: Save Secret | |
| operationId: v1_secret_storage | |
| parameters: | |
| - name: secret_name | |
| in: query | |
| required: true | |
| schema: | |
| title: Secret Name | |
| type: string | |
| - name: secret_value | |
| in: query | |
| required: true | |
| schema: | |
| title: Secret Value | |
| type: string | |
| - name: request_start_time | |
| in: query | |
| schema: | |
| title: Request Start Time | |
| type: integer | |
| default: '1730898900272' | |
| responses: | |
| '200': | |
| description: Successful Response | |
| content: | |
| application/json: | |
| schema: { } | |
| '422': | |
| description: Validation Error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/HTTPValidationError' | |
| post: | |
| tags: | |
| - Secrets | |
| summary: Save Secret | |
| operationId: v1_secret_storage | |
| requestBody: | |
| required: true | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| required: | |
| - name | |
| - value | |
| properties: | |
| name: | |
| type: string | |
| pattern: ^[a-zA-Z][a-zA-Z0-9_-]{1,64}$ | |
| description: Secret name must start with a letter and contain only alphanumeric characters, underscores, and hyphens | |
| value: | |
| type: string | |
| maxLength: 4096 | |
| description: Secret value with maximum length of 4KB | |
| description: | |
| type: string | |
| maxLength: 1024 | |
| description: Optional description of the secret | |
| responses: | |
| '200': | |
| description: Successful Response | |
| content: | |
| application/json: | |
| schema: { } | |
| '422': | |
| description: Validation Error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/HTTPValidationError' |
Comment on lines
+335
to
+358
| get: | ||
| tags: | ||
| - Secrets | ||
| summary: Get Secret List | ||
| operationId: v1_secret_storage | ||
| parameters: | ||
| - name: request_start_time | ||
| in: query | ||
| schema: | ||
| title: Request Start Time | ||
| type: integer | ||
| default: '1730898900272' | ||
| responses: | ||
| '200': | ||
| description: Successful Response | ||
| content: | ||
| application/json: | ||
| schema: { } | ||
| '422': | ||
| description: Validation Error | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/HTTPValidationError' |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance GET operation with pagination and filtering
The GET operation for listing secrets lacks essential features for managing large sets of secrets:
- No pagination support
- No filtering capabilities
- No sorting options
Add pagination and filtering parameters:
get:
tags:
- Secrets
summary: Get Secret List
operationId: v1_secret_storage
parameters:
- name: request_start_time
in: query
schema:
title: Request Start Time
type: integer
default: '1730898900272'
+ - name: limit
+ in: query
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 100
+ default: 20
+ description: Maximum number of secrets to return
+ - name: offset
+ in: query
+ schema:
+ type: integer
+ minimum: 0
+ default: 0
+ description: Number of secrets to skip
+ - name: name_prefix
+ in: query
+ schema:
+ type: string
+ description: Filter secrets by name prefix
+ - name: sort
+ in: query
+ schema:
+ type: string
+ enum: [name_asc, name_desc, created_at_asc, created_at_desc]
+ default: name_asc📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| get: | |
| tags: | |
| - Secrets | |
| summary: Get Secret List | |
| operationId: v1_secret_storage | |
| parameters: | |
| - name: request_start_time | |
| in: query | |
| schema: | |
| title: Request Start Time | |
| type: integer | |
| default: '1730898900272' | |
| responses: | |
| '200': | |
| description: Successful Response | |
| content: | |
| application/json: | |
| schema: { } | |
| '422': | |
| description: Validation Error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/HTTPValidationError' | |
| get: | |
| tags: | |
| - Secrets | |
| summary: Get Secret List | |
| operationId: v1_secret_storage | |
| parameters: | |
| - name: request_start_time | |
| in: query | |
| schema: | |
| title: Request Start Time | |
| type: integer | |
| default: '1730898900272' | |
| - name: limit | |
| in: query | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 100 | |
| default: 20 | |
| description: Maximum number of secrets to return | |
| - name: offset | |
| in: query | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| description: Number of secrets to skip | |
| - name: name_prefix | |
| in: query | |
| schema: | |
| type: string | |
| description: Filter secrets by name prefix | |
| - name: sort | |
| in: query | |
| schema: | |
| type: string | |
| enum: [name_asc, name_desc, created_at_asc, created_at_desc] | |
| default: name_asc | |
| responses: | |
| '200': | |
| description: Successful Response | |
| content: | |
| application/json: | |
| schema: { } | |
| '422': | |
| description: Validation Error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/HTTPValidationError' |
Comment on lines
+334
to
+424
| /studio/v1/secrets: | ||
| get: | ||
| tags: | ||
| - Secrets | ||
| summary: Get Secret List | ||
| operationId: v1_secret_storage | ||
| parameters: | ||
| - name: request_start_time | ||
| in: query | ||
| schema: | ||
| title: Request Start Time | ||
| type: integer | ||
| default: '1730898900272' | ||
| responses: | ||
| '200': | ||
| description: Successful Response | ||
| content: | ||
| application/json: | ||
| schema: { } | ||
| '422': | ||
| description: Validation Error | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/HTTPValidationError' | ||
| post: | ||
| tags: | ||
| - Secrets | ||
| summary: Save Secret | ||
| operationId: v1_secret_storage | ||
| parameters: | ||
| - name: secret_name | ||
| in: query | ||
| required: true | ||
| schema: | ||
| title: Secret Name | ||
| type: string | ||
| - name: secret_value | ||
| in: query | ||
| required: true | ||
| schema: | ||
| title: Secret Value | ||
| type: string | ||
| - name: request_start_time | ||
| in: query | ||
| schema: | ||
| title: Request Start Time | ||
| type: integer | ||
| default: '1730898900272' | ||
| responses: | ||
| '200': | ||
| description: Successful Response | ||
| content: | ||
| application/json: | ||
| schema: { } | ||
| '422': | ||
| description: Validation Error | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/HTTPValidationError' | ||
| delete: | ||
| tags: | ||
| - Secrets | ||
| summary: Delete Secret | ||
| operationId: v1_secret_storage | ||
| parameters: | ||
| - name: secret_name | ||
| in: query | ||
| required: true | ||
| schema: | ||
| title: Secret Name | ||
| type: string | ||
| - name: request_start_time | ||
| in: query | ||
| schema: | ||
| title: Request Start Time | ||
| type: integer | ||
| default: '1730898900272' | ||
| responses: | ||
| '200': | ||
| description: Successful Response | ||
| content: | ||
| application/json: | ||
| schema: { } | ||
| '422': | ||
| description: Validation Error | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/HTTPValidationError' |
There was a problem hiding this comment.
Critical issues in the secrets management endpoint specification
Several issues need to be addressed in the secrets management endpoint:
- Using the same
operationId('v1_secret_storage') for different operations will cause issues with code generation tools. Each operation should have a unique identifier. - Success responses are defined with empty schemas (
schema: {}), which could lead to inconsistent implementations. - Missing operation descriptions and examples make the API harder to understand and use.
Apply these changes to improve the specification:
/studio/v1/secrets:
get:
tags:
- Secrets
summary: Get Secret List
- operationId: v1_secret_storage
+ operationId: v1_list_secrets
+ description: Retrieve a list of secret names available in the organization.
# ... parameters ...
responses:
'200':
description: Successful Response
content:
application/json:
schema:
+ type: object
+ required:
+ - secrets
+ properties:
+ secrets:
+ type: array
+ items:
+ type: string
+ description: List of secret names
post:
tags:
- Secrets
summary: Save Secret
- operationId: v1_secret_storage
+ operationId: v1_create_secret
+ description: Create or update a secret with the specified name and value.
# ... parameters ...
responses:
'200':
description: Successful Response
content:
application/json:
schema:
+ type: object
+ required:
+ - status
+ properties:
+ status:
+ type: string
+ enum: [success]
delete:
tags:
- Secrets
summary: Delete Secret
- operationId: v1_secret_storage
+ operationId: v1_delete_secret
+ description: Delete a secret by its name.
# ... parameters ...
responses:
'200':
description: Successful Response
content:
application/json:
schema:
+ type: object
+ required:
+ - status
+ properties:
+ status:
+ type: string
+ enum: [success]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| /studio/v1/secrets: | |
| get: | |
| tags: | |
| - Secrets | |
| summary: Get Secret List | |
| operationId: v1_secret_storage | |
| parameters: | |
| - name: request_start_time | |
| in: query | |
| schema: | |
| title: Request Start Time | |
| type: integer | |
| default: '1730898900272' | |
| responses: | |
| '200': | |
| description: Successful Response | |
| content: | |
| application/json: | |
| schema: { } | |
| '422': | |
| description: Validation Error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/HTTPValidationError' | |
| post: | |
| tags: | |
| - Secrets | |
| summary: Save Secret | |
| operationId: v1_secret_storage | |
| parameters: | |
| - name: secret_name | |
| in: query | |
| required: true | |
| schema: | |
| title: Secret Name | |
| type: string | |
| - name: secret_value | |
| in: query | |
| required: true | |
| schema: | |
| title: Secret Value | |
| type: string | |
| - name: request_start_time | |
| in: query | |
| schema: | |
| title: Request Start Time | |
| type: integer | |
| default: '1730898900272' | |
| responses: | |
| '200': | |
| description: Successful Response | |
| content: | |
| application/json: | |
| schema: { } | |
| '422': | |
| description: Validation Error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/HTTPValidationError' | |
| delete: | |
| tags: | |
| - Secrets | |
| summary: Delete Secret | |
| operationId: v1_secret_storage | |
| parameters: | |
| - name: secret_name | |
| in: query | |
| required: true | |
| schema: | |
| title: Secret Name | |
| type: string | |
| - name: request_start_time | |
| in: query | |
| schema: | |
| title: Request Start Time | |
| type: integer | |
| default: '1730898900272' | |
| responses: | |
| '200': | |
| description: Successful Response | |
| content: | |
| application/json: | |
| schema: { } | |
| '422': | |
| description: Validation Error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/HTTPValidationError' | |
| /studio/v1/secrets: | |
| get: | |
| tags: | |
| - Secrets | |
| summary: Get Secret List | |
| operationId: v1_list_secrets | |
| description: Retrieve a list of secret names available in the organization. | |
| parameters: | |
| - name: request_start_time | |
| in: query | |
| schema: | |
| title: Request Start Time | |
| type: integer | |
| default: '1730898900272' | |
| responses: | |
| '200': | |
| description: Successful Response | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| required: | |
| - secrets | |
| properties: | |
| secrets: | |
| type: array | |
| items: | |
| type: string | |
| description: List of secret names | |
| '422': | |
| description: Validation Error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/HTTPValidationError' | |
| post: | |
| tags: | |
| - Secrets | |
| summary: Save Secret | |
| operationId: v1_create_secret | |
| description: Create or update a secret with the specified name and value. | |
| parameters: | |
| - name: secret_name | |
| in: query | |
| required: true | |
| schema: | |
| title: Secret Name | |
| type: string | |
| - name: secret_value | |
| in: query | |
| required: true | |
| schema: | |
| title: Secret Value | |
| type: string | |
| - name: request_start_time | |
| in: query | |
| schema: | |
| title: Request Start Time | |
| type: integer | |
| default: '1730898900272' | |
| responses: | |
| '200': | |
| description: Successful Response | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| required: | |
| - status | |
| properties: | |
| status: | |
| type: string | |
| enum: [success] | |
| '422': | |
| description: Validation Error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/HTTPValidationError' | |
| delete: | |
| tags: | |
| - Secrets | |
| summary: Delete Secret | |
| operationId: v1_delete_secret | |
| description: Delete a secret by its name. | |
| parameters: | |
| - name: secret_name | |
| in: query | |
| required: true | |
| schema: | |
| title: Secret Name | |
| type: string | |
| - name: request_start_time | |
| in: query | |
| schema: | |
| title: Request Start Time | |
| type: integer | |
| default: '1730898900272' | |
| responses: | |
| '200': | |
| description: Successful Response | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| required: | |
| - status | |
| properties: | |
| status: | |
| type: string | |
| enum: [success] | |
| '422': | |
| description: Validation Error | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/HTTPValidationError' |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
New Features
GET,POST, andDELETErequests to handle secret management tasks effectively.Bug Fixes