Skip to content

Feature | Extend Swagger Coverage for controller ReleasesApiController - #379

Merged
smarcet merged 2 commits into
mainfrom
feature/add-openapi-documentation-to-controller-releasesapicontroller
Dec 16, 2025
Merged

Feature | Extend Swagger Coverage for controller ReleasesApiController#379
smarcet merged 2 commits into
mainfrom
feature/add-openapi-documentation-to-controller-releasesapicontroller

Conversation

@andrestejerina97

@andrestejerina97 andrestejerina97 commented Oct 2, 2025

Copy link
Copy Markdown
Contributor

@andrestejerina97
andrestejerina97 marked this pull request as ready for review October 2, 2025 17:50
@andrestejerina97
andrestejerina97 force-pushed the feature/add-openapi-documentation-to-controller-releasesapicontroller branch from c8161ca to e88b0e2 Compare October 17, 2025 15:44
@andrestejerina97 andrestejerina97 self-assigned this Oct 31, 2025
@andrestejerina97
andrestejerina97 force-pushed the feature/add-openapi-documentation-to-controller-releasesapicontroller branch from e88b0e2 to fb7a4aa Compare November 13, 2025 16:47

@caseylocker caseylocker 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.

The API Path is wrong. "path: '/api/v1/releases/current'," should be "path: '/api/public/v1/releases/current',"

The "anyOf" usage is incorrect.
The "type: 'SoftwareComponent'" isn't valid and to include it you'd need a ref to a schema. Just include the integer array and be more explicit in the description...

properties: [
    // ... existing properties ...
    new OA\Property(
        property: 'components',
        type: 'array',
        items: new OA\Items(type: 'integer'),
        description: 'Array of component IDs. Use ?expand=components for full objects'
    ),
]
// Remove anyOf entirely

@matiasperrone-exo
matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller-releasesapicontroller branch from fb7a4aa to 2ae5846 Compare December 5, 2025 20:18
@matiasperrone-exo matiasperrone-exo added the documentation Improvements or additions to documentation label Dec 9, 2025

@caseylocker caseylocker 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.

Approved

@smarcet smarcet left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@smarcet
smarcet merged commit e02ae95 into main Dec 16, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants