Skip to content

Commit 3e512a4

Browse files
authored
Merge branch 'master' into issue/631
2 parents 9fa0d04 + 91f92f7 commit 3e512a4

21 files changed

+1630
-1274
lines changed

dist/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
docEl.addEventListener('before-try', (e) => {
44
e.detail.request.headers.append('AAA-BBB', 'CCC DDDD');
55
});
6-
});</script><body><rapi-doc spec-url="./specs/temp.yaml" id="thedoc" theme="dark" render-style="read" schema-style="tree" use-path-in-nav-bar="true" show-components="true" show-info="true" show-header="true" allow-search="false" allow-advanced-search="true" allow-spec-url-load="false" allow-spec-file-load="false" allow-spec-file-download="true" allow-server-selection="true" allow-authentication="true" update-route="false" match-type="regex"></rapi-doc></body></html>
6+
});</script><body><rapi-doc spec-url="./specs/temp.yaml" id="thedoc" theme="dark" render-style="read" schema-style="tree" use-path-in-nav-bar="true" show-components="true" show-info="true" show-header="true" allow-search="false" allow-advanced-search="true" allow-spec-url-load="false" allow-spec-file-load="false" allow-spec-file-download="true" allow-server-selection="true" allow-authentication="true" update-route="false" match-type="regex" persist-auth="true"></rapi-doc></body></html>

dist/index.html.gz

8 Bytes
Binary file not shown.

dist/rapidoc-min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/rapidoc-min.js.LICENSE.txt.gz

0 Bytes
Binary file not shown.

dist/rapidoc-min.js.gz

939 Bytes
Binary file not shown.

dist/report.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

docker/Dockerfile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# to Build the Docker image from root folder execute
2+
# docker build -t mrin9/rapidoc -f ./docker/Dockerfile .
3+
14
# Run the Docker image (view a spec thats hosted on a web-server)
25
# docker run -it --rm -p 80:80 -e SPEC_URL="http://petstore.swagger.io/v2/swagger.json" mrin9/rapidoc
36

@@ -30,22 +33,19 @@ RUN npm run build
3033

3134
# production stage
3235
FROM nginx:stable-alpine as production-stage
33-
COPY --from=build-stage /app/dist /app
34-
COPY ./nginx/nginx.conf /etc/nginx/nginx.conf
3536

3637
ENV PAGE_TITLE="RapiDoc"
3738
ENV PAGE_FAVICON="favicon.png"
3839
ENV SPEC_URL="http://petstore.swagger.io/v2/swagger.json"
3940
ENV PORT=80
40-
ENV RAPIDOC_OPTIONS=
4141

4242
# copy files to the nginx folder
43-
COPY --from=0 build/dist /usr/share/nginx/html
43+
COPY --from=build-stage /app/dist /usr/share/nginx/html
4444
COPY docker/index.tpl.html /usr/share/nginx/html/index.html
4545
COPY logo.png /usr/share/nginx/html/favicon.png
4646
COPY docker/nginx.conf /etc/nginx/
4747
COPY docker/docker-run.sh /usr/local/bin
4848

4949
EXPOSE 80
5050

51-
CMD ["sh", "/usr/local/bin/docker-run.sh"]
51+
CMD ["sh", "/usr/local/bin/docker-run.sh"]

docs/api.html

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414

1515
<meta charset="utf-8">
1616
<meta name="viewport" content="width=device-width, minimum-scale=1, initial-scale=1, user-scalable=yes">
17-
<meta name="description" content="RapiDoc is Web Component for viewing Swagger & OpenAPI Spec. Supports themes, styling and various rendering styles">
18-
<meta name="keywords" content="RapiDoc, ReDoc, Swagger, SwaggerUI, Custom Element, Web Component, OpenAPI,REST, themes, dark mode, markdown, API documentation">
17+
<meta name="description" content="RapiDoc is a Web Component for viewing Swagger & OpenAPI Spec. Supports themes, styling and various rendering styles">
18+
<meta name="keywords" content="RapiDoc, openapi viewer, openapi to html, openapi renderer, ReDoc, Swagger, SwaggerUI, Custom Element, Web Component, OpenAPI, REST, themes, dark mode, markdown, API documentation">
1919

2020
<link rel="shortcut icon" type="image/png" href="./images/logo.png"/>
2121

@@ -147,6 +147,13 @@ <h2> Attributes</h2>
147147
</span> Request fields will be filled with example value (if provided in spec) </td>
148148
<td class='default-col'>true</td>
149149
</tr>
150+
151+
<tr>
152+
<td class="attr-col mono bold right">persist-auth </td>
153+
<td class="gray"><span class='bold dark-gray'>Allowed:<span class='blue'> true | false </span>
154+
</span> Authentication will be persisted to localStorage </td>
155+
<td class='default-col'>false</td>
156+
</tr>
150157
</table>
151158

152159
<a id="att-colors"></a>

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<meta charset="utf-8">
1616
<meta name="viewport" content="width=device-width, minimum-scale=1, initial-scale=1, user-scalable=yes">
1717
<meta name="description" content="RapiDoc is Web Component for viewing Swagger & OpenAPI Spec. Supports themes, styling and various rendering styles">
18-
<meta name="keywords" content="API, RapiDoc, ReDoc, stoplight, readme, Swagger, SwaggerUI, Custom Element, async-api, Web Component, web-hooks, OpenAPI, REST, themes, dark mode, markdown, API documentation, open api console, API mock, rest documentation">
18+
<meta name="keywords" content="RapiDoc, openapi viewer, openapi to html, openapi renderer, ReDoc, Swagger, SwaggerUI, Custom Element, Web Component, OpenAPI, REST, themes, dark mode, markdown, API documentation, API mock">
1919

2020
<link rel="shortcut icon" type="image/png" href="./images/logo.png"/>
2121

docs/list.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<meta charset="utf-8">
1515
<meta name="viewport" content="width=device-width, minimum-scale=1, initial-scale=1, user-scalable=yes">
1616
<meta name="description" content="RapiDoc is Web Component for viewing Swagger & OpenAPI Spec. Supports themes, styling and various rendering styles">
17-
<meta name="keywords" content="RapiDoc, ReDoc, Swagger, SwaggerUI, Custom Element, async-api, Web Component, web-hooks, OpenAPI, REST, themes, dark mode, markdown, API documentation">
17+
<meta name="keywords" content="RapiDoc, openapi viewer, openapi to html, openapi renderer, ReDoc, Swagger, SwaggerUI, Custom Element, Web Component, OpenAPI, REST, themes, dark mode, markdown, API documentation">
1818

1919
<link rel="shortcut icon" type="image/png" href="./images/logo.png"/>
2020

0 commit comments

Comments
 (0)