jhthorsen / mojolicious-plugin-openapi

OpenAPI / Swagger plugin for Mojolicious
54 stars 44 forks source link

Mojolicious::Plugin::OpenAPI does not mention x-mojo-to #70

Closed KES777 closed 6 years ago

KES777 commented 6 years ago

x-mojo-to is mentioned on Tutorial, but should be described in main DOC too

jhthorsen commented 6 years ago

Why? And where?

KES777 commented 6 years ago

Mentioned here.

And not described here

jberger commented 6 years ago

The SYNOPSIS section specifically mentions

See Mojolicious::Plugin::OpenAPI::Guides::Tutorial for a tutorial on how to write a "full" app with application class and controllers.

Of which x-mojo-to is certainly most relevant. Currently there is essentially no description of routing in the main module documentation (which is usage information, configuration and helpers), all of that is saved for the tutorial. I'm not sure what is being asked for.

jhthorsen commented 6 years ago

@KES777: You just repeated your original comment and did not respond to my questions at all. I'll try to elaborate:

I can also add: Doing such a change will make it difficult to draw the line for what to add to the main module and what to keep in the tutorial.

KES777 commented 6 years ago

Why?

There should be a dictionary/context of module capabilities. With short description what options is it. The tutorial will describe whole picture: how to use this option

Where?

Create section in the bottom: Schema extended options x-mojo-name -- sets up route name x-mojo-to -- sets up controller for a generated route

jhthorsen commented 6 years ago

I don't agree with you. I will take a PR if it makes sense and gets upvotes.