Conversation
caseylocker
left a comment
There was a problem hiding this comment.
Missing operationId on all 8 endpoints.
Title Case your tags. I.e. "TrackChairs" should be "Track Chairs" etc...
Invalid 'anyOf' for expandable properties: app/Swagger/SummitTrackChairSchemas.php
Goes for summit_id/summit and member_id/member
// Current - invalid anyOf with OA\Property
anyOf: [
new OA\Property(property: 'summit_id', type: 'integer', ...),
new OA\Property(property: 'summit', type: 'Summit', ...),
]
// Fix - Ddocument in properties
properties: [
new OA\Property(property: 'id', type: 'integer'),
new OA\Property(property: 'created', type: 'integer'),
new OA\Property(property: 'last_edited', type: 'integer'),
new OA\Property(property: 'summit_id', type: 'integer', description: 'Summit ID. Replaced by summit object when using ?expand=summit'),
new OA\Property(property: 'member_id', type: 'integer', description: 'Member ID. Replaced by member object when using ?expand=member'),
new OA\Property(
property: 'categories',
type: 'array',
items: new OA\Items(type: 'integer'),
description: 'Array of category IDs. Use expand=categories for full objects, relations=categories to include'
),
]
Invalid type array syntax (lines 19, 44):
If you generate the current documentation you can immediately see the issue.
// Invalid
items: new OA\Items(type: ['integer', 'PresentationCategory'])
// Fix - document behavior
new OA\Property(
property: 'categories',
type: 'array',
items: new OA\Items(type: 'integer'),
description: 'Array of category IDs. Use relations=categories to include. Use expand=categories to get full PresentationCategory objects instead of IDs'
),
d5aad68 to
fc0d9e5
Compare
c6ecdd0 to
728ae67
Compare
fc0d9e5 to
6ce15e9
Compare
6ce15e9 to
6fbe77d
Compare
|
rebased |
Signed-off-by: Matias Perrone <github@matiasperrone.com>
Signed-off-by: Matias Perrone <github@matiasperrone.com>
ref: https://app.clickup.com/t/86b6wkh6f