Adding get and create DP docs [SA-20990] (develop)#208
Conversation
Deploying schoolbox-api-docs with
|
| Latest commit: |
496924d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7729f3b1.schoolbox-api-docs.pages.dev |
| Branch Preview URL: | https://feature-develop-sa-20990.schoolbox-api-docs.pages.dev |
tchiang0530
changed the title
There was a problem hiding this comment.
Pull request overview
This pull request adds OpenAPI documentation for differentiation profile endpoints, introducing GET, POST, and PUT operations for managing student differentiation profiles.
Changes:
- Added new differentiation profile API endpoints for retrieving, creating, and updating profiles for students
- Defined the differentiation profile schema with student information, adjustment categories/levels, and various profile fields
- Added corresponding request body and response specifications
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| openapi/paths/differentiation-profiles@student@{id}.yaml | Defines GET, POST, and PUT operations for student differentiation profiles |
| openapi/openapi.yaml | Adds differentiation tag and path reference to the main OpenAPI specification |
| openapi/components/schemas/differentiation.yaml | Defines the complete differentiation profile schema with all properties |
| openapi/components/responses/differentiationProfile.yaml | Defines the response format for differentiation profile operations |
| openapi/components/requestBodies/differentiation.yaml | Defines the request body schema for creating/updating differentiation profiles |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| parameters: | ||
| - $ref: ../components/parameters/id.yaml |
There was a problem hiding this comment.
The parameters section should be placed at the end of the file, after all operation definitions (get, post, put), not in the middle. This is the convention followed throughout the codebase. See examples in user@{id}.yaml (line 53), user@{id}@groupMembership@{groupId}.yaml (line 67), and calendar@event@{id}@move.yaml (line 1-2).
2 participants
No description provided.