feat:Update OpenAPI specification with new endpoints for LangSmith API #165
Conversation
WalkthroughThe pull request introduces comprehensive updates to the LangSmith API's OpenAPI specification, significantly expanding the API's capabilities. The changes include new endpoints across multiple domains such as annotation queues, service accounts, custom charts, playground settings, model price maps, usage limits, TTL settings, prompts, feedback configurations, repositories, comments, and events. These additions provide more granular control and management functionalities within the LangSmith platform. Changes
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: 0
🧹 Nitpick comments (3)
src/libs/LangSmith/openapi.yaml (3)
Line range hint
1-7: Consider improving API versioning and server configurationA few suggestions to enhance the API configuration:
- Consider aligning the info version (0.1.0) with the API path version (/v1)
- Consider using server variables to support different environments (e.g., development, staging, production)
servers: - url: https://{environment}.smith.langchain.com variables: environment: default: api enum: - api # Production - api-staging # Staging - api-dev # Development
Line range hint
16000-16100: Consider enhancing batch operations error handlingFor batch operations like
/api/v1/runs/batch, consider adding:
- Structured error responses that indicate which items failed in the batch
- Support for partial success/failure scenarios
- Clear documentation of batch size limits and timeout behavior
Example enhancement:
responses: '200': description: Successful Response content: application/json: schema: type: object properties: succeeded: type: array items: type: string format: uuid failed: type: array items: type: object properties: id: type: string format: uuid error: type: string
Line range hint
1-16860: Consider enhancing schema documentationThe OpenAPI specification would benefit from:
- Adding more descriptive field descriptions using the
descriptionproperty- Documenting the implications of nullable fields
- Including examples for complex schema objects
Example enhancement:
TracerSession: description: | Represents a tracing session that groups related runs together. Sessions can be used for monitoring, debugging and analyzing runs. properties: trace_tier: description: | Determines how long the trace data is retained: - longlived: Retained for extended periods - shortlived: Retained for a shorter duration tenant_id: description: Unique identifier of the tenant owning this session
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
src/libs/LangSmith/Generated/LangSmith.Models.OrganizationConfig.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/LangSmith/openapi.yaml(1 hunks)
🔇 Additional comments (1)
src/libs/LangSmith/openapi.yaml (1)
16857-16860: New feature: Experiment Page v2 configuration addedThe configuration includes a new feature flag
enable_experiment_page_v2for controlling access to a new version of the experiment page.
Summary by CodeRabbit