docs: Add OpenAPI documentation for Secret Attachments API #56
Conversation
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
- POST /secrets/{secret}/attachments (upload)
- GET /secrets/{secret}/attachments (list)
- GET /attachments/{attachment}/download (download)
- DELETE /attachments/{attachment} (delete)
- Added SecretAttachment schema
- Includes authentication, validation, and error responses
Related: #175
💡 Tip: Consider Using Draft PRsBenefits of opening PRs as drafts initially:
How to convert:
This is just a friendly reminder - feel free to continue as is! 😊 |
Copilot finished reviewing on behalf of
kevalyq
November 16, 2025 16:36
There was a problem hiding this comment.
Pull Request Overview
This PR adds OpenAPI 3.1 documentation for the Secret Attachments API, providing a contract for file attachment operations on secrets. The documentation covers the complete CRUD lifecycle for attachments including upload, list, download, and delete operations.
Key changes:
- Defines
SecretAttachmentschema with file metadata fields - Adds four new endpoints under the "Secret Attachments" tag
- Documents multipart/form-data file upload with binary format
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.
Description
Add OpenAPI 3.1 documentation for the Secret Attachments API (implemented in SecPal/api#177).
Related Issues
Changes
/api/v1/secrets/{secretId}/attachmentsendpoints (POST, GET)SecretAttachmentschemaChecklist
npm run lint)