DOCINT-1837: Document uploader_tool_name and fix upload status values#365
Merged
Conversation
…tus values Add uploader_tool_name to the request and response examples, correct the status table (add scanning/failed, scope complete to PATCH), and note upcoming API changes in Coming Soon. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
b4bfa05 to
f728a82
Compare
yoasyo25
commented
Jul 16, 2026
|
|
||
| ``` | ||
| The `uploader_tool_name` field identifies the Procore tool initiating the upload (for example, `document_management`), and is limited to 64 characters. | ||
| It is currently optional but will become required in a future release, so we recommend including it now. |
Contributor
Author
There was a problem hiding this comment.
@ajaykumarprocore can you confirm that this will become required in the future?
Contributor
There was a problem hiding this comment.
Yes - this will become required in the future - the wording is accurate. Thank you!!
ZRB-Procore
approved these changes
Jul 16, 2026
cynthiaxhe
approved these changes
Jul 16, 2026
imeron-procore
approved these changes
Jul 16, 2026
ajaykumarprocore
approved these changes
Jul 16, 2026
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
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
DOCINT-1837
Type of Change
Summary
Updates the Unified File Uploads tutorial to document the new
uploader_tool_namefield and to correct the upload status table, which was missing statuses that already shipped in the FUS API (scanning,failed) and listed a stale value (complete) as a GET-returned status.Motivation
The Unified File Uploads tutorial is being made publicly available and the tutorial should reflect upcoming/recently-shipped contract details: the new
uploader_tool_namefield, and the real status vocabulary already returned by the GET status endpoint (malware-scan states were shipped but not yet fully documented).Changes
uploader_tool_namefield"uploader_tool_name": "document_management"to allPOST /uploadsrequest/response examples (project-level single-part, project-level multi-part, company-level) and to the GET status response examples.Upload status accuracy
ready, receiving, complete, available, nowready, receiving, scanning, available, failed(matches the FUSUploadGetResponseschema'sallowableValues).scanningandfailedstatuses, clarified thatcompleteis a PATCH-response-only value that the GET endpoint always resolves into one of the other statuses.errorobject example ({type: "scan_failure", message: ...}) returned when afailedstatus is due to a malware-scan rejection.receiving→available).Validation
file-upload-service(FUS)main—api_docs/open-api.json,UploadStatusMapper.java,UploadGetResponse.java,CreateUploadRequest.java,UploadStatus/MalwareScanStatusenumsbundle exec jekyll serve)Testing Instructions
bundle exec jekyll servein thedocumentationrepo.http://127.0.0.1:4000/documentation/tutorial-unified-file-uploads.uploader_tool_namefield appears in all request/response code samples and the status table renders correctly with thescanning/failedrows and the newerrorobject example.Additional Context
Known, deliberate discrepancy (not a bug): PPC2-9064 (FUS analytics epic, in progress) states as an acceptance criterion that
uploader_tool_nameis additive-only and will never become required. This tutorial's "will become required in a future release" wording and matching "Coming Soon" bullet knowingly diverge from that epic's current text, per an explicit product-messaging decision made in Slack. Flagging here so reviewers aren't surprised if they cross-reference the epic.