Stack Overflow
Stack Overflow

Questions tagged [redoc]

94 questions
2
votes
1 answer

Have Schemas in Redoc side menu

Redoc is a great tool, but I'm struggling to understand how it works. Currently I've been tasked with copying some docs from api-docs.io to be self served using redoc. However, my issue is that the schemas aren't appearing in the side bar as they do…
osacognitive
  • 103
  • 7
2
votes
0 answers

Gitlab CI Integration - Generate Swagger Editor style Page

I have an OpenAPI yaml file that I have built in the Swagger Editor tool. I would now like to build a static site that looks exactly the same as that. I would like to incorporate this into a Gitlab CI/CD pipeline so that any changes are…
user8072194
2
votes
1 answer

How to automatically generate django rest framework documentation with parameters?

I use redoc + drf_yasg to generate the documentation of my api made with django-rest-framwork. It works well as soon as I add an entry point it appears well in the documentation. However, I don't understand how to add in the documentation the search…
darkvodka
  • 303
  • 1
  • 3
  • 11
2
votes
1 answer

API Documentation using OpenAPI Specification with multiple spec at a central place

We have a lot of micro services exposing their APIs and we have an API first approach. Each service has its own OpenApi3.0 spec file mostly in yaml or json format in their own git repo. However, like other companies in the wild, my team and other…
AbhishekAsh
  • 421
  • 2
  • 15
2
votes
0 answers

How can I hide enum constants from ReDoc?

I'm using OpenAPI v3 and springdoc and want to hide enum constants from ReDoc: Note that I don't want to hide the attribute status. I want its constants to not appear in the API docs. How can I do such a thing?
Hamza Belmellouki
  • 2,516
  • 1
  • 18
  • 39
2
votes
2 answers

Nswag specify multiple Response Example in Same Http Status Code?

i need to set some response example which have same http Status Code by C#. i have studied the post https://blog.rsuter.com/nswag-tutorial-implement-a-custom-operation-processor-to-define-redoc-code-samples/ but i still have no idea. how can i do…
Ci Ty Chen
  • 41
  • 1
  • 5
2
votes
1 answer

Include XML Comments for enums in Swagger and ReDoc based OpenAPI documentation

We have enums in our ASP.NET Core 2.2 project, commented on, like these: /// Theme for the UI public enum Theme { /// Dark backgrounds, lighter texts Dark, /// Light backgrounds with dark…
Jeroen
  • 60,696
  • 40
  • 206
  • 339
2
votes
1 answer

How to add x-code-samples for ReDoc with Swashbuckle.AspNetCore?

What's the best way to add x-code-samples for ReDoc to swagger.json through Swashbuckle.AspNetCore.Annotations? EDIT (March 30, 2019) I hope this is a better explanation. There is a way in Swashbuckle.AspNetCore to add content to the generated…
pemibo
  • 73
  • 1
  • 6
2
votes
1 answer

Add textual sections to Swagger using Swashbuckle

I'm using Swashbuckle with Redoc to document my ASP.NET Core 2.2 API. The live ReDoc demo has a set of sections at the top (e.g. "Introduction") with some custom html. I want to generate similar sections in my API but can't see how to do…
Jeroen
  • 60,696
  • 40
  • 206
  • 339
1
vote
1 answer

How to customize response messages for ReDoc OpenAPI documentation in FastAPI?

I have developed some FastAPI app, and want to customize its redoc documentation. Below is the code for it: from fastapi import FastAPI from typing import Optional import uvicorn app = FastAPI() class User(BaseModel): username: str user_list…
Aadhi Verma
  • 172
  • 2
  • 11
1
vote
1 answer

Sorting API paths in ReDoc with zircote/swagger-php (OpenAPI / Symfony)

I can't find a way to sort the API paths defined in my PHP annotations with zircote/swagger-php, i found nothing in OpenAPI specification nor in swagger-php documentation to achieve this. This related GitHub thread didn't help much. open-api.json…
NeyJâh
  • 11
  • 3
1
vote
1 answer

OpenAPI Schema Nested Models (more than 1 level)

Using OpenAPI 3+ and Redoc, and having issues with references not working once I go more than one level deep, is there something i'm doing wrong or missing here? openapi.yaml components: schemas: $ref:…
sMyles
  • 2,418
  • 1
  • 30
  • 44
1
vote
1 answer

Redoc documentation for tapir endpoint with sealed heirarchy not rendering as expected

I'm trying to define a tapir endpoint, which will accept two potential different payloads (in the snippet below, two different ways of defining a Thing). I'm broadly following the instructions here: https://circe.github.io/circe/codecs/adt.html, and…
user3468054
  • 610
  • 4
  • 11
1
vote
1 answer

ReDoc cannot display a local OpenAPI definition file

ReDoc displays a remote openapi.json normally: ReDoc - openapi.json …
Aleks Ya
  • 859
  • 5
  • 15
  • 27
1
vote
1 answer

How to generate html Docs for openapi components schema files

Here is the file structure. And I would like to generate html documentation for components/schemas/.. not for openapi.yaml which has endpoints. ├── code samples │ └── C# │ └── postundefined │ └── PHP │ └── postundefined ├──…
BhanuKiran
  • 2,631
  • 3
  • 20
  • 36
1
2
3 4 5 6 7