feat(PPC2-7034): POC - add Unified Upload API tutorial behind LD flag#335
feat(PPC2-7034): POC - add Unified Upload API tutorial behind LD flag#335cynthiaxhe wants to merge 2 commits intomainfrom
Conversation
_data/navigation.yml
Outdated
| # - title: Unified Upload API Tutorial | ||
| # url: /tutorial-unified-pilot-uploads |
There was a problem hiding this comment.
question: should this be under document_management_integration? I wonder if we can place it in it’s own folder or under “Product Guides: Documents & Files" where the tutorial for Direct File Uploads currently lives?
question: what do you think about removing pilot from the url so that we don't have to come back to this page and update the url when the pilot phase is over and this is released to GA?
|
I think you will need to add a page that will be shown to users who do not have access to the unified uploads tutorial page if they try to navigate directly to it. See the document-management-integration/document_management_access.md file in this #325 |
| The Unified Upload API is a next-generation file upload service designed for tighter integration with the Document Management tool. | ||
| It provides a single, consistent upload path for Document Management workflows and supersedes the use of the legacy v1.1 `/uploads` endpoints for document management integrations. | ||
|
|
||
| > **Beta Feature** — The Unified Upload API is currently available to select partners. Access is controlled via the Document Management integration program. |
There was a problem hiding this comment.
suggestion: in the PRD we refer to the program as PDM API Pilot for File Uploads. We may want to verify whether to call it that here or refer to it as "integration program".
There was a problem hiding this comment.
Will replace this tutorial with a placeholder for POC. We will have a separate ticket for creating the tutorial.
|
|
||
| 1. **Initialize** — Create an upload record and receive pre-signed storage instructions. | ||
| 2. **Transfer** — PUT the binary file directly to the storage service using the pre-signed URL. | ||
| 3. **Associate** — Reference the upload UUID when creating or updating a Document Upload record. |
There was a problem hiding this comment.
suggestion: The draft technical guide for document management incorrectly states that upload UUID can be associated with document upload during creation/update. That's my mistake and the technical guide will be updated. The upload UUID can only be associated during document upload patch.
| Create a new upload by POSTing to the Unified Upload endpoint. | ||
|
|
||
| - **Request Method:** `POST` | ||
| - **Request URL:** `/rest/v2.0/companies/{company_id}/uploads` |
There was a problem hiding this comment.
question: document management is a project level tool and not a company level tool. Is it preferable to make the post to /rest/v2.0/projects/{project_id}/uploads or does it not matter?
should this be rest/v2.1/companies/{company_id}/projects/{project_id}/uploads
cynthiaxhe
changed the title
Add new tutorial page for the Unified Pilot API under the Document Management Integration section. The nav entry is commented out to keep it hidden on GitHub Pages; visibility on developers.procore.com is gated by the document-management-v2-api-visibility LaunchDarkly flag via the existing dev-portal integration. Made-with: Cursor
2 participants
Jira: https://procoretech.atlassian.net/browse/PPC2-7034
Proof of concept to publish unified upload API tutorial to dev portal for the pilot release.
Made-with: Cursor