Skip to content

feat: adding docs for mileate rates related fields in expenses api - #850

Draft
tirth-bhagwat wants to merge 4 commits into
mainfrom
FYLE-86d3n000n-expense-docs
Draft

feat: adding docs for mileate rates related fields in expenses api#850
tirth-bhagwat wants to merge 4 commits into
mainfrom
FYLE-86d3n000n-expense-docs

Conversation

@tirth-bhagwat

Copy link
Copy Markdown
Contributor

Description

Please add PR description here, add screenshots if needed

Clickup

https://app.clickup.com/t/1864988/86d3n000n

Copilot AI review requested due to automatic review settings July 24, 2026 05:42
@tirth-bhagwat tirth-bhagwat changed the title Fyle 86d3n000n expense docs feat: adding docs for mileate rates related fields in expenses api Jul 24, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 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_rate output/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 allows null via nullable: 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants