feat: Add CLI for compeller add
to support path, method based construction of the schema
#42
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces:
A command for injection of a new path with an associated schema.
The injection will ultimately lead to requiring expansion, to support the full API, and this will be problematic, as we are currently only allowing path and method.
The suggestion would be to enable for a fast MVP creation of common scenarios.
Resource
Assumes something like a rails resource for a restful model
Which adds opinionated JSON return types for the path:
And would create a schema for NewUser, User, and potential Users as a list, but this would be coupled to User model.
Todo
Justification
Injection can provide rapid development of the JSON schema, whilst also enforcing a convention.
If the convention is sensible, and idiomatic for example, just by building a folder structure, that mirrors the OpenAPI specification, then users will lean into it.
Is this open for extension?
Yes, injection/generation allows full flexibility, think of rails routes, or active model