feat: add document management metadata documentation #328
+994
−1
Conversation
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
yoasyo25
force-pushed
the
ya/DOCINT-1056/pdm_api_metadata_documentation
branch
from
6b03448 to
beb7c5f
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the Document Management Integration, specifically covering metadata structure and API endpoints for document upload and revision operations.
Changes:
- Added detailed metadata field reference documentation covering standard, system, placeholder, workflow, and custom fields
- Added API endpoints reference page with links to all Document Management endpoints
- Included examples of field types, value structures, and complete API response
Reviewed changes
Copilot reviewed 1 out of 1 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| document_management_integration/document_management_metadata_details.md | Comprehensive documentation of document metadata structure, field types, value sources, and integration processing with example responses |
| document_management_integration/document_management_api_endpoints.md | Quick reference table of Document Management API endpoints with descriptions and URIs |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
document_management_integration/document_management_metadata_details.md
Outdated
Show resolved
Hide resolved
document_management_integration/document_management_metadata_details.md
Outdated
Show resolved
Hide resolved
document_management_integration/document_management_metadata_details.md
Outdated
Show resolved
Hide resolved
document_management_integration/document_management_metadata_details.md
Outdated
Show resolved
Hide resolved
document_management_integration/document_management_metadata_details.md
Outdated
Show resolved
Hide resolved
document_management_integration/document_management_metadata_details.md
Outdated
Show resolved
Hide resolved
document_management_integration/document_management_metadata_details.md
Outdated
Show resolved
Hide resolved
document_management_integration/document_management_metadata_details.md
Outdated
Show resolved
Hide resolved
yoasyo25
force-pushed
the
ya/DOCINT-1056/pdm_api_metadata_documentation
branch
from
beb7c5f to
8ee7c64
Compare
yoasyo25
force-pushed
the
ya/DOCINT-1056/pdm_api_metadata_documentation
branch
from
8ee7c64 to
02321f5
Compare
kangster
reviewed
Feb 3, 2026
| | **placeholder_assignee** | reference | Assignee of the placeholder document. | | ||
| | **placeholder_due_date** | timestamp | Due date of the placeholder document. | | ||
| | **project** | reference | An abbreviation of the project's name. | | ||
| | **project_stage** | lov_entry | The construction stage associated with the document. | |
Contributor
There was a problem hiding this comment.
I believe this field type is a reference:
Suggested change
| | **project_stage** | lov_entry | The construction stage associated with the document. | | |
| | **project_stage** | reference | The construction stage associated with the document. | |
| | **timestamp** | Date and time in ISO 8601 UTC format | | ||
| | **lov_entry** | Single selection from project-configured list of values | | ||
| | **lov_entries** | Multiple selections from project-configured list of values | | ||
| | **reference** | Link to another entity such as users, locations, or workflows | |
Contributor
There was a problem hiding this comment.
I think there is also a numeric field type
| | **SCRAPING_FAILED** | Filename scraping was attempted but failed for this field | Yes - can be set manually | | ||
| | **ML** | Value populated by Machine Learning analysis | Yes - manual values override | | ||
| | **ML_FAILED** | ML analysis was attempted but failed for this field | Yes - can be set manually | | ||
| | **SYSTEM** | Value set by Document Management system automatically | Depends on field | |
Contributor
There was a problem hiding this comment.
Could call out these are not user-overridable:
Suggested change
| | **SYSTEM** | Value set by Document Management system automatically | Depends on field | | |
| | **SYSTEM** | Value set by Document Management system automatically | No -system fields cannot be modified | |
|
|
||
| ## Field Type Reference | ||
|
|
||
| In the Document Upload and Document Revision API responses, each field object in the `fields` array includes a `type` property that determines its value format and structure. |
Contributor
There was a problem hiding this comment.
Consider possibly linking the API documentation
| *** | ||
| <details> | ||
| <summary class="collapseListTierOne">Overview of document metadata fields</summary> | ||
| <pre><code>{ |
Contributor
There was a problem hiding this comment.
When I preview this code block, the formatting is off for some reason.
| ```json | ||
| { | ||
| "integrationStatuses": { | ||
| "ML": "in_progress" | "completed" | "error" | "not_applicable", |
Contributor
There was a problem hiding this comment.
Consider using a comment for enum values. It currently renders invalid syntax highlighting :
Suggested change
| "ML": "in_progress" | "completed" | "error" | "not_applicable", | |
| "ML": "in_progress", // One of: in_progress, completed, error, not_applicable |
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 Ticket:
🎫 DOCINT-1056
Summary
Adds documentation for PDM metadata.
Change Type(s)