Version 0.7

Changes

• Added new experience_award_type collection (added to Census 2024-02-21)
• Updated experience schema for new experience_award_type_id field

Version 0.6

Changes

• Updated metagame_event endpoint to include new duration_minutes field (#12)

Known Issues

• (Carry-over from v0.5) Vendor extensions remain unfinished (#7)

Version 0.5

Changes

• Added introduction
• Rewrote tag, section & most endpoint descriptions
• Add links for additional API usage information

Known Issues

• Vendor extensions remain unfinished (#7)

Version 0.4

Full rewrite of the API specification for OpenAPI 3.1.

Changes

• Rewrote endpoint descriptions
• Added descriptions for all fields on all collections
• Added parameter documentation for query commands (for brevity, these are only listed for the generic endpoints, not the collection-specific overrides)
• API specification was broken up into multiple files. A monolithic JSON document can be found in the generated/ directory
• Moved top-level entry point, schemas, path content, and parameter definitions to YAML for readability
• Examples have been moved to the examples/ directory and left in JSON format. This improves testability, but also means that individual payload schemas no longer include the top level {collection}_list key.

Known Issues

• The vendor extensions x-cast-to and x-reference-to are a preview and may change in the future
• The monolithic JSON spec hosted in the generated/ directory is tentative and may be renamed or otherwise changed

Version 0.1 Alpha 2

Incremental feature additions and performance improvements.

Highlights

• Added basic descriptions to all get query verb paths

• Update x-reference-to extension (see the README for details)

• Moved examples and schemas to top-level components key

  This reduces the complexity of the key needed to scrape the corresponding datatype information from the specification.

• Truncated large payloads

  Some example payloads, like characters_item or single_character_by_id were stored in their entity in the example payload. This caused several Megabytes of superfluous data in the resulting output specification. This has been fixed; such tables now have their inner lists truncated to 5 or 10 elements.

• Removed duplicate example definition

  The build process erroneously resolved references to examples, resulting in example payloads being added twice. This has been fixed by not including the examples in the schema definition and adding the corresponding JSON reference to the path operation as part of the build process.

Initial Preview Release

This release is mostly for testing the CD toolchain with ReadTheDocs.

• All get query verb endpoints are added
• Most endpoints still use dummy descriptions
• Example payloads are provided for all paths