Stack Overflow
Stack Overflow

Questions tagged [redoc]

94 questions
1
vote
0 answers

ReDocly Output with One Call Per Page?

Is it possible to generate output with Redocly or the Redocly CLI that has one request per page? And not all requests in a single, large, scrollable file? Commands like redoc-cli bundle -o index.html Sample.yaml create one file but with all the…
ForEachLoop
  • 2,508
  • 3
  • 18
  • 28
1
vote
2 answers

How to add a banner/label to redoc

Looking at the Redoc demo and they have used a "Webhook" label beside their title but I couldn't figure out how to implement it specifically for other labels. How would I be able to implement this to show a "Beta" label?
mocha
  • 45
  • 6
1
vote
0 answers

Is it possible to add authorization to ReDoc UI page? OPENAPI documentation

Is there a way to add authorization to redoc ui, so only registered users could have access to documentation and interactive api calls? Maybe, any integration with the Keycloak? API is using Flask, flask-smorest.
momo
  • 41
  • 1
  • 2
  • 5
1
vote
1 answer

Swagger/Redoc not showing

I am trying to get the XML comments working properly in the docs page, but am having trouble getting the to show. descriptions show just fine, but the remarks are missing completely. My Swagger config includes…
Dryden Long
  • 10,072
  • 2
  • 35
  • 47
1
vote
1 answer

Is there a way to import test files into redoc x-codeSamples source field?

The redoc guide specifies using raw text as source in a code sample: https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md#x-codeSamples like so: lang: JavaScript source: console.log('Hello World'); however I would like to…
nbenz
  • 41
  • 5
1
vote
0 answers

Displaying only certain properties of an OpenAPI reference

I didn't see anything specifically pertaining to this in the OpenAPI Reference, so I wanted to ask here for confirmation. Let's say I have a reference with the following data: components: schemas: Foobar: type: object …
Julian H. Lam
  • 25,501
  • 13
  • 46
  • 73
1
vote
0 answers

How to add Hierarchical Tags in Redoc

Currently Redoc only supports 2 depths of menu on the left hand panel. Is there any way, we can add one more depth? Someone has already created issue for this - https://github.com/Redocly/redoc/issues/1489
R.Srivastava
  • 31
  • 1
1
vote
1 answer

How to publish Redoc to gh-pages

I have completed the creation of docs using redoc along with all formatting. Now I want to publish it on github pages. There is a way where i can generate the static html pages using below command - npx redoc-cli bundle demo/openapi.yaml But one…
R.Srivastava
  • 31
  • 1
1
vote
0 answers

Some features tag is not working in .NET WebApi with ReDoc

I had installed Redoc with NSwag package in my WebApi projects. But I found that a lot of features are not working in the output API documents: No line break for the summary and remarks tag The tag of Example, code is not showing in the…
William Tang
  • 215
  • 1
  • 2
  • 8
1
vote
1 answer

Is it possible to pass an OpenAPI spec as a JSON object to ReDoc?

I created an OpenAPI JSON document for a RESTful service and am using ReDoc to display it. Is there a way to pass the OpenAPI spec as a JSON object directly to ReDoc without using a JSON file or URL? …
Shriom Tyagi
  • 21
  • 1
1
vote
2 answers

Redocly x-codeSamples Referenced File?

In Redocly, how is it possible to reference an external file in an x-codeSamples tag? The Redocly reference guide: https://redoc.ly/docs/api-reference-docs/vendor-extensions/redoc-supported-extensions/#x-codesamples In the following example, the…
ForEachLoop
  • 2,508
  • 3
  • 18
  • 28
1
vote
1 answer

drf-yasg: How to change operationId?

How do I change the name of the request that appears automatically in redoc-ui when using drf-yasg. For example: In the image, you can see that that the request is named fid_data-entities_update, it is picking this up from the URL. How do I…
Rohit Krishnan Vidyasagar
  • 23
  • 1
  • 5
1
vote
1 answer

Swagger schema properties ignored - why?

I'm trying to build a simple Swagger model: PlayerConfig: type: object required: - kind - player_id properties: kind: type: string example: PlayerConfig player_id: type: string example: "foo" …
Alex Ivanov
  • 393
  • 1
  • 5
  • 16
1
vote
1 answer

Sort by tags - Redoc UI

I have a swagger JSON where the tags are not in any particular order. I am trying to render this json in Redoc UI. Is there any way to render Redoc Ui with tags sorted alphabetically. Messages - API GET - API POST - API PUT - API…
Seethapriyanka Peddada
  • 530
  • 4
  • 7
1
vote
1 answer

Redoc side menu

I want to use Redoc for my API documentation. I also have swagger. I found here : https://github.com/Redocly/redoc this line - Integrate API Introduction into side menu - ReDoc takes advantage of markdown headings from OpenAPI description field. It…
andrey1567
  • 97
  • 1
  • 13
1 2
3
4 5 6 7