rapidoc 9.2.0 → 9.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/.github/FUNDING.yml +13 -0
  2. package/CONTRIBUTING.md +1 -1
  3. package/README.md +13 -6
  4. package/dist/index.html +1 -1
  5. package/dist/index.html.gz +0 -0
  6. package/dist/rapidoc-min.js +472 -353
  7. package/dist/rapidoc-min.js.LICENSE.txt +9 -11
  8. package/dist/rapidoc-min.js.LICENSE.txt.gz +0 -0
  9. package/dist/rapidoc-min.js.gz +0 -0
  10. package/dist/rapidoc-min.js.map +1 -1
  11. package/dist/rapidoc-min.js.map.gz +0 -0
  12. package/dist/rapidoc.js +1839 -3420
  13. package/dist/report.html +2 -2
  14. package/index.html +6 -5
  15. package/package.json +22 -20
  16. package/src/components/api-request.js +184 -85
  17. package/src/components/api-response.js +8 -4
  18. package/src/components/json-tree.js +13 -2
  19. package/src/components/schema-table.js +40 -18
  20. package/src/components/schema-tree.js +41 -12
  21. package/src/json-schema-viewer.js +1 -2
  22. package/src/rapidoc-mini.js +23 -0
  23. package/src/rapidoc.js +54 -17
  24. package/src/styles/endpoint-styles.js +9 -9
  25. package/src/styles/font-styles.js +1 -1
  26. package/src/styles/nav-styles.js +3 -1
  27. package/src/styles/schema-styles.js +3 -1
  28. package/src/styles/tab-styles.js +1 -0
  29. package/src/templates/callback-template.js +8 -4
  30. package/src/templates/components-template.js +2 -0
  31. package/src/templates/endpoint-template.js +20 -15
  32. package/src/templates/expanded-endpoint-template.js +76 -71
  33. package/src/templates/header-template.js +1 -1
  34. package/src/templates/json-schema-viewer-template.js +1 -1
  35. package/src/templates/main-body-template.js +1 -1
  36. package/src/templates/navbar-template.js +21 -8
  37. package/src/templates/overview-template.js +1 -1
  38. package/src/templates/security-scheme-template.js +30 -20
  39. package/src/templates/server-template.js +2 -2
  40. package/src/utils/common-utils.js +1 -4
  41. package/src/utils/schema-utils.js +96 -57
  42. package/src/utils/spec-parser.js +1 -1
  43. package/src/utils/theme.js +13 -6
  44. package/webpack.config.js +1 -1
  45. package/.vscode/settings.json +0 -12
@@ -0,0 +1,13 @@
1
+ # These are supported funding model platforms
2
+
3
+ github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4
+ patreon: # Replace with a single Patreon username
5
+ open_collective: rapidoc
6
+ ko_fi: # Replace with a single Ko-fi username
7
+ tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8
+ community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9
+ liberapay: # Replace with a single Liberapay username
10
+ issuehunt: # Replace with a single IssueHunt username
11
+ otechie: # Replace with a single Otechie username
12
+ lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
13
+ custom: ['paypal.me/mrin'] # Replace with up to 4 custom sponsorship URLs e.g.,
package/CONTRIBUTING.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  For development
24
24
  ```shell
25
- git clone https://github.com/mrin9/RapiDoc.git
25
+ git clone https://github.com/rapi-doc/RapiDoc.git
26
26
  yarn install
27
27
  yarn serve
28
28
  # open http://localhost:8080
package/README.md CHANGED
@@ -1,10 +1,13 @@
1
- <img alt="MrinDoc logo" src="https://github.com/mrin9/RapiDoc/blob/master/logo.png" width="60px" />
1
+ <img alt="MrinDoc logo" src="https://github.com/rapi-doc/RapiDoc/blob/master/logo.png" width="60px" />
2
2
 
3
3
 
4
4
  <p align="center">
5
5
  <img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square"/>
6
- <img src="https://img.shields.io/github/size/mrin9/rapidoc/dist/rapidoc-min.js.svg?colorB=blue&label=minified&style=flat-square">
7
- <img src="https://img.shields.io/github/size/mrin9/rapidoc/dist/rapidoc-min.js.gz.svg?colorB=blue&label=zip&style=flat-square">
6
+ <img src="https://img.shields.io/github/size/rapi-doc/rapidoc/dist/rapidoc-min.js.svg?colorB=blue&label=minified&style=flat-square">
7
+ <img src="https://img.shields.io/github/size/rapi-doc/rapidoc/dist/rapidoc-min.js.gz.svg?colorB=blue&label=zip&style=flat-square">
8
+ <a href="https://discord.gg/X9evUeFY" alt="Join us on Discord">
9
+ <img src="https://img.shields.io/discord/848913990360629268?style=flat-square" />
10
+ </a>
8
11
  <a href="https://www.webcomponents.org/element/rapidoc" alt="published on webcomponents.org">
9
12
  <img src="https://img.shields.io/badge/webcomponents.org-rapidoc-blue.svg?style=social"/>
10
13
  </a>
@@ -13,6 +16,10 @@
13
16
  # RapiDoc
14
17
  Custom Element for Open-API spec viewing
15
18
 
19
+ Join the [RapiDoc community on Discord](https://discord.gg/X9evUeFY)
20
+
21
+ Sponsored by [Zuplo](https://zuplo.link/rapidoc-2) - Get a Stripe-like API experience for your customers in minutes - documentation, rate-limiting and API-key auth in minutes.
22
+
16
23
  ## Features
17
24
  - Supports Swagger 2.0, OpenAPI 3.x.x
18
25
  - Works with any framework or with no framework
@@ -42,10 +49,10 @@ Custom Element for Open-API spec viewing
42
49
 
43
50
 
44
51
  ## Documentation
45
- [Check out the usage and demos](https://mrin9.github.io/RapiDoc/)
52
+ [Check out the usage and demos](https://rapi-doc.github.io/RapiDoc/)
46
53
 
47
54
  ## Examples
48
- [Examples and Test cases](https://mrin9.github.io/RapiDoc/list.html)
55
+ [Examples and Test cases](https://rapi-doc.github.io/RapiDoc/list.html)
49
56
 
50
57
 
51
58
  ## Build Process
@@ -62,7 +69,7 @@ npm run serve
62
69
  ```
63
70
 
64
71
  ## Roadmap
65
- - Upgrade to use `lit 2`
72
+ - ✅ Upgrade to use `lit 2`
66
73
  - Pre Rendering / Server Side Rendering (SSR) of RapiDoc
67
74
  - Improve PDF generation of OpenAPI spec Using RapiPDF
68
75
  - Create a Command Line interface (CLI) to make it automation friendly
package/dist/index.html CHANGED
@@ -3,4 +3,4 @@
3
3
  docEl.addEventListener('before-try', (e) => {
4
4
  e.detail.request.headers.append('AAA-BBB', 'CCC DDDD');
5
5
  });
6
- });</script><body><rapi-doc spec-url="./specs/aaa.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>
6
+ });</script><body><rapi-doc spec-url="./specs/temp.yaml" id="thedoc" theme="dark" render-style="view" schema-style="table" show-method-in-nav-bar="true" 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-download="true" allow-server-selection="true" allow-authentication="true" update-route="false" match-type="regex" persist-auth="true"></rapi-doc></body></html>
Binary file