Update Documentation (trim & type)

[sman2600]

🗺️ Requirements

Update both API doc pages to clarify the following:
1.) Vehicle object available fields (trim & type were added but are missing from the documentation list)
2.) Update documentation summary text to state whether or not the object itself, and the fields contained within the object are mandatory or optional is also missing (in accordance with actual xAPI behavior)

If the Vehicle object is not provided, we will attempt a VIN decode on the provided VIN in order to populate these fields. If a Vehicle object is provided, then all fields should be provided and we will use this data preferentially over our own data sources (this can be useful in cases where you are submitting HINs, non-standard VINs, etc. that may not decode properly on our end).

🤔 Problem Statement

We added 2 new fields to this object but never updated the documentation (beyond updating some of the sample JSON)

*Note: Trim & Type also seem to behave differently than the rest of the Vehicle object fields when it comes to null values.

🕵️ Current Behavior

New fields are added but the only indication these exist is via either the front-end UI or some example JSON in some parts of the API documentation (inconsistent).

😍 Expected Behavior

Documentation is updated to match how the API actually functions.

✔️ Acceptance Criteria

• Create Claim Documentation page for vendor docs updated
• Create Claim Documentation for xapi docs updated

Resources

Any relevant resources that developers can use to better contextualize the user story
🎥 Loom explanation:
🎨 Design file: https://www.figma.com/file/Rw0HAZA2zArcgf6e9hxopp/xForce-Pages?type=design&node-id=646-2&mode=design&t=HjDaIU8bvxqUF05S-0
📈 Supporting Report:

[sman2600]

@brandonsusername @deroses There's some gaps in our API documentation around some of the new vehicle fields. It's a little confusing so I've made this small ticket to fix it.

[sman2600]

Hey team! Please add your planning poker estimate with Zenhub @jared-chapman @Alexsbuchanan @mikemclaren

[sman2600]

Hi Usha,

      It looks like it's working as intended. Typically we decode the provided VIN and fill in those fields based on the VIN decode. Last year as part of an IAA request we opened those fields up for user input so that you could give us VIN decode data (especially for things that might not decode well, like boats). So if you don't provide the Vehicle data object it looks like we'll do the VIN decode and attempt to populate that data ourselves, but if you do provide the object, we expect all of those fields to be provided (I believe Trim & Type may be optional, but we'll update the documentation soon to clarify this).

[sman2600]

Bonus item for sprint 5