feat:Update Anthropic API OpenAPI spec for message batch management and models #96
Conversation
WalkthroughThe pull request introduces updates to the Anthropic API's OpenAPI specification, focusing on enhancing message batch management and model information retrieval. A new Changes
Sequence DiagramsequenceDiagram
participant Client
participant AnthropicAPI
Client->>AnthropicAPI: DELETE /v1/messages/batches/{message_batch_id}
AnthropicAPI-->>Client: DeleteMessageBatchResponse
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
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (38)
src/libs/Anthropic/Generated/Anthropic.AnthropicClient.BetaModelsGet.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.AnthropicClient.BetaModelsList.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.AnthropicClient.ModelsGet.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.AnthropicClient.ModelsList.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.IAnthropicClient.BetaModelsGet.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.IAnthropicClient.BetaModelsList.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.IAnthropicClient.ModelsGet.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.IAnthropicClient.ModelsList.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.IMessageBatchesClient.BetaMessageBatchesDelete.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.IMessageBatchesClient.MessageBatchesDelete.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.MessageBatchesClient.BetaMessageBatchesDelete.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.MessageBatchesClient.MessageBatchesDelete.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.BetaDeleteMessageBatchResponse.Json.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.BetaDeleteMessageBatchResponse.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.BetaDeleteMessageBatchResponseType.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.BetaListResponseModelInfo.Json.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.BetaListResponseModelInfo.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.BetaModelInfo.Json.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.BetaModelInfo.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.BetaModelInfoType.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.DeleteMessageBatchResponse.Json.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.DeleteMessageBatchResponse.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.DeleteMessageBatchResponseType.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.ListResponseModelInfo.Json.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.ListResponseModelInfo.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.ModelInfo.Json.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.ModelInfo.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/Anthropic.Models.ModelInfoType.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/JsonConverters.BetaDeleteMessageBatchResponseType.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/JsonConverters.BetaDeleteMessageBatchResponseTypeNullable.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/JsonConverters.BetaModelInfoType.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/JsonConverters.BetaModelInfoTypeNullable.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/JsonConverters.DeleteMessageBatchResponseType.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/JsonConverters.DeleteMessageBatchResponseTypeNullable.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/JsonConverters.ModelInfoType.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/JsonConverters.ModelInfoTypeNullable.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/JsonSerializerContext.g.csis excluded by!**/generated/**src/libs/Anthropic/Generated/JsonSerializerContextTypes.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/Anthropic/openapi.yaml(18 hunks)
🔇 Additional comments (4)
src/libs/Anthropic/openapi.yaml (4)
309-350: LGTM: Well-structured message batch deletion endpoint
The new deletion endpoint is properly defined with:
- Clear path parameters and authentication headers
- Consistent error response handling
- Proper documentation of the endpoint's behavior
126-126: LGTM: Model response schema updates improve type safety
The schema changes from ModelResponse to ModelInfo and ListResponse_ModelResponse_ to ListResponse_ModelInfo_ provide better type consistency across the API.
Also applies to: 167-167, 567-567, 608-608
1449-1450: LGTM: Added appropriate batch size constraints
The addition of maxItems: 10000 and minItems: 1 for batch requests provides clear boundaries for API usage and helps prevent abuse.
Also applies to: 2962-2963
1559-1577: LGTM: Well-defined deletion response schemas
The DeleteMessageBatchResponse and BetaDeleteMessageBatchResponse schemas are properly defined with:
- Required fields for id and type
- Clear type discrimination
- Consistent structure between regular and beta versions
Also applies to: 3068-3086
| tags: | ||
| - Message Batches | ||
| summary: Delete a Message Batch | ||
| description: 'This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the `results_url` field in the response.' |
There was a problem hiding this comment.
Description needs to be updated for delete endpoint
The current description appears to be copied from the retrieve endpoint and doesn't accurately describe the delete operation's behavior.
- description: 'This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the `results_url` field in the response.'
+ description: 'This endpoint allows you to delete a Message Batch. The operation is idempotent - repeated deletion requests for the same batch ID will return 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.
| description: 'This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the `results_url` field in the response.' | |
| description: 'This endpoint allows you to delete a Message Batch. The operation is idempotent - repeated deletion requests for the same batch ID will return success.' |
| tags: | ||
| - Message Batches | ||
| summary: Delete a Message Batch | ||
| description: 'This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the `results_url` field in the response.' |
There was a problem hiding this comment.
Description needs to be updated for beta delete endpoint
The same description issue exists in the beta version of the delete endpoint.
- description: 'This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the `results_url` field in the response.'
+ description: 'This endpoint allows you to delete a Message Batch. The operation is idempotent - repeated deletion requests for the same batch ID will return 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.
| description: 'This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the `results_url` field in the response.' | |
| description: 'This endpoint allows you to delete a Message Batch. The operation is idempotent - repeated deletion requests for the same batch ID will return success.' |
Summary by CodeRabbit
New Features
deleteoperation for removing specific message batches.DeleteMessageBatchResponse.Improvements
Schema Updates
requestsarray inCreateMessageBatchParamsand introducedBetaCreateMessageBatchParamswith similar constraints.