Skip to content

Conversation

@matiasperrone-exo
Copy link
Contributor

@matiasperrone-exo matiasperrone-exo commented Oct 2, 2025

@matiasperrone-exo matiasperrone-exo added the documentation Improvements or additions to documentation label Oct 2, 2025
@matiasperrone-exo matiasperrone-exo self-assigned this Oct 2, 2025
@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller---apis---protected---summit---oauth2summitmediafiletypeapicontroller branch 2 times, most recently from 71ab1a0 to 2c50dc4 Compare October 8, 2025 22:07
@matiasperrone-exo matiasperrone-exo changed the title Feature | Extend Swagger Coverage for controller Apis/Protected/Summit/OAuth2SummitMediaFileTypeApiController.php Feature | Extend Swagger Coverage for controller OAuth2SummitMediaFileTypeApiController Oct 13, 2025
@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller---apis---protected---summit---oauth2summitmediafiletypeapicontroller branch 3 times, most recently from b303941 to 6aefbeb Compare October 14, 2025 17:22
Copy link

@caseylocker caseylocker left a comment

Choose a reason for hiding this comment

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

@matiasperrone-exo looks like this one also relies on 'summit_rsvp_oauth2' being a defined security schema but it doesn't exist in the Pr in app/Swagger/schemas.php
It looks like once that's actually defined it will fix at least a few of these PRs.

@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller---apis---protected---summit---oauth2summitmediafiletypeapicontroller branch from 6aefbeb to 48aa91c Compare October 31, 2025 18:30
@matiasperrone-exo
Copy link
Contributor Author

@matiasperrone-exo looks like this one also relies on 'summit_rsvp_oauth2' being a defined security schema but it doesn't exist in the Pr in app/Swagger/schemas.php It looks like once that's actually defined it will fix at least a few of these PRs.

@caseylocker thanks the issue is now fixed and the docs are compiling now.

@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller---apis---protected---summit---oauth2summitmediafiletypeapicontroller branch from 6a650e4 to f29c0b9 Compare November 7, 2025 21:51
@matiasperrone-exo
Copy link
Contributor Author

@caseylocker @smarcet All the scopes are now the right ones, please review.

@matiasperrone-exo matiasperrone-exo added the review Need reviewing from the developer label Nov 10, 2025
@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller---apis---protected---summit---oauth2summitmediafiletypeapicontroller branch from 4d93845 to a6fbac7 Compare November 11, 2025 22:00
@matiasperrone-exo matiasperrone-exo removed the review Need reviewing from the developer label Nov 18, 2025
Copy link

@caseylocker caseylocker left a comment

Choose a reason for hiding this comment

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

Change the "tags" for the GET all to match the other ones - tags: ['Summit Media File Types'],

None of the 5 endpoints have operationId defined. Add for API client generation:
GET all: operationId: 'getAllSummitMediaFileTypes'
GET one: operationId: 'getSummitMediaFileType'
POST: operationId: 'createSummitMediaFileType'
PUT: operationId: 'updateSummitMediaFileType'
DELETE: operationId: 'deleteSummitMediaFileType'

Missing type: 'object' in Paginated Schema
Should be:
new OA\Schema(
type: 'object',
properties: [

@matiasperrone-exo matiasperrone-exo force-pushed the feature/add-openapi-documentation-to-controller---apis---protected---summit---oauth2summitmediafiletypeapicontroller branch from 62f2a0c to 8953b63 Compare November 20, 2025 22:09
@matiasperrone-exo
Copy link
Contributor Author

Change the "tags" for the GET all to match the other ones - tags: ['Summit Media File Types'],

None of the 5 endpoints have operationId defined. Add for API client generation: GET all: operationId: 'getAllSummitMediaFileTypes' GET one: operationId: 'getSummitMediaFileType' POST: operationId: 'createSummitMediaFileType' PUT: operationId: 'updateSummitMediaFileType' DELETE: operationId: 'deleteSummitMediaFileType'

Missing type: 'object' in Paginated Schema Should be: new OA\Schema( type: 'object', properties: [

@caseylocker this PR is ready to be reviewed, I've included all the requested changes

Copy link

@caseylocker caseylocker left a comment

Choose a reason for hiding this comment

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

@matiasperrone-exo Right on. Looks good. @smarcet if you agree please merge.

Copy link
Collaborator

@smarcet smarcet left a comment

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 a3eeb30 into main Dec 3, 2025
3 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