API 2.0 spec#222
Merged
Merged
Conversation
Redocly preview |
torcolvin
reviewed
Jun 20, 2025
| blob objects and values are the urls from which to obtain the blob files. | ||
| type: object | ||
| additionalProperties: {} | ||
| example: {'photo.thumbnail': 's1.jpg'} |
Collaborator
There was a problem hiding this comment.
is this correct if this is a url? s1.jpg doesn't look like a url to me.
Member
There was a problem hiding this comment.
This should be corrected to the same style as the dataset property below
Contributor
Author
There was a problem hiding this comment.
Yes. I missed one. Will fix.
Contributor
There was a problem hiding this comment.
Pull Request Overview
The PR updates the OpenAPI spec to version 2.0.0, deprecates the old dataset_version field, and switches dataset and blob references to URL-based inputs.
- Bump spec to 2.0.0 and note breaking change in
CBLTest-API-Version - Deprecate
dataset_versionand changedatasetto accept URLs (including unzipping.zip) - Update
updatedBlobsdescriptions, examples, and component schemas to use URLs
Comments suppressed due to low confidence (3)
spec/api/api.yaml:46
- The OpenAPI
info.versionfield should be updated to '2.0.0' to match the new Changes section and ensure spec version consistency.
```
spec/api/api.yaml:338
- [nitpick] Consider capitalizing 'URLs' for consistency with standard terminology (e.g., 'the URLs from which to retrieve the blobs').
the urls from which to retrieve the blobs to be put at the key path location.
spec/api/api.yaml:346
- [nitpick] Replace the colon after 'refers' with a comma and clarify, e.g., '...blob file to which the blob URL refers, using the value associated with the keypath in the request.'
The blob object is created from the content of the blob file to which the blob url refers: the value associated
torcolvin
approved these changes
Jun 23, 2025
barkha06
pushed a commit
that referenced
this pull request
Jul 1, 2025
This file contains hidden or 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
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.
Replace dataset_version with dataset and blob urls