Various improvements - #1024
Merged
Merged
Conversation
* CF returns a list of errors rather than a single error * Add missing paths to openapi.yaml * Add missing resource schema * Add missing requestBodies * Change to use path references rather than hash references * Add missing response body schemas * Add lint ignore for endpoint that returns 302
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR implements various improvements to the Cloud Foundry API specification, focusing on better organization and standardization. The changes update error handling to return lists instead of single errors, add missing OpenAPI schema definitions, and standardize reference patterns throughout the specification.
- Replace hash references with path references for better maintainability
- Update error responses to use
Errors.yamlschema instead ofError.yaml - Add missing request body schemas and response schemas for various endpoints
- Standardize path parameter naming from specific GUIDs to generic
{guid}
Reviewed Changes
Copilot reviewed 57 out of 57 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| openapi.yaml | Updates main specification with spelling correction, new schema references, request bodies, and missing endpoint paths |
| Multiple path files | Standardizes parameter references from hash to path format and updates GUID parameter naming |
| Multiple response files | Changes error schema references from Error.yaml to Errors.yaml for list-based error handling |
| Multiple schema files | Adds new schema definitions for apps, organizations, packages, processes, and quotas |
| Multiple request body files | Adds comprehensive request body schemas for create/update operations |
| .redocly.lint-ignore.yaml | Adds lint ignore rule for 302 response endpoint |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
FloThinksPi
approved these changes
Aug 13, 2025
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.
Various updates:
* CF returns a list of errors rather than a single error
* Add missing paths to openapi.yaml
* Add missing resource schema
* Add missing requestBodies
* Add missing response body schemas
* Change to use path references rather than hash references
* Add lint ignore for endpoint that returns 302