[API-BOT] Update API Docs #5339
Merged
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
|
Your Upsun Fixed environment has successfully deployed. 🚀 See the site: |
platformsh-devrel
force-pushed
the
update-api-doc
branch
from
557bb0c to
850676c
Compare
gilzow
approved these changes
Jan 20, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the API documentation specification to improve maintainability and consistency by extracting inline parameter definitions into reusable component references and adding detailed schema property definitions.
Changes:
- Replaced inline parameter definitions with component references (
$ref) for common parameters like pagination, filtering, and time ranges - Added explicit property definitions to previously generic object schemas (RegionProvider, RegionDataCenter, RegionEnvImpact, RegionCompliance)
- Consolidated response definitions by creating reusable
NoContentresponse component - Enhanced API response schemas with
countproperty andadditionalProperties: falseconstraints
Reviewed changes
Copilot reviewed 2 out of 6 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| shared/pages/openapispec-upsun.yaml | Refactored parameter definitions to use component references, added schema property details, and improved response consistency |
| shared/pages/openapispec-upsun.json | JSON equivalent of YAML changes with identical refactoring patterns |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
This PR updates the API Docs.