Feature/update api example outputs #2547
Merged
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
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.
Pull Request Type
Relevant Issues
resolves #2546
What is in this change?
This PR updates the documentation for the /v1/workspace/{slug} endpoint to reflect the actual API response, which is an array of workspaces, rather than a single workspace object.
Additional Information
This change is related to a docus improvement report #2546 where the inconsistent API response was identified. The updated documentation should help clarify the expected response for developers using the API.
Developer Validations
I've ran
node init.jsat/workspaces/anything-llm/server/swaggerlocation to generate theopenapi.jsonfile.[ ] I ran yarn lint from the root of the repo & committed changes
[x] Relevant documentation has been updated
[x] I have tested my code functionality
[ ] Docker build succeeds locally