Stack Overflow
Stack Overflow

Questions tagged [redocly]

17 questions
2
votes
1 answer

Is $ref allowed in info.description in OpenAPI 3.0/3.1 documents?

The Redocly quick start has the following: info: description: $ref: ./info-description.md Running the Redocly CLI behaves correctly with this definition. Likewise running "redocly lint". Visual Studio, however, complains that the value of…
Scott Deerwester
  • 3,503
  • 4
  • 33
  • 56
2
votes
1 answer

OpenAPI Spec: what is suitable license for a private and internal OpenAPI doc?

My company uses Open API Spec to organize the doc for internal APIs and render it through UI tools, for example, redoc.ly or Swagger. The API doc is managed as a private git repo and will never be released to the public. License for private API…
Ryan Lyu
  • 4,180
  • 5
  • 35
  • 51
1
vote
1 answer

redocly-cli build command gives TypeError

I am trying to integrate Redocly with GitHub Actions. For testing purposes I have created an openapi.yaml file like this. I also have created a couple of sample schemas to use in this file. openapi: 3.1.0 info: version: 1.0.0 title: Example.com …
Nahid Bandi
  • 428
  • 1
  • 4
  • 23
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
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
1 answer

How to reference OpenAPI operation description from an external file?

Is it possible to reference OpenAPI operation description from an external file? Here is my sample code. I want to keep the description "This API is used to get user details" in a separate file and use it here like a variable or template or as a…
jestges
  • 3,686
  • 24
  • 59
  • 95
0
votes
1 answer

Why does "Invalid JSON pointer" error occurs when building API docs using Redocly?

I am trying to build an API doc using OpenAPI specifications. I am using Redocly CLI for building the UI by using this command: redocly build-docs openapi/openapi.yaml But I am getting this error: Found undefined and using theme.openapi…
Deep
  • 123
  • 1
  • 3
  • 16
0
votes
1 answer

Hide the "Download OpenAPI specification" button

I'm using FastAPI and I want the /redoc page to not display the Download button. IMAGE I know that users will still be able to download the specification, but I need to hide this button. FastApi automatically generates /redoc, how can I do this?
AnyWind
  • 1
  • 2
0
votes
0 answers

Generating Schema in API documentation with redocly

I am using redocly for generating API documentation. Currently redocly generates API documentation for endpoints (paths), but does not generate schema documentation. This blog on their website explains how to generate the schema section by…
Amrish
  • 679
  • 1
  • 8
  • 20
0
votes
0 answers

How to convert a multi-file open api 2.0 definition to 3.0 spec definition without changing the file structure

I have multi-file open api 2.0 definition, main file is called main_openapi.yaml that contains the top level fields and further details are in separate files. I want to convert this definition to 3.0 spec definition without changing the folder…
Pranay Soni
  • 11
  • 3
0
votes
1 answer

ReDocly Output with embedded Javascript

Is it possible to generate html output with all embedded resources and javascript files with redoc build-docs? Also I do not understand the section "Added the build-docs command which builds Redoc API docs into a zero-dependency HTML file." But…
MelleD
  • 657
  • 1
  • 9
  • 23
0
votes
0 answers

How to document json/yaml schema in restructured text

I would like to include json schema or yaml openapi or component/model object in restructured text. After a bit of googling i came across sphinx-jsonschema extension. But unfortunately the large table created is not very readable as my schmea is…
BhanuKiran
  • 2,631
  • 3
  • 20
  • 36
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 CLI command not found

I am trying to use Redocly CLI to split an OpenAPI definition file. It was working last night but doesn't work this morning. When I try to run a redocly command, for example: redocly lint openapi.yaml the output I get is: zsh: command not found:…
B Ahern
  • 11
  • 4
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
1
2