-
Notifications
You must be signed in to change notification settings - Fork 2
Feature | Add openapi documentation for SummitAdministratorPermissionGroup #403
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
Feature | Add openapi documentation for SummitAdministratorPermissionGroup #403
Conversation
4b586da to
e476b84
Compare
e476b84 to
af9823b
Compare
bc3a5d2 to
dfa0eeb
Compare
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.
Pull Request Overview
This PR adds OpenAPI documentation for the SummitAdministratorPermissionGroup API endpoints, including schemas for CRUD operations and relationship management (adding/removing members and summits).
Key changes:
- Added comprehensive OpenAPI schemas for SummitAdministratorPermissionGroup entities and operations
- Added OAuth2 security scheme definition for summit administrator groups
- Documented all API endpoints including GET, POST, PUT, and DELETE operations with request/response definitions
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| app/Swagger/SummitAdministratorPermissionGroupSchemas.php | Defines OpenAPI schemas for SummitAdministratorPermissionGroup, including the main entity schema, create/update request schemas, and paginated list response schema |
| app/Swagger/Security/SummitAdminGroupsOauth2.php | Defines OAuth2 security scheme for summit administrator group endpoints with read and write scopes |
| app/Http/Controllers/Apis/Protected/Main/OAuth2SummitAdministratorPermissionGroupApiController.php | Adds OpenAPI annotations to all controller methods documenting endpoints, parameters, request bodies, responses, and security requirements |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
...tp/Controllers/Apis/Protected/Main/OAuth2SummitAdministratorPermissionGroupApiController.php
Outdated
Show resolved
Hide resolved
...tp/Controllers/Apis/Protected/Main/OAuth2SummitAdministratorPermissionGroupApiController.php
Outdated
Show resolved
Hide resolved
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 do rebase with main ( i found an issue on http verbs at main ) and review the comments
dfa0eeb to
0029ae5
Compare
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.
LGTM
ref: https://app.clickup.com/t/86b6wkh5t