Skip to content

PPC2-7113: Add Unified Upload API (v2.1) Tutorial#340

Open
ajaykumarprocore wants to merge 7 commits intomainfrom
PPC2-7113-unified-upload-tutorial
Open

PPC2-7113: Add Unified Upload API (v2.1) Tutorial#340
ajaykumarprocore wants to merge 7 commits intomainfrom
PPC2-7113-unified-upload-tutorial

Conversation

@ajaykumarprocore
Copy link

Summary

  • Adds a new tutorial page for the Unified Upload API (v2.1) at /tutorial-unified-uploads
  • Covers the unified three-step workflow (POST → PUT → PATCH) for both single-part and multi-part uploads
  • Includes curl examples with sample request/response bodies for all endpoints (POST, GET status, GET URL, GET part URL, PATCH)
  • Documents key constraints: 100 MB max part size, 10,000 max parts, URL expiration, ETag ordering
  • Adds v1.1 → v2.1 migration comparison table
  • Lists upcoming features (malware scan, checksum verification, extended analytics)
  • Adds navigation entry under "Product Guides: Documents & Files"

Test plan

  • Verify the tutorial page renders correctly via Jekyll (bundle exec jekyll serve)
  • Confirm navigation entry appears under "Documents & Files" section
  • Review curl examples for accuracy against the live v2.1 API
  • Verify all internal links resolve correctly

Made with Cursor

- Replace S3/AWS-specific URLs with Procore storage proxy pattern
- Remove cloud-specific headers (x-amz-content-sha256, content-md5) from
  sample responses and PUT examples — only Content-Length remains
- Add prominent callout that presigned URLs and headers are opaque and
  must be copied in their entirety without parsing or assertions
- Update Important Considerations to reinforce URLs/headers are subject
  to change without notice
- Clarify hash computation is for the POST request body, not PUT headers

Made-with: Cursor
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant