feat: adding docs for mileate rates related fields in expenses api - #850
Draft
tirth-bhagwat wants to merge 4 commits into
Draft
feat: adding docs for mileate rates related fields in expenses api#850tirth-bhagwat wants to merge 4 commits into
tirth-bhagwat wants to merge 4 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the OpenAPI schemas to document advanced mileage-rate attributes (vehicle ownership/category, fuel type, engine capacity, charging location) and adds new mileage-expense fields for capturing selected vehicle details and passenger mileage amounts. These changes extend the API contract for mileage-related entities and propagate into the bundled reference/* specs.
Changes:
- Added advanced-mileage metadata fields to
mileage_rateoutput/input schemas. - Added selected vehicle fields and passenger mileage fields to expense schemas across multiple request variants.
- Regenerated bundled OpenAPI references for affected roles.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/components/schemas/mileage_rate.yaml | Documents advanced mileage-rate attributes and updates create/update input requirements. |
| src/components/schemas/expense.yaml | Adds new mileage-expense fields for selected vehicle attributes and passenger mileage. |
| src/approver/paths/approver@mileage_rates.yaml | Minor formatting/indentation correction for the 401 schema reference. |
| reference/spender.yaml | Bundled spec updates reflecting new mileage-rate schema fields. |
| reference/approver.yaml | Bundled spec updates reflecting new mileage-rate schema fields. |
| reference/admin.yaml | Bundled spec updates reflecting new mileage-rate schema fields and input requirements. |
Comments suppressed due to low confidence (1)
src/components/schemas/mileage_rate.yaml:159
- Same ambiguity as above for
engine_capacity: the schema allowsnullvianullable: true, but the description only mentions an empty object for basic mileage rates. Clarifying this helps consumers understand what to expect for non-applicable cases.
engine_capacity:
type: object
nullable: true
additionalProperties: false
description: Engine capacity band for petrol, diesel, and LPG advanced car rates. An empty object for basic mileage rates.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+72
to
+76
| engine_capacity: | ||
| type: object | ||
| nullable: true | ||
| additionalProperties: false | ||
| description: Engine capacity band for petrol, diesel, and LPG advanced car rates. An empty object for basic mileage rates. |
Comment on lines
+258
to
+262
| engine_capacity: | ||
| type: object | ||
| nullable: true | ||
| additionalProperties: false | ||
| description: Required in every request. Use an empty object for electric and basic mileage rates. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Please add PR description here, add screenshots if needed
Clickup
https://app.clickup.com/t/1864988/86d3n000n