TASK: Configure and render documents by name #1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change adds a the configuration of the available spec documents to the setting and uses the document names as basis for rendering via cli-command and controller. Th cli `./flow .openapi:document __name__` will render the same spec as `openapi/specs/__name__`. Also the setting `schemaTargetFilePath` is removed. The cli will output the spec directly to the shell where it can be sent wherever it is needed.
mficzel
force-pushed
the
task/configureAndRenderDocumentsByName
branch
from
c553faa
to
9be4455
Compare
mficzel
force-pushed
the
task/configureAndRenderDocumentsByName
branch
from
9be4455
to
5d5c359
Compare
nezaniel
requested changes
Mar 21, 2024
| /** | ||
| * @param string $name the name of the api document to render | ||
| */ | ||
| public function documentCommand(string $name): void |
There was a problem hiding this comment.
I really like the convention of class methods being or containing verbs; In this case I instantly wonder what is about to be documented. So I'd prefer openapi:renderdocument or openapidocument:render
|
|
||
| class OpenApiController extends ActionController | ||
| { | ||
| protected $defaultViewObjectName = JsonView::class; |
There was a problem hiding this comment.
I think we don't need to declare a view if we return string
| #[Flow\Inject] | ||
| protected OpenApiDocumentRepository $documentRepository; | ||
|
|
||
| public function documentAction(string $name): string |
There was a problem hiding this comment.
same as the command controller. In this case specifically, I'd prefer openapidocument/render, because we already have an OpenApiController
|
Agree. Will address on the refactoring branch |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 change adds a the configuration of the available spec documents to the setting and uses the document names as basis for rendering via cli-command and controller.
Th cli
./flow .openapi:document __name__will render the same spec asopenapi/specs/__name__.Also the setting
schemaTargetFilePathis removed. The cli will output the spec directly to the shell where it can be sent wherever it is needed.