feat: API specs update for version 1.9.x#53
Conversation
Greptile SummaryThis PR adds 68 new code example files for two new database service types — Confidence Score: 5/5Safe to merge; all findings are P2 style/advisory notes with no blocking defects. The only issues are a tab/space indentation inconsistency in one example file and an advisory note to confirm the specs/1.9.x/open-api3-1.9.x-console.json (verify Important Files Changed
Reviews (1): Last reviewed commit: "chore: update API specs and SDK examples" | Re-trigger Greptile |
| { | ||
| "action": "create", | ||
| "databaseId": "<DATABASE_ID>", | ||
| "collectionId": "<COLLECTION_ID>", | ||
| "documentId": "<DOCUMENT_ID>", | ||
| "data": { | ||
| "name": "Walter O'Brien" | ||
| } | ||
| } | ||
| ] // optional |
There was a problem hiding this comment.
Mixed tab/space indentation in
operations array
Lines 13–22 use tab characters (\t) for indentation while the rest of the file uses 4-space indentation. This will render inconsistently across editors and markdown viewers, and breaks the visual alignment with the surrounding code.
| { | |
| "action": "create", | |
| "databaseId": "<DATABASE_ID>", | |
| "collectionId": "<COLLECTION_ID>", | |
| "documentId": "<DOCUMENT_ID>", | |
| "data": { | |
| "name": "Walter O'Brien" | |
| } | |
| } | |
| ] // optional | |
| operations: [ | |
| { | |
| "action": "create", | |
| "databaseId": "<DATABASE_ID>", | |
| "collectionId": "<COLLECTION_ID>", | |
| "documentId": "<DOCUMENT_ID>", | |
| "data": { | |
| "name": "Walter O'Brien" | |
| } | |
| } | |
| ] // optional |
| "$ref": "#\/components\/schemas\/providerRepositoryFramework" | ||
| }, | ||
| "x-example": "" | ||
| }, | ||
| "type": { | ||
| "type": "string", | ||
| "description": "Provider repository list type.", | ||
| "x-example": "framework" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "total", | ||
| "frameworkProviderRepositories" | ||
| "frameworkProviderRepositories", | ||
| "type" | ||
| ], | ||
| "example": { | ||
| "total": 5, | ||
| "frameworkProviderRepositories": "" | ||
| "frameworkProviderRepositories": "", | ||
| "type": "framework" | ||
| } | ||
| }, | ||
| "providerRepositoryRuntimeList": { |
There was a problem hiding this comment.
type added as required — breaking schema change
type is added to the required array for both providerRepositoryFrameworkList and providerRepositoryRuntimeList. Any existing API client that constructs or validates these objects without the type field will now fail schema validation. If the backend already returns type in 1.9.x responses this is fine, but it's worth confirming the server-side change ships simultaneously to avoid a mismatch between spec and runtime for consumers on the 1.8.x → 1.9.x transition.
This PR contains API specification updates for version 1.9.x.