Questions tagged [redoc]
94 questions
0
votes
2 answers
Formatting similar to Rebelly API using Redoc
As per redoc github page, there is an example of real life usage for Rebilly API. I really like its formatting and would like to use as my formatting as well. I have created open api yaml file using redoc but formatting that comes out of box is not…
R.Srivastava
- 31
- 1
0
votes
1 answer
Openapi 3 - Inheritance & Polimorphism - redoc-cli
On my openapi yaml file I have a Layout schema, which has an attribute fields, which is an array of Field objects. My idea is to have a parent Field schema with common attributes, and some children schemas (TextInput, Select, Toggle, etc...) which…
Germán Medaglia
- 182
- 1
- 1
- 7
0
votes
0 answers
FastAPI/Redoc created 'openapi.json' is missing 'type' key for Enum params
I have a REST API build using FastAPI, with various query string params that are all working fine, generating working openapi.json output:
flagged: bool = False,
Generates:
{
"required": false,
"schema": {
"title": "Flagged",
"type":…
mikemaccana
- 110,530
- 99
- 389
- 494
0
votes
1 answer
OpenAPI 3.0 ref for array
I have recently delved into the OpenAPI specifications and have been making use of redoc-cli, however, I have come across a small problem.
I have the following:
"OrderResponse": {
"allOf": [
"$ref":…
kyapwc
- 322
- 2
- 4
- 9
0
votes
1 answer
TS6053 Building Swashbuckle.AspNetCore
I cloned Swashbuckle.AspNetCore and am trying to build it
However the node_modules folder is missing
I ran npm i redoc and got the following output
npm WARN saveError ENOENT: no such file or directory, open 'C:\Windows\System32\package.json'
npm…
Kirsten
- 15,730
- 41
- 179
- 318
0
votes
1 answer
How can I display error code description in sample code section?
I have an error code description displayed in the main section:
But I'd like also to display those code description in the example section here:
I saw some API docs that can generate those descriptions in the example section:
How can I do such a…
Hamza Belmellouki
- 2,516
- 1
- 18
- 39
0
votes
1 answer
OpenApi (Redoc) remote (network) nested references
We have a running Redoc server, which includes a bunch on yaml files with api specifications. However, a couple of neccesary yaml files are not on the local (let's call it RedocServer) machine.
Those remote files are accessible through aspnet-webapi…
Vladislav
- 1
- 1
0
votes
0 answers
How can I document a dynamic field using ReDoc?
I have a dynamic field defined on a request object like so:
///
/// Some description of this field
/// 17.5 or MyString in some cases
///
public dynamic MyField { get; set; }
However, in our docs, the…
WEFX
- 8,298
- 8
- 66
- 102
0
votes
1 answer
Loading JSON File without using an URL?
I created a JSON document for an OpenApi Restful service. I was wondering if there is anyway to load the json file without using an outsource website. Sorry if this is a dumb question im new to OpenApi.
Here is the html code;
Poyraz Kürkçüoğlu
- 89
- 12
0
votes
0 answers
Trying to add xml example of response in swagger but it doesn`t show
I am building an API Documentation with Swagger and I am writing directly in Notepad++ in the JSON it all woks fine but now I have a POST request that has a response example of type xml. This is the code that I have written
"/stareMesaj":
…
SECI
- 103
- 2
- 10
0
votes
1 answer
Error when trying to build html from json with redoc-build (JSON generated in Swagger)
I created a documentation in Swagger and I am trying to convert the json to html with redoc (from npm).
When I enter this command:
redoc-cli bundle -o index.html swagger.json
I get this error :
How can I solve this ? Thanks in advance
SECI
- 103
- 2
- 10
0
votes
0 answers
Adding dropdown in redoc create using properties file
In swagger redoc I have created external table using markdown, Now I need to create my own dropdown using markdown. Can you please help me out, that I can implement the same.
SurendraKumar Jaiswal
- 192
- 1
- 17
0
votes
0 answers
How to indicate OR JSON Objects in Documentation
Have a question regarding how to indicate OR in JSON Documentation(Using Swagger).
I would prefer not to have comments , indicating but wanted to know what is the typical way of showing this?
Say I have the following :
Method Type: PATCH
{
…
user60808
- 15
- 2
0
votes
1 answer
error when enabling ReDoc in API-Platform
API Platform version: 1.2
This is my current api_platform config file:
api_platform:
enable_swagger_ui: false
enable_re_doc: true
mapping:
paths: ['%kernel.project_dir%/src/Entity']
I got this Error when i enabled ReDoc:
(1/1)…
MrRobot
- 71
- 7
0
votes
1 answer
Swagger Redoc CORS issue with a json file hosted on another server
I'm trying to load a json file with redoc. That file is hosted on another server. I'm getting this error:
http://www.whatever-server.com/swagger/vs/swagger.json has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on…
Timur Ridjanovic
- 1,002
- 1
- 12
- 18