Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request replaces placeholder "TODO: Auto-generated description" text with actual descriptive documentation for enum values across multiple JSON schema files in the auto-generated library. The changes provide clear, concise descriptions for various enumeration types used throughout the Synapse data model, improving API documentation and developer experience.
Key changes:
- Added descriptive documentation for ~200+ enum values across 30+ schema files
- Removed the PORTAL migration type enum entry (potentially breaking change)
- Descriptions follow a consistent, clear style that explains each enum value's purpose
Reviewed Changes
Copilot reviewed 35 out of 35 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| StackStatus.json | Added descriptions for stack status states (READ_WRITE, READ_ONLY, DOWN) |
| FacetTypeNames.json | Added descriptions for facet types (LITERAL, DATE, CONTINUOUS) |
| TypeFilter.json | Added descriptions for principal type filters (USERS_ONLY, TEAMS_ONLY, ALL) |
| MigrationType.json | Added descriptions for ~80 migration types; removed PORTAL enum entry |
| MessageSortBy.json | Added descriptions for message sorting options |
| UploadType.json | Added descriptions for upload protocol types |
| AddPartResponse.json | Added descriptions for multipart upload response states |
| DoiStatus.json | Added descriptions for DOI lifecycle states |
| RegistryEventAction.json | Added descriptions for Docker registry actions |
| DockerCommitSortBy.json | Added descriptions for Docker commit sorting options |
| DiscussionThreadOrder.json | Added descriptions for discussion thread ordering options |
| DiscussionReplyOrder.json | Added descriptions for discussion reply ordering options |
| DiscussionFilter.json | Added descriptions for discussion filtering options |
| SubmissionState.json | Added descriptions for data access submission states |
| SubmissionOrder.json | Added descriptions for submission ordering options |
| AccessorChange.json | Added descriptions for access change types |
| UploadResult.json | Added descriptions for upload result states |
| PresignedUrl.json | Added descriptions for presigned URL status values |
| AsynchronousJobStatus.json | Added descriptions for async job status states |
| RestrictionLevel.json | Added descriptions for access restriction levels |
| RestrictableObjectType.json | Added descriptions for restrictable object types |
| ProjectListSortColumn.json | Added descriptions for project list sorting options |
| PrincipalType.json | Added descriptions for principal types (USER, TEAM) |
| ObjectType.json | Added descriptions for ~20 object types |
| ExampleEntity.json | Added descriptions for example enum values (CAT, DOG, FISH) |
| EntityType.json | Added descriptions for entity types (project, folder, file, etc.) |
| EntityChildrenRequest.json | Added descriptions for sort direction (ASC, DESC) |
| DiseaseNames.json | Added descriptions for disease categories |
| DatasetStatusNames.json | Added descriptions for dataset status values |
| CurationTrackingData.json | Added descriptions for curation states |
| ApprovalState.json | Added descriptions for approval states |
| AcquisitionTrackingData.json | Added descriptions for acquisition tracking states |
| ACCESS_TYPE.json | Added descriptions for access permission types |
| UserEvaluationState.json | Added descriptions for user evaluation registration states |
| SubmissionStatusEnum.json | Added descriptions for submission status values |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
189
to
192
| { | ||
| "name": "TRASH_CAN", | ||
| "description": "TODO: Auto-generated description" | ||
| }, | ||
| { | ||
| "name": "PORTAL", | ||
| "description": "Table that stores portal information" | ||
| "description": "A trashed entity or object." | ||
| }, |
There was a problem hiding this comment.
The PORTAL migration type entry appears to have been removed in this PR. While the PR description mentions "Auto-generated doc's", this is a functional change that removes an enum value, not just documentation updates. Please verify this removal is intentional and consider whether this constitutes a breaking API change that may impact existing code relying on the PORTAL migration type.
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
1 participant
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.
Auto-generated doc's