Skip to content

Various improvements - #1024

Merged
Samze merged 2 commits into
mainfrom
various_improvements
Aug 13, 2025
Merged

Various improvements#1024
Samze merged 2 commits into
mainfrom
various_improvements

Conversation

@Samze

@Samze Samze commented Aug 13, 2025

Copy link
Copy Markdown
Contributor

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

Samze added 2 commits August 12, 2025 13:54
* 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
@Samze
Samze requested a review from Copilot August 13, 2025 02:29

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.yaml schema instead of Error.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.

Comment thread apis/cf/latest/openapi.yaml
Comment thread apis/cf/latest/paths/SecurityGroups.yaml
@Samze
Samze requested a review from FloThinksPi August 13, 2025 02:31
@Samze
Samze merged commit 3e2c63b into main Aug 13, 2025
2 checks passed
@Samze
Samze deleted the various_improvements branch August 13, 2025 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants