-
Notifications
You must be signed in to change notification settings - Fork 1
Feature | Extend Swagger Coverage for controller OAuth2SummitSpeakersApiController #452
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
| operationId: 'getSpeakers', | ||
| description: 'Get all speakers for a summit with filtering and pagination', | ||
| tags: ['SummitSpeakers'], | ||
| security: [['bearer_token' => []]], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@andrestejerina97 u need to defined a custom security schema for speakers with the proper scopes this is not enough please do review
summit-api/app/Http/Controllers/Apis/Protected/Summit/OAuth2RSVPApiController.php
Line 87 in c070afa
| security: [['summit_rsvp_oauth2' => [ |
| operationId: 'getSpeakersCSV', | ||
| description: 'Export speakers for a summit as CSV file', | ||
| tags: ['SummitSpeakers'], | ||
| security: [['bearer_token' => []]], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| operationId: 'getSpeakersOnSchedule', | ||
| description: 'Get speakers with presentations on schedule for a summit', | ||
| tags: ['SummitSpeakers'], | ||
| security: [['bearer_token' => []]], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| responses: [ | ||
| new OA\Response( | ||
| response: Response::HTTP_OK, | ||
| description: 'List of speakers on schedule', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
List of Speakers that belongs to Summit Schedule
| operationId: 'getAllSpeakers', | ||
| description: 'Get all speakers (without summit filter)', | ||
| tags: ['SummitSpeakers'], | ||
| security: [['bearer_token' => []]], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| #[OA\Get( | ||
| path: '/api/v1/speakers', | ||
| operationId: 'getAllSpeakers', | ||
| description: 'Get all speakers (without summit filter)', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Get All Global Speakers
| operationId: 'getSummitSpeaker', | ||
| description: 'Get a specific speaker by ID for a summit', | ||
| tags: ['SummitSpeakers'], | ||
| security: [['bearer_token' => []]], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| path: '/api/v1/summits/{id}/speakers/me', | ||
| operationId: 'getMySummitSpeaker', | ||
| description: 'Get current user speaker profile for a summit', | ||
| parameters: [ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing security schema
| operationId: 'getMySpeaker', | ||
| description: 'Get current user speaker profile', | ||
| tags: ['SummitSpeakers'], | ||
| security: [['bearer_token' => []]], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| operationId: 'createMySpeaker', | ||
| description: 'Create speaker profile for current user', | ||
| tags: ['SummitSpeakers'], | ||
| security: [['bearer_token' => []]], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| operationId: 'updateMySpeaker', | ||
| description: 'Update current user speaker profile', | ||
| tags: ['SummitSpeakers'], | ||
| security: [['bearer_token' => []]], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| security: [['bearer_token' => []]], | ||
| requestBody: new OA\RequestBody( | ||
| required: true, | ||
| content: new OA\JsonContent( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
define a custom schema at Swagger/SummitSpeakers.pjp
| security: [['bearer_token' => []]], | ||
| requestBody: new OA\RequestBody( | ||
| required: true, | ||
| content: new OA\JsonContent( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| operationId: 'getSpeaker', | ||
| description: 'Get speaker by ID', | ||
| tags: ['SummitSpeakers'], | ||
| security: [['bearer_token' => []]], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ], | ||
| requestBody: new OA\RequestBody( | ||
| required: true, | ||
| content: new OA\JsonContent( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
define a custom schema at Swagger/SummitSpeakers.php
| operationId: 'updateSpeakerBySummit', | ||
| description: 'Update speaker for a summit', | ||
| tags: ['SummitSpeakers'], | ||
| security: [['bearer_token' => []]], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ], | ||
| requestBody: new OA\RequestBody( | ||
| required: true, | ||
| content: new OA\JsonContent( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| schema: new OA\Schema(type: 'integer') | ||
| ), | ||
| ], | ||
| requestBody: new OA\RequestBody( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
smarcet
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@andrestejerina97 please review comments
ref: https://app.clickup.com/t/86b6wkhcw