question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[Questions] OpenAPI - Parameters & Schemas sections

See original GitHub issue

Aloah,

I currently tweak my OpenAPi/slate integration with widdershins and I encounter a special use case. By using default command like widdershins --summary -y apiName.yaml index.html.md

I have this result where FormRequest (Body Parameter of my Method) is present with the schema associated inside the Parameters section (See also the >> character associated). Notice there’s also a Schemas section in my main menu. screen shot 2017-11-20 at 16 01 34

When I use the same command line with --noschema parameter like widdershins --summary --noschema -y apiName.yaml index.html.md

I obtain this result. The parameters section only contains the FormRequest body parameter. Schemas section in my main menu is also not present. It makes the hyperlink to FormRequest impossible to use. screen shot 2017-11-20 at 15 58 53

My question is simple.

Is it possible to have the Schemas sections available AND not displaying the inline Parameters ( >> parameters) ?

I would prefer my user to click the FormRequest hyperlink to have access directly to the parameter schema instead of having it displaying inside the parameters section with the >> symbol.

Thanks in advance.

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:5 (3 by maintainers)

github_iconTop GitHub Comments

0reactions
MikeRalphsoncommented, Nov 22, 2017

Thanks, have confirmed no undefined is output using the stock templates.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Describing Parameters - Swagger
In OpenAPI 3.0, parameters are defined in the parameters section of an operation or path. To describe a parameter, you specify its name...
Read more >
swagger - Is it correct to use schemas of components for query ...
Yes, looks fine referring a schema from #components/schemas. Please refer below snap that confirms the same. PS: you can try out pasting ...
Read more >
OpenAPI Specification v3.1.0 | Introduction, Definitions, & More
The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs.
Read more >
OpenAPI Examples Need Help
There are examples in Schema Objects, Parameters, and Media Type Objects (Requests and Responses). Sometimes there is an example, ...
Read more >
Designing REST API with Open API Specification (OAS) v2.0 ...
The schema folder under openapi-3.0 contains the specification file ... The parameters section is a list of parameters represented as JSON ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found