Enums are not completely documented and up-to-date #1
Labels
Prio:High
High Priority
Status:Accepted
Issue or PR is accepted
Type:Feature
Issue or PR is a new feature
The following schemas are not documented in the original site and serialization might fail (e.g., in postman, the backup branch with all enum schemas generate warnings when imported). This will produce problems when generating client code as it might throw exceptions when deserializing.
To be consitent, the enums will be removed from those places. It is better that the client code removes those hard-coded enums even if failure is possible, because otherwise they might be to restrictive and new API being released everytime that something is introduced without any information.
The following enums are commented out from the API schemas:
schemas/Format.yaml
- found that not all formats are documented (before having the enum)schemas/Race.yaml
- found that not all races are documentedschemas/Type.yaml
- possibility that the types are not well documentedschemas/FrameType.yaml
- possibility that the frametypes are not well documentedMaybe the solution will be to request endpoints for available values, similar to the
/archetypes.php
endpoint.The text was updated successfully, but these errors were encountered: