redocly / openapi-starter Goto Github PK

If I want to switch versions in a document，what can i do？

There are some simple instructions for adding code samples in the last section of the README, but they are quite short and don't explain why code samples are useful. Try the feature for yourself, and then expand the instructions and include the examples for someone else to use.

I would use _.

Relates to Redocly/redocly-cli#260

try it console feature is not visible

Describe the problem to be solved
No current example exists for a multi-file directory structure using multiple different forms of authentication.

Describe the solution you'd like
Include a components/schemas/securitySchemes example to illustrate how to implement the structure in other projects.

Describe alternatives you've considered
Also nice to add: examples in the multi-file guide.

Additional context
N/A

There are some simple instructions for adding code samples in the last section of the README, but they are quite short and don't explain why code samples are useful. Try the feature for yourself, and then expand the instructions and include the examples for someone else to use.

Redocly tools have support for an extension called x-traitTag. Include it as an example in our OpenAPI starter.

More information about the feature from our docs: https://redocly.com/docs/api-reference-docs/specification-extensions/x-trait-tag/

Some additional examples and updates to consider (make each one into an issue before you start working on it)

• callback
• examples for content type x-www-form-encoded and octet-stream
• #131
• XML schemas
• #130
• better response examples

(original list from #7)

This repo's spec is in OpenAPI 3.1.0:

But the links here are to the 3.0.2 markdown file when 3.1.0.md exists:

It may be enough to change the links and be done with it, but I am unsure if there's also other parts of this template that need a 3.0.2 -> 3.1.0 upgrade.

We have a simple API description, but to show off some more complex examples, add an example of using oneOf to the API description.

I'm trying to use the <PullRight> tag to move code into the right-hand column as described here:
https://redocly.com/docs/api-reference-docs/guides/embedded-markdown/#pull-right

I created a repo from this starter and added this section to info-description.md:

# Pullright test

Hello!

<PullRight>
This should be in the right pane.
</PullRight>

Here is some more text.

When I view this in the browser, the text is still in the center pane:

Here's my minimal reproduction:
https://github.com/timothymcmackin/redocly-api-ref-pullright

Is there something else I have to set up to use the PullRight tag?

This repo changed its root branch from master to main, but there are still links in this repo that point to the old master branch. These links are broken, as the website does the correct redirect to the assets, but it's an easy fix to update:
https://github.com/search?q=repo%3ARedocly%2Fopenapi-starter%20master&type=code

Hi,
Please add a 400 response after line 12:

It should then be:

responses:
    '200':
      description: OK
    '401': 
      description: Unauthorized

Otherwise, the Redocly log displays an error that at least one 4xx response should be in the file.

Thanks