Questions tagged [redoc]
94 questions
0
votes
1 answer
How to enable "Expand all" in response samples in the Redoc page provided by FastAPI?
In Redoc, you can open the Response samples using the "Expand all" button:
I want to put this as the default value via custom_openapi(). Here is my code:
def custom_openapi():
if app.openapi_schema:
return app.openapi_schema
…
ovefuz ovefuze
- 1
- 2
0
votes
0 answers
How to hide the server host but show the base path in Redoc?
Currently Redoc includes the host URL in my API endpoint which I do not want it to do.
I tried several ways to hide it and only show the base path and endpoint in Redoc docs, but nothing seems to work.
Current behaviour -…
Danish Hasan
- 64
- 7
0
votes
1 answer
Redoc-cli discriminator
I have redoc-cli installed via npm
$ redoc-cli --version
0.13.20
Now I use it to build docs with the following
openapi: 3.1.0
info:
title: Sample API
version: '1.0'
contact:
email: some@email.com
description: Api description.
tags:
-…
Ondřej Navrátil
- 453
- 1
- 4
- 11
0
votes
0 answers
Redocly File References With Different Wording?
We have references in the OpenAPI to separate files, like described below. The problem is the description should be different in many cases but only by one word. For instance, in some cases it's "business unit", others as "consumer unit", and so…
ForEachLoop
- 2,508
- 3
- 18
- 28
0
votes
1 answer
Create custom index.html in asp.net core Redoc as Api-Documentation
I'm using Asp.net core with Swagger and the Redoc as API-Documentation:
app.UseReDoc(c =>
{
c.DocumentTitle = "API Documentation";
c.SpecUrl = "/swagger.json";
});
And the default route for api-docs is /api-docs/index.html
I…
Saeid Mirzaei
- 950
- 2
- 18
- 48
0
votes
1 answer
Remove path aliases from Redoc Documentation
When you have path aliases in openapi.yaml with $ref, for example
paths:
/municipios/{municipio}:
get:
operationId: getMunicipality
summary: Detalhes sobre Município
parameters:
- in: path
name: municipio
…
João Pimentel Ferreira
- 14,289
- 10
- 80
- 109
0
votes
1 answer
What is the reason of parse error in go-swagger redoc URL?
I was working on documentation for APIs. I've used Go-Swagger for the same. It's working for regular Docs but not for Redoc.
Here are my implementation details:
router.StaticFile("/swagger", "./api/swagger.yaml")
opts :=…
shantanu sharma
- 55
- 2
- 11
0
votes
0 answers
python 3.10 subprocess redoc-cli file not found
Using a FastAPI app, I upload a json file. The endpoint grabs the file, uploads it to a local folder, and then executes a command on the machine to generate an html API doc using Redoc CLI.
Using the CLI directly on Git Bash, it works perfectly:
$…
Kaiss B.
- 249
- 1
- 12
0
votes
1 answer
Add response example in SwashBuckle using methods/filters instead of controller attributes
I have an API which controllers are defined inside another project in a NuGet that I don't have control over, so I can't add attributes to the controller method or classes as it is usually done with SwashBuckle .
I need to add the swagger…
Lazaro
- 179
- 2
- 12
0
votes
1 answer
how to pass local file instead of url to redocstandalone specurl
I am trying to use redocstandalone component to host my openApi yaml file. The problem is that redocstandalone accepts a specUrl option which is accepting a url for the yaml file to be hosted. When I pass in the url of the hosted yaml file it works…
TritonKid
- 1
- 1
0
votes
0 answers
end of the stream or a document separator is expected in "http://localhost:3000/example.yaml" (36:47)
I am getting the error above and I saw plentry of similar post and they said it was a formatting issue with the yaml file. But I am using redocly cli to validate the yaml file by running redocly lint example.yaml and it returns Woohoo! Your OpenAPI…
TritonKid
- 1
- 1
0
votes
1 answer
spring boot API giving 404 when changing endpoint name
I am returning the HTML page located in the resources/static folder.
But, if it's like a single slash, it's working fine, giving me the HTML content. But when there is multiple slash added to the path its giving…
divine forever
- 41
- 8
0
votes
1 answer
How to document a JSON request body schema in tapir endpoint definition
I'm using tapir to define a series of endpoints, as follows:
def thingModifyState[M: Encoder: Decoder: Schema] =
endpoint.put
.name(s"Modify state of a $name Thing")
.description("Apply a modification object to a Thing")
…
user3468054
- 610
- 4
- 11
0
votes
0 answers
How to have a White Line insider of your pubspec.yaml
Hi i was wondering how to have whitelines in your pubspec.yamls description? Because when i use the ->. Syntax redocly doesn't match the whitelines
noonecious
- 63
- 1
- 1
- 6
0
votes
1 answer
rmarkdown collaboration without google drive
I am spinning up a project with 4-5 collaborators at all levels of R / markdown / git proficiency. Looking for a solution that allows editors of text/prose to stay in a word processing ecosystem to the extent practicable.
Saw this solution using…
M. Wood
- 450
- 4
- 13