Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the tutorials upload documentation to clarify the file splitting command and improve the presentation of API request and response examples, including new instructions on using the upload UUID.
- Clarifies the explanation for the
splitcommand by explicitly stating the segment size requirement. - Updates and formats the Create Upload API endpoint request body as a JSON code block.
- Adds a new section explaining how to use the
upload_idin various API requests with detailed examples.
sandeep-at-procore
changed the title
greenny
reviewed
Apr 9, 2025
dmytro-spivakov
approved these changes
Apr 9, 2025
sandeep-at-procore
approved these changes
Apr 9, 2025
greenny
approved these changes
Apr 9, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
JIRA PPC2-4815
Update API documentation to reflect use of upload_id.
This PR updates the API documentation to fully document the upload_id approach for file uploads.
This aligns with our broader effort to migrate away from NFS-based file uploads to the more performant, reliable S3 direct upload methodology.
Changes
upload_idwith various endpoints (Action Plans, Meeting Topics)upload_idin API requests and responsesupload_idapproachFiles Changed
upload_idconcept and implementationScreenshots.