search

XeroAPI / Xero-OpenAPI

An OpenAPI description of the Xero API
https://developer.xero.com
MIT License
103 stars 125 forks source link

Missing description field for assets #621

Open orangethunder opened 1 month ago

orangethunder commented 1 month ago

Expected Behavior

When retrieving an individual asset from the API, I expect it to have a "description" field, as documented in the official API.

Current Behavior

There is no "description" field.

Possible Solution

Add the "description" field to the Asset entity definition. Make it clear in the documentation that it will be null when listing assets, and only potentially have a value when retrieving a single asset. Alternatively, split the Asset entity definition into one used for listing assets and another for retrieving an individual asset.

Steps to Reproduce (for bugs)

Call get_asset_by_id on the assets API client (or whatever the equivalent method is in your chosen programming languate).

github-actions[bot] commented 1 month ago

PETOSS-578

github-actions[bot] commented 1 month ago

Thanks for raising an issue, a ticket has been created to track your request