feat:Update openapi.yaml with new endpoint and modified JSON schemas #114
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 in this pull request primarily involve modifications to the 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
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
src/libs/LangSmith/openapi.yaml (2)
Line range hint
10288-10449: Consider reducing schema duplication using composition.The AIMessage and AIMessageChunk schemas have been split into Input/Output variants, which improves type safety. However, there's significant duplication between these variants.
Consider using OpenAPI composition to reduce duplication:
# Base schema for common properties AIMessageBase: type: object required: - content properties: content: title: Content anyOf: - type: string - type: array items: anyOf: - type: string - type: object # ... other common properties # Input/Output specific schemas AIMessage-Input: allOf: - $ref: '#/components/schemas/AIMessageBase' - type: object # Input specific properties AIMessage-Output: allOf: - $ref: '#/components/schemas/AIMessageBase' - type: object # Output specific properties
15746-15815: Enhance schema documentation and extensibility.The PlaygroundPromptCanvas schemas are well-structured, but could benefit from some improvements:
- Enum values need descriptions
- Template format options are limited
- Reading levels might need localization support
Consider these enhancements:
reading_level: title: Reading Level enum: - child - teenager - college - phd type: string + description: Target audience reading comprehension level + x-enum-descriptions: + child: "Simple language for ages 7-12" + teenager: "Moderate complexity for ages 13-17" + college: "Advanced vocabulary for undergraduate level" + phd: "Technical/specialized language for expert level" template_format: title: Template Format enum: - f-string - mustache + - jinja2 + - handlebars type: string + description: Template syntax format for variable substitution
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (68)
src/libs/LangSmith/Generated/JsonConverters.AIMessageChunkInputType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.AIMessageChunkInputTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.AIMessageChunkOutputType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.AIMessageChunkOutputTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.AIMessageInputType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.AIMessageInputTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.AIMessageOutputType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.AIMessageOutputTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.MessagesItem.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.MessagesItem2.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlayGroundGraphMessageDiscriminatorType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasPayloadArtifactLength.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasPayloadArtifactLengthNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasPayloadMessageDiscriminatorType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasPayloadMessageDiscriminatorTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasPayloadReadingLevel.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasPayloadReadingLevelNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasPayloadTemplateFormat.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasPayloadTemplateFormatNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasResponseArtifactLength.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasResponseArtifactLengthNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasResponseMessageDiscriminatorType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasResponseMessageDiscriminatorTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasResponseReadingLevel.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasResponseReadingLevelNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonSerializerContext.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonSerializerContextTypes.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IPromptsClient.Canvas.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IPublicClient.GetToolDefJsonSchema.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkInput.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkInputAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkInputContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkInputResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkInputType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkOutput.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkOutputAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkOutputContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkOutputResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkOutputType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageInput.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageInputAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageInputContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageInputResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageInputType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageOutput.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageOutputAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageOutputContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageOutputResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageOutputType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.CanvasApiV1PromptsCanvasPostResponse.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.GetToolDefJsonSchemaApiV1PublicSchemasVersionTooldefJsonGetResponse.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.MessagesItem.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.MessagesItem2.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlayGroundGraphMessageDiscriminatorType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasPayload.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasPayloadArtifactLength.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasPayloadMessageDiscriminator.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasPayloadMessageDiscriminatorType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasPayloadReadingLevel.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasPayloadTemplateFormat.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasResponse.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasResponseArtifactLength.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasResponseMessageDiscriminator.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasResponseMessageDiscriminatorType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasResponseReadingLevel.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.PromptsClient.Canvas.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.PublicClient.GetToolDefJsonSchema.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
- src/libs/LangSmith/openapi.yaml (5 hunks)
🔇 Additional comments (1)
src/libs/LangSmith/openapi.yaml (1)
7415-7423: LGTM: Schema references updated correctly.The schema references have been properly updated to use the new PlaygroundPromptCanvas payload and response types.
Comment on lines
+5736
to
+5760
| '/api/v1/public/schemas/{version}/tooldef.json': | ||
| get: | ||
| tags: | ||
| - public | ||
| summary: Get Tool Def Json Schema | ||
| operationId: get_tool_def_json_schema_api_v1_public_schemas__version__tooldef_json_get | ||
| parameters: | ||
| - name: version | ||
| in: path | ||
| required: true | ||
| schema: | ||
| title: Version | ||
| type: string | ||
| 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.
Endpoint definition needs additional details.
The new tool definition endpoint has several areas that need attention:
- The response schema is empty (
schema: { }). - The version parameter lacks constraints or allowed values.
- Missing description of what constitutes a tool definition.
Consider adding these improvements:
schema:
title: Version
type: string
+ description: Version of the tool definition schema
+ enum: ["v1", "v2"] # Add supported versions
+ example: "v1"
responses:
'200':
description: Successful Response
content:
application/json:
- schema: { }
+ schema:
+ type: object
+ description: JSON Schema defining the structure of tool definitionsCommittable suggestion was skipped due to low confidence.
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
Changes