Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enums are not completely documented and up-to-date #1

Open
magicDGS opened this issue Mar 10, 2023 · 0 comments
Open

Enums are not completely documented and up-to-date #1

magicDGS opened this issue Mar 10, 2023 · 0 comments
Labels
Prio:High High Priority Status:Accepted Issue or PR is accepted Type:Feature Issue or PR is a new feature

Comments

@magicDGS
Copy link
Contributor

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 documented
  • schemas/Type.yaml - possibility that the types are not well documented
  • schemas/FrameType.yaml - possibility that the frametypes are not well documented

Maybe the solution will be to request endpoints for available values, similar to the /archetypes.php endpoint.

@magicDGS magicDGS added Prio:High High Priority Status:Accepted Issue or PR is accepted Type:Feature Issue or PR is a new feature labels May 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Prio:High High Priority Status:Accepted Issue or PR is accepted Type:Feature Issue or PR is a new feature
Projects
None yet
Development

No branches or pull requests

1 participant