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

Rename crate #17

Open
Flowneee opened this issue Jul 28, 2024 · 0 comments
Open

Rename crate #17

Flowneee opened this issue Jul 28, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@Flowneee
Copy link
Owner

Current name originally was made to refer fact that crate provide macro to generate OpenAPI operation definition using okapi types.

Why name is not good:

  • Some people might think that this crate related to okapi project (which is false);
  • Almost immediately was added spec builder, implementations and integrations for axum (and potentially for different frameworks);
  • There is possibility that this crate will move from okapi to something different (or maybe fork okapi), because okapi is designed to support OpenAPI 3.0, while there is 3.1 version which use JSON Schema draft 2020-12 for describing schemas, and as I understand okapi not planning to support different versions;
  • Name is ugly)

So I think it would be good to have something neutral, not referring to any specific project or crate, and and general enough to include different instruments for building HTTP API specifications from code.

@Flowneee Flowneee added the enhancement New feature or request label Jul 28, 2024
@Flowneee Flowneee self-assigned this Jul 28, 2024
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