Feature | Extend Swagger Coverage for controller OAuth2SummitBadgesApiController

[matiasperrone-exo]

Task:

Ref: https://app.clickup.com/t/86b6wkh3h

[caseylocker]

'oauth2_security_scope' issue again. Needs to be defined in schemas.php.
response description of "not found" needs to be title case in the controller, "Not Found":
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not Found"),

[matiasperrone-exo]

'oauth2_security_scope' issue again. Needs to be defined in schemas.php. response description of "not found" needs to be title case in the controller, "Not Found": new OA\Response(response: Response::HTTP_NOT_FOUND, description: "Not Found"),

@caseylocker the suggested Title Case is now implemented

[matiasperrone-exo]

@caseylocker The security schema for the controller was moved to its own file

[caseylocker]

@matiasperrone
Please include a unique operationId to endpoints. It's generally not required but is a good standard to follow for automated tooling.

Fix invalid Object references. You can test this in the generate docs. These are invalid types:
new OA\Property(property: 'ticket', type: 'Ticket'),
new OA\Property(property: 'type', type: 'BadgeType'),
Use ref for these since we're going 1 level deep for nesting here or just use the id declarations and and mark the expandable ones as nullable.

Fix the title casing in the controller error response for:
new OA\Response(response: Response::HTTP_NOT_FOUND, description: "not found"),
It should be title case = "Not Found"

Fix the confusing owner_email filter example:
items: new OA\Items(type: 'string', example: 'owner_email=@example.com')
I know what you're saying here but "=@" means "starts with".
Use "contains" instead if you want to keep the format so: owner_email@@example.com"
Or "starts with": "owner_email=@john"

[matiasperrone-exo]

@caseylocker all the requested changes were introduced. Please review it again.

[caseylocker]

@matiasperrone-exo We're on a roll. Looks good. @smarcet if you agree please merge.

[smarcet]

@matiasperrone please review conlficts

[smarcet]

LGTM