Skip to content

Provide alternate API spec variants #9

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

Provide alternate API spec variants #9

leonhard-s opened this issue Jun 23, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@leonhard-s
Copy link
Owner

The reference spec will be technically correct and cover both the source and cast type for all fields, as well as provide any documentation required to use the API.

However, this compromises all use cases. Instead, we could provide different "releases" of the same version of the spec, for different deployments:

  • The documentation spec on ReadTheDocs could use the cast types for readability, rather than typing everything as string (even if this is correct)
  • Client code may want a smaller, lower-bandwidth version of the spec that does away with examples and documentation
  • There could still be use cases for which a full monolith is better suited than the multi-file layout the repo will use/should be using
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant