Skip to content

Commit 6590243

Browse files
committed
fixed - readonly fields are removed from request examples
1 parent 59d2484 commit 6590243

File tree

9 files changed

+68
-12
lines changed

9 files changed

+68
-12
lines changed

dist/rapidoc-min.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/rapidoc-min.js.gz

41 Bytes
Binary file not shown.

dist/report.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/example100.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,6 @@
5959
,"https://api.apis.guru/v2/specs/github.com/v3/swagger.json"
6060
,"https://api.apis.guru/v2/specs/box.com/2.0/openapi.json"
6161
,"https://api.apis.guru/v2/specs/twilio.com/2010-04-01/swagger.json"
62-
,"https://api.apis.guru/v2/specs/amadeus.com/1.2/swagger.json"
6362
,"https://api.apis.guru/v2/specs/stackexchange.com/2.0/swagger.json"
6463
,"https://api.apis.guru/v2/specs/cisco.com/0.0.3/swagger.json"
6564
,"https://api.apis.guru/v2/specs/googleapis.com/drive/v3/swagger.json"

docs/examples/specs/temp.json

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
{
2+
"openapi": "3.0.2",
3+
"info": {
4+
"title": "example API",
5+
"version": "TODO",
6+
"description": "TODO"
7+
},
8+
"paths": {
9+
"/groups/": {
10+
"post": {
11+
"operationId": "createGroup",
12+
"parameters": [],
13+
"requestBody": {
14+
"content": {
15+
"application/json": {
16+
"schema": {
17+
"required": [
18+
"members"
19+
],
20+
"properties": {
21+
"id": {
22+
"type": "integer",
23+
"readOnly": true
24+
},
25+
"name": {
26+
"type": "string",
27+
"maxLength": 100
28+
},
29+
"members": {
30+
"type": "array",
31+
"items": {
32+
"required": [],
33+
"properties": {
34+
"id": {
35+
"type": "integer",
36+
"readOnly": true
37+
},
38+
"name": {
39+
"type": "string",
40+
"maxLength": 100
41+
}
42+
}
43+
}
44+
}
45+
}
46+
}
47+
}
48+
}
49+
}
50+
}
51+
}
52+
}
53+
}

docs/rapidoc-min.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/components/api-request.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,10 @@ export default class ApiRequest extends LitElement {
284284
mimeReqObj.schema? mimeReqObj.schema.examples:'',
285285
mimeReqObj.schema? mimeReqObj.schema.example:'',
286286
mimeReqObj.schema,
287-
mimeReq, "text"
287+
mimeReq,
288+
false ,
289+
"text",
290+
288291
);
289292
textareaExampleHtml = textareaExampleHtml + `
290293
<textarea

src/components/api-response.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,14 @@ export default class ApiResponse extends LitElement {
111111
}
112112

113113
responseTemplate(){
114-
114+
if (!this.responses){
115+
return '';
116+
}
115117
let selectedMimeValueForEachStatus={};
116118
let headersForEachRespStatus={};
117119
let selectedMimeValue="";
118120
let mimeResponsesForEachStatus={};
119121
let mimeRespCountForEachStatus=0;
120-
121122
for(let statusCode in this.responses) {
122123
let allMimeResp={};
123124
let mimeRespCount=0;
@@ -143,6 +144,7 @@ export default class ApiResponse extends LitElement {
143144
mimeRespObj.schema? mimeRespObj.schema.example:'',
144145
mimeRespObj.schema,
145146
mimeResp,
147+
false,
146148
"json"
147149
);
148150
allMimeResp[mimeResp] = {
@@ -166,7 +168,6 @@ export default class ApiResponse extends LitElement {
166168
mimeResponsesForEachStatus[statusCode] = allMimeResp;
167169
}
168170

169-
170171
return html`${Object.keys(this.responses).map(
171172
(status, index) => html`
172173
<div class="resp-head ${index===0?'top-gap':'divider'}">

src/utils/common-utils.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ export function schemaToModel (schema, obj) {
194194

195195

196196
/* Create Example object */
197-
export function generateExample(examples, example, schema, mimeType, outputType){
197+
export function generateExample(examples, example, schema, mimeType, includeReadOnly=true, outputType){
198198
let finalExamples = [];
199199
if (examples){
200200
for (let eg in examples){
@@ -240,7 +240,7 @@ export function generateExample(examples, example, schema, mimeType, outputType)
240240
if (schema){
241241
//TODO: in case the mimeType is XML then parse it as XML
242242
if (mimeType.toLowerCase().includes("json") || mimeType.toLowerCase().includes("*/*")){
243-
let egJson = schemaToObj(schema,{}, {includeReadOnly:true, includeWriteOnly:true, deprecated:true});
243+
let egJson = schemaToObj(schema,{}, {includeReadOnly:includeReadOnly, includeWriteOnly:true, deprecated:true});
244244
finalExamples.push({
245245
"exampleType" : mimeType,
246246
"exampleValue": outputType==="text"?JSON.stringify(egJson,undefined,2):egJson

0 commit comments

Comments
 (0)