docs(#126): Update Swagger for job status endpoint#133
Merged
Conversation
…b_id} - Add cloning status example - Add repository object to all response examples - Add created_at, updated_at timestamps - Add partial indexing example with max_files - Add 400 response for invalid job_id format - Improve 404 response example - Add descriptive summaries to each example - Expand description with status values and polling guidance
|
@DevanshuNEU is attempting to deploy a commit to the Dev's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
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
1 participant
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.
Swagger Documentation Update for #126
Updates OpenAPI documentation for
GET /playground/index/{job_id}endpoint.Added
cloningstatus example (was missing)repositoryobject in all response examplescreated_at,updated_attimestampspartial: true,max_files)400response for invalid job_id formatResponse Examples Now Include
queued- Job waiting to startcloning- Repository being downloadedprocessing- Regular indexing in progressprocessing_partial- Partial indexing (large repos)completed- Success with repo_idfailed- Error with detailsNo code logic changes - documentation only.
Related to #126 (already implemented, this just updates the docs)