Skip to content

Define vendor extensions #7

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

Open
leonhard-s opened this issue Jun 23, 2023 · 0 comments
Open

Define vendor extensions #7

leonhard-s opened this issue Jun 23, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request rest Related to the REST endpoint

Comments

@leonhard-s
Copy link
Owner

leonhard-s commented Jun 23, 2023

The current spec uses a slightly inconsistent mix of vendor (x-) fields that should be tidied up and documented.

Examples

  • x-cast-to is not consistently placed and should always be next to the type field. Could also be renamed to x-type-cast-to or other variants whose intent is clearer

  • x-reference-to should not contain the game namespace, only the fields. Another name could be considered too, though it is worth noting that these are not only used for primary keys

  • x-deprecated or x-unused could be used to document fields that should not be exposed to users of generated code

  • x-deprecated should point to alternatives

@leonhard-s leonhard-s added documentation Improvements or additions to documentation enhancement New feature or request rest Related to the REST endpoint labels Jun 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request rest Related to the REST endpoint
Projects
None yet
Development

No branches or pull requests

1 participant