Add API endpoint for updating pin status #1449
Merged
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 #1051
What is in this change?
This pull request introduces a new API endpoint to update the pin status of a document within a workspace.
Key Changes:
New Endpoint:
/workspace/:slug/update-pinPOSTEndpoint Details:
slug: Unique identifier of the workspace (in path).Authorization: Token (in header).{ "docPath": "custom-documents/my-pdf.pdf-hash.json", "pinStatus": true }200 OK: Pin status updated successfully.404 Not Found: Document not found.500 Internal Server Error: Internal server error.Documentation:
openapi.jsonfor easy reference in Swagger UI athttp://localhost:3001/api-docs.These changes enhance document management by allowing users to efficiently update pin statuses via the API.
Developer Validations
yarn lintfrom the root of the repo & committed changes