Document the copy_all API endpoint for reference files (FLCRM-19499)#39
Document the copy_all API endpoint for reference files (FLCRM-19499)#39
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds OpenAPI and documentation entries for a new POST /v2/attachments/copy_all endpoint that copies reference file attachments from one form to another, including stated limits (100 files / form, 1GB / form).
Changes:
- Added
AttachmentCopyAllRequest/AttachmentCopyAllResponseschemas to the OpenAPI spec. - Added the
POST /v2/attachments/copy_allpath definition to the OpenAPI spec. - Added a new Attachments doc page and included it in the Attachments docs ordering.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| reference/rest-api.json | Defines the new copy_all endpoint and its request/response schemas. |
| reference/ATTACHMENTS/copy-all-attachments.md | Adds a documentation page for the new endpoint and its limits. |
| reference/ATTACHMENTS/_order.yaml | Adds the new doc page to the Attachments navigation order. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
nehilor
changed the title
- Add 400 Bad Request response to copy_all OpenAPI operation - Add 401 response example payload for consistency - Normalize front matter quote style in copy-all-attachments.md
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Change 401 description from 'Unauthorized' to '401' for consistency - Add deprecated: false to copy_all endpoint - Align with Attachments endpoints patterns
Description
This PR documents the new
copy_allAPI endpoint for copying reference files between forms, as requested in FLCRM-19499.Changes:
AttachmentCopyAllRequestandAttachmentCopyAllResponseschemas torest-api.json.POST /v2/attachments/copy_allendpoint inrest-api.json.copy-all-attachments.mddetails the endpoint and its current limits (100 files / form, 1GB / form)._order.yamlto include the new endpoint in the Attachments API documentation.Limits: