Recently, @ackwell has provided us with the XIVAPI observability dashboard: https://o11y.xivapi.com/. To support this properly, several updates are needed across the package.
Proposed changes
-
The client should extend the User-Agent header so requests include accurate package information and can be clearly distinguished from other JS packages. This will improve attribution and visibility within the XIVAPI dashboard.
-
New typed sheets should be added to the client for quick use. These include:
Facewear (Lodestone) Covered by Item
- Emotes (Lodestone)
- Action
These should follow the existing typing conventions.
-
Documentation throughout the package needs updates to:
- Fix inaccuracies
- Improve clarity
- Add missing examples
- Ensure consistency with recent changes
Recently, @ackwell has provided us with the XIVAPI observability dashboard: https://o11y.xivapi.com/. To support this properly, several updates are needed across the package.
Proposed changes
The client should extend the
User-Agentheader so requests include accurate package information and can be clearly distinguished from other JS packages. This will improve attribution and visibility within the XIVAPI dashboard.New typed sheets should be added to the client for quick use. These include:
Facewear (Lodestone)Covered byItemThese should follow the existing typing conventions.
Documentation throughout the package needs updates to: