@gitbook/react-openapi 1.1.9 → 1.2.0

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 (177) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/dist/InteractiveSection.d.ts +4 -0
  3. package/dist/InteractiveSection.jsx +14 -13
  4. package/dist/OpenAPICodeSample.d.ts +3 -2
  5. package/dist/OpenAPICodeSample.jsx +8 -12
  6. package/dist/OpenAPICodeSampleInteractive.d.ts +3 -0
  7. package/dist/OpenAPICodeSampleInteractive.jsx +37 -49
  8. package/dist/OpenAPICodeSampleSelector.d.ts +14 -0
  9. package/dist/OpenAPICodeSampleSelector.jsx +44 -0
  10. package/dist/OpenAPICopyButton.d.ts +2 -0
  11. package/dist/OpenAPICopyButton.jsx +5 -2
  12. package/dist/OpenAPIDisclosure.d.ts +4 -3
  13. package/dist/OpenAPIDisclosure.jsx +8 -11
  14. package/dist/OpenAPIDisclosureGroup.d.ts +7 -3
  15. package/dist/OpenAPIDisclosureGroup.jsx +18 -18
  16. package/dist/OpenAPIExample.d.ts +16 -0
  17. package/dist/OpenAPIExample.jsx +36 -0
  18. package/dist/OpenAPIMediaType.d.ts +21 -0
  19. package/dist/OpenAPIMediaType.jsx +61 -0
  20. package/dist/OpenAPIOperation.d.ts +3 -2
  21. package/dist/OpenAPIOperation.jsx +9 -72
  22. package/dist/OpenAPIOperationDescription.d.ts +9 -0
  23. package/dist/OpenAPIOperationDescription.jsx +22 -0
  24. package/dist/OpenAPIOperationStability.d.ts +9 -0
  25. package/dist/OpenAPIOperationStability.jsx +27 -0
  26. package/dist/OpenAPIPath.d.ts +12 -2
  27. package/dist/OpenAPIPath.jsx +10 -4
  28. package/dist/OpenAPIRequestBody.d.ts +3 -1
  29. package/dist/OpenAPIRequestBody.jsx +4 -3
  30. package/dist/OpenAPIResponse.d.ts +1 -1
  31. package/dist/OpenAPIResponse.jsx +1 -1
  32. package/dist/OpenAPIResponseExample.d.ts +4 -3
  33. package/dist/OpenAPIResponseExample.jsx +24 -154
  34. package/dist/OpenAPIResponseExampleContent.d.ts +19 -0
  35. package/dist/OpenAPIResponseExampleContent.jsx +57 -0
  36. package/dist/OpenAPIResponses.d.ts +1 -1
  37. package/dist/OpenAPIResponses.jsx +49 -36
  38. package/dist/OpenAPISchema.d.ts +1 -1
  39. package/dist/OpenAPISchema.jsx +121 -20
  40. package/dist/OpenAPISchemaName.d.ts +2 -0
  41. package/dist/OpenAPISchemaName.jsx +21 -17
  42. package/dist/OpenAPISchemaServer.d.ts +1 -1
  43. package/dist/OpenAPISecurities.d.ts +2 -1
  44. package/dist/OpenAPISecurities.jsx +11 -10
  45. package/dist/OpenAPISelect.d.ts +22 -0
  46. package/dist/OpenAPISelect.jsx +43 -0
  47. package/dist/OpenAPISpec.d.ts +3 -2
  48. package/dist/OpenAPISpec.jsx +11 -9
  49. package/dist/OpenAPITabs.jsx +9 -9
  50. package/dist/OpenAPIWebhook.d.ts +10 -0
  51. package/dist/OpenAPIWebhook.jsx +23 -0
  52. package/dist/OpenAPIWebhookExample.d.ts +6 -0
  53. package/dist/OpenAPIWebhookExample.jsx +41 -0
  54. package/dist/ScalarApiButton.d.ts +2 -0
  55. package/dist/ScalarApiButton.jsx +4 -3
  56. package/dist/StaticSection.d.ts +4 -1
  57. package/dist/StaticSection.jsx +13 -4
  58. package/dist/code-samples.js +57 -39
  59. package/dist/common/OpenAPIColumnSpec.d.ts +6 -0
  60. package/dist/common/OpenAPIColumnSpec.jsx +20 -0
  61. package/dist/common/OpenAPIOperationDescription.d.ts +6 -0
  62. package/dist/common/OpenAPIOperationDescription.jsx +19 -0
  63. package/dist/common/OpenAPIStability.d.ts +4 -0
  64. package/dist/common/OpenAPIStability.jsx +15 -0
  65. package/dist/common/OpenAPISummary.d.ts +6 -0
  66. package/dist/common/OpenAPISummary.jsx +30 -0
  67. package/dist/context.d.ts +75 -0
  68. package/dist/context.js +43 -0
  69. package/dist/generateSchemaExample.js +4 -0
  70. package/dist/getOrCreateStoreByKey.d.ts +10 -0
  71. package/dist/getOrCreateStoreByKey.js +19 -0
  72. package/dist/index.d.ts +5 -1
  73. package/dist/index.js +3 -0
  74. package/dist/resolveOpenAPIOperation.js +10 -5
  75. package/dist/resolveOpenAPIWebhook.d.ts +11 -0
  76. package/dist/resolveOpenAPIWebhook.js +127 -0
  77. package/dist/schemas/OpenAPISchemas.d.ts +5 -6
  78. package/dist/schemas/OpenAPISchemas.jsx +52 -49
  79. package/dist/schemas/resolveOpenAPISchemas.d.ts +4 -3
  80. package/dist/schemas/resolveOpenAPISchemas.js +0 -1
  81. package/dist/stringifyOpenAPI.d.ts +1 -1
  82. package/dist/stringifyOpenAPI.js +6 -3
  83. package/dist/translate.d.ts +10 -0
  84. package/dist/translate.jsx +75 -0
  85. package/dist/translations/de.d.ts +37 -0
  86. package/dist/translations/de.js +37 -0
  87. package/dist/translations/en.d.ts +37 -0
  88. package/dist/translations/en.js +37 -0
  89. package/dist/translations/es.d.ts +37 -0
  90. package/dist/translations/es.js +37 -0
  91. package/dist/translations/fr.d.ts +37 -0
  92. package/dist/translations/fr.js +37 -0
  93. package/dist/translations/index.d.ts +341 -0
  94. package/dist/translations/index.js +27 -0
  95. package/dist/translations/ja.d.ts +37 -0
  96. package/dist/translations/ja.js +37 -0
  97. package/dist/translations/nl.d.ts +37 -0
  98. package/dist/translations/nl.js +37 -0
  99. package/dist/translations/no.d.ts +37 -0
  100. package/dist/translations/no.js +37 -0
  101. package/dist/translations/pt-br.d.ts +37 -0
  102. package/dist/translations/pt-br.js +37 -0
  103. package/dist/translations/types.d.ts +5 -0
  104. package/dist/translations/types.js +1 -0
  105. package/dist/translations/zh.d.ts +37 -0
  106. package/dist/translations/zh.js +37 -0
  107. package/dist/tsconfig.build.tsbuildinfo +1 -1
  108. package/dist/types.d.ts +12 -48
  109. package/dist/util/example.d.ts +35 -0
  110. package/dist/util/example.jsx +103 -0
  111. package/dist/utils.d.ts +18 -0
  112. package/dist/utils.js +57 -0
  113. package/package.json +3 -3
  114. package/src/InteractiveSection.tsx +22 -18
  115. package/src/OpenAPICodeSample.tsx +26 -15
  116. package/src/OpenAPICodeSampleInteractive.tsx +67 -70
  117. package/src/OpenAPICodeSampleSelector.tsx +94 -0
  118. package/src/OpenAPICopyButton.tsx +7 -2
  119. package/src/OpenAPIDisclosure.tsx +20 -22
  120. package/src/OpenAPIDisclosureGroup.tsx +40 -22
  121. package/src/OpenAPIExample.tsx +55 -0
  122. package/src/OpenAPIMediaType.tsx +139 -0
  123. package/src/OpenAPIOperation.tsx +11 -104
  124. package/src/OpenAPIOperationDescription.tsx +34 -0
  125. package/src/OpenAPIOperationStability.tsx +39 -0
  126. package/src/OpenAPIPath.tsx +26 -6
  127. package/src/OpenAPIRequestBody.tsx +9 -4
  128. package/src/OpenAPIResponse.tsx +2 -2
  129. package/src/OpenAPIResponseExample.tsx +41 -215
  130. package/src/OpenAPIResponseExampleContent.tsx +123 -0
  131. package/src/OpenAPIResponses.tsx +83 -62
  132. package/src/OpenAPISchema.test.ts +80 -0
  133. package/src/OpenAPISchema.tsx +149 -25
  134. package/src/OpenAPISchemaName.tsx +28 -19
  135. package/src/OpenAPISchemaServer.tsx +1 -1
  136. package/src/OpenAPISecurities.tsx +46 -12
  137. package/src/OpenAPISelect.tsx +96 -0
  138. package/src/OpenAPISpec.tsx +21 -10
  139. package/src/OpenAPITabs.tsx +9 -9
  140. package/src/OpenAPIWebhook.tsx +33 -0
  141. package/src/OpenAPIWebhookExample.tsx +60 -0
  142. package/src/ScalarApiButton.tsx +6 -6
  143. package/src/StaticSection.tsx +37 -5
  144. package/src/code-samples.test.ts +3 -1
  145. package/src/code-samples.ts +67 -54
  146. package/src/common/OpenAPIColumnSpec.tsx +31 -0
  147. package/src/common/OpenAPIOperationDescription.tsx +31 -0
  148. package/src/common/OpenAPIStability.tsx +23 -0
  149. package/src/common/OpenAPISummary.tsx +45 -0
  150. package/src/context.ts +99 -0
  151. package/src/generateSchemaExample.test.ts +1020 -0
  152. package/src/generateSchemaExample.ts +5 -0
  153. package/src/getOrCreateStoreByKey.ts +33 -0
  154. package/src/index.ts +5 -1
  155. package/src/resolveOpenAPIOperation.ts +14 -3
  156. package/src/resolveOpenAPIWebhook.ts +99 -0
  157. package/src/schemas/OpenAPISchemas.tsx +76 -71
  158. package/src/schemas/resolveOpenAPISchemas.ts +4 -5
  159. package/src/stringifyOpenAPI.ts +11 -3
  160. package/src/translate.tsx +80 -0
  161. package/src/translations/de.ts +37 -0
  162. package/src/translations/en.ts +37 -0
  163. package/src/translations/es.ts +37 -0
  164. package/src/translations/fr.ts +37 -0
  165. package/src/translations/index.ts +33 -0
  166. package/src/translations/ja.ts +37 -0
  167. package/src/translations/nl.ts +37 -0
  168. package/src/translations/no.ts +37 -0
  169. package/src/translations/pt-br.ts +37 -0
  170. package/src/translations/types.ts +7 -0
  171. package/src/translations/zh.ts +37 -0
  172. package/src/types.ts +11 -46
  173. package/src/util/example.tsx +129 -0
  174. package/src/utils.ts +67 -0
  175. package/dist/useSyncedTabsGlobalState.d.ts +0 -10
  176. package/dist/useSyncedTabsGlobalState.js +0 -20
  177. package/src/useSyncedTabsGlobalState.ts +0 -35
@@ -0,0 +1,37 @@
1
+ export declare const nl: {
2
+ required: string;
3
+ deprecated: string;
4
+ deprecated_and_sunset_on: string;
5
+ stability_experimental: string;
6
+ stability_alpha: string;
7
+ stability_beta: string;
8
+ copy_to_clipboard: string;
9
+ copied: string;
10
+ no_content: string;
11
+ unresolved_reference: string;
12
+ circular_reference: string;
13
+ read_only: string;
14
+ write_only: string;
15
+ optional: string;
16
+ min: string;
17
+ max: string;
18
+ nullable: string;
19
+ body: string;
20
+ payload: string;
21
+ headers: string;
22
+ authorizations: string;
23
+ responses: string;
24
+ path_parameters: string;
25
+ query_parameters: string;
26
+ header_parameters: string;
27
+ attributes: string;
28
+ test_it: string;
29
+ information: string;
30
+ success: string;
31
+ redirect: string;
32
+ error: string;
33
+ show: string;
34
+ hide: string;
35
+ available_items: string;
36
+ child_attributes: string;
37
+ };
@@ -0,0 +1,37 @@
1
+ export var nl = {
2
+ required: 'Vereist',
3
+ deprecated: 'Verouderd',
4
+ deprecated_and_sunset_on: 'Deze bewerking is verouderd en wordt op ${1} beëindigd.',
5
+ stability_experimental: 'Experimenteel',
6
+ stability_alpha: 'Alfa',
7
+ stability_beta: 'Bèta',
8
+ copy_to_clipboard: 'Kopiëren naar klembord',
9
+ copied: 'Gekopieerd',
10
+ no_content: 'Geen inhoud',
11
+ unresolved_reference: 'Onopgeloste verwijzing',
12
+ circular_reference: 'Circulaire verwijzing',
13
+ read_only: 'Alleen lezen',
14
+ write_only: 'Alleen schrijven',
15
+ optional: 'Optioneel',
16
+ min: 'Min',
17
+ max: 'Max',
18
+ nullable: 'Null toegestaan',
19
+ body: 'Body',
20
+ payload: 'Payload',
21
+ headers: 'Headers',
22
+ authorizations: 'Autorisaties',
23
+ responses: 'Reacties',
24
+ path_parameters: 'Padparameters',
25
+ query_parameters: 'Queryparameters',
26
+ header_parameters: 'Headerparameters',
27
+ attributes: 'Attributen',
28
+ test_it: 'Test het',
29
+ information: 'Informatie',
30
+ success: 'Succes',
31
+ redirect: 'Omleiding',
32
+ error: 'Fout',
33
+ show: 'Toon',
34
+ hide: 'Verbergen',
35
+ available_items: 'Beschikbare items',
36
+ child_attributes: 'Kindattributen',
37
+ };
@@ -0,0 +1,37 @@
1
+ export declare const no: {
2
+ required: string;
3
+ deprecated: string;
4
+ deprecated_and_sunset_on: string;
5
+ stability_experimental: string;
6
+ stability_alpha: string;
7
+ stability_beta: string;
8
+ copy_to_clipboard: string;
9
+ copied: string;
10
+ no_content: string;
11
+ unresolved_reference: string;
12
+ circular_reference: string;
13
+ read_only: string;
14
+ write_only: string;
15
+ optional: string;
16
+ min: string;
17
+ max: string;
18
+ nullable: string;
19
+ body: string;
20
+ payload: string;
21
+ headers: string;
22
+ authorizations: string;
23
+ responses: string;
24
+ path_parameters: string;
25
+ query_parameters: string;
26
+ header_parameters: string;
27
+ attributes: string;
28
+ test_it: string;
29
+ information: string;
30
+ success: string;
31
+ redirect: string;
32
+ error: string;
33
+ show: string;
34
+ hide: string;
35
+ available_items: string;
36
+ child_attributes: string;
37
+ };
@@ -0,0 +1,37 @@
1
+ export var no = {
2
+ required: 'Påkrevd',
3
+ deprecated: 'Foreldet',
4
+ deprecated_and_sunset_on: 'Denne operasjonen er foreldet og vil bli avviklet den ${1}.',
5
+ stability_experimental: 'Eksperimentell',
6
+ stability_alpha: 'Alfa',
7
+ stability_beta: 'Beta',
8
+ copy_to_clipboard: 'Kopier til utklippstavle',
9
+ copied: 'Kopiert',
10
+ no_content: 'Ingen innhold',
11
+ unresolved_reference: 'Uavklart referanse',
12
+ circular_reference: 'Sirkulær referanse',
13
+ read_only: 'Skrivebeskyttet',
14
+ write_only: 'Kun skriving',
15
+ optional: 'Valgfri',
16
+ min: 'Min',
17
+ max: 'Maks',
18
+ nullable: 'Kan være null',
19
+ body: 'Brødtekst',
20
+ payload: 'Nyttelast',
21
+ headers: 'Overskrifter',
22
+ authorizations: 'Autorisasjoner',
23
+ responses: 'Responser',
24
+ path_parameters: 'Sti-parametere',
25
+ query_parameters: 'Forespørselsparametere',
26
+ header_parameters: 'Header-parametere',
27
+ attributes: 'Attributter',
28
+ test_it: 'Test det',
29
+ information: 'Informasjon',
30
+ success: 'Suksess',
31
+ redirect: 'Viderekobling',
32
+ error: 'Feil',
33
+ show: 'Vis',
34
+ hide: 'Skjul',
35
+ available_items: 'Tilgjengelige elementer',
36
+ child_attributes: 'Barneattributter',
37
+ };
@@ -0,0 +1,37 @@
1
+ export declare const pt_br: {
2
+ required: string;
3
+ deprecated: string;
4
+ deprecated_and_sunset_on: string;
5
+ stability_experimental: string;
6
+ stability_alpha: string;
7
+ stability_beta: string;
8
+ copy_to_clipboard: string;
9
+ copied: string;
10
+ no_content: string;
11
+ unresolved_reference: string;
12
+ circular_reference: string;
13
+ read_only: string;
14
+ write_only: string;
15
+ optional: string;
16
+ min: string;
17
+ max: string;
18
+ nullable: string;
19
+ body: string;
20
+ payload: string;
21
+ headers: string;
22
+ authorizations: string;
23
+ responses: string;
24
+ path_parameters: string;
25
+ query_parameters: string;
26
+ header_parameters: string;
27
+ attributes: string;
28
+ test_it: string;
29
+ information: string;
30
+ success: string;
31
+ redirect: string;
32
+ error: string;
33
+ show: string;
34
+ hide: string;
35
+ available_items: string;
36
+ child_attributes: string;
37
+ };
@@ -0,0 +1,37 @@
1
+ export var pt_br = {
2
+ required: 'Obrigatório',
3
+ deprecated: 'Obsoleto',
4
+ deprecated_and_sunset_on: 'Esta operação está obsoleta e será descontinuada em ${1}.',
5
+ stability_experimental: 'Experimental',
6
+ stability_alpha: 'Alfa',
7
+ stability_beta: 'Beta',
8
+ copy_to_clipboard: 'Copiar para a área de transferência',
9
+ copied: 'Copiado',
10
+ no_content: 'Sem conteúdo',
11
+ unresolved_reference: 'Referência não resolvida',
12
+ circular_reference: 'Referência circular',
13
+ read_only: 'Somente leitura',
14
+ write_only: 'Somente escrita',
15
+ optional: 'Opcional',
16
+ min: 'Mín',
17
+ max: 'Máx',
18
+ nullable: 'Nulo',
19
+ body: 'Corpo',
20
+ payload: 'Carga útil',
21
+ headers: 'Cabeçalhos',
22
+ authorizations: 'Autorizações',
23
+ responses: 'Respostas',
24
+ path_parameters: 'Parâmetros de rota',
25
+ query_parameters: 'Parâmetros de consulta',
26
+ header_parameters: 'Parâmetros de cabeçalho',
27
+ attributes: 'Atributos',
28
+ test_it: 'Testar',
29
+ information: 'Informação',
30
+ success: 'Sucesso',
31
+ redirect: 'Redirecionamento',
32
+ error: 'Erro',
33
+ show: 'Mostrar',
34
+ hide: 'Ocultar',
35
+ available_items: 'Itens disponíveis',
36
+ child_attributes: 'Atributos filhos',
37
+ };
@@ -0,0 +1,5 @@
1
+ import type { en } from './en';
2
+ export type TranslationKey = keyof typeof en;
3
+ export type Translation = {
4
+ [key in TranslationKey]: string;
5
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,37 @@
1
+ export declare const zh: {
2
+ required: string;
3
+ deprecated: string;
4
+ deprecated_and_sunset_on: string;
5
+ stability_experimental: string;
6
+ stability_alpha: string;
7
+ stability_beta: string;
8
+ copy_to_clipboard: string;
9
+ copied: string;
10
+ no_content: string;
11
+ unresolved_reference: string;
12
+ circular_reference: string;
13
+ read_only: string;
14
+ write_only: string;
15
+ optional: string;
16
+ min: string;
17
+ max: string;
18
+ nullable: string;
19
+ body: string;
20
+ payload: string;
21
+ headers: string;
22
+ authorizations: string;
23
+ responses: string;
24
+ path_parameters: string;
25
+ query_parameters: string;
26
+ header_parameters: string;
27
+ attributes: string;
28
+ test_it: string;
29
+ information: string;
30
+ success: string;
31
+ redirect: string;
32
+ error: string;
33
+ show: string;
34
+ hide: string;
35
+ available_items: string;
36
+ child_attributes: string;
37
+ };
@@ -0,0 +1,37 @@
1
+ export var zh = {
2
+ required: '必填',
3
+ deprecated: '已弃用',
4
+ deprecated_and_sunset_on: '此操作已弃用,将于 ${1} 停止使用。',
5
+ stability_experimental: '实验性',
6
+ stability_alpha: 'Alpha',
7
+ stability_beta: 'Beta',
8
+ copy_to_clipboard: '复制到剪贴板',
9
+ copied: '已复制',
10
+ no_content: '无内容',
11
+ unresolved_reference: '未解析的引用',
12
+ circular_reference: '循环引用',
13
+ read_only: '只读',
14
+ write_only: '只写',
15
+ optional: '可选',
16
+ min: '最小值',
17
+ max: '最大值',
18
+ nullable: '可为 null',
19
+ body: '请求体',
20
+ payload: '有效载荷',
21
+ headers: '头部信息',
22
+ authorizations: '授权',
23
+ responses: '响应',
24
+ path_parameters: '路径参数',
25
+ query_parameters: '查询参数',
26
+ header_parameters: '头参数',
27
+ attributes: '属性',
28
+ test_it: '测试一下',
29
+ information: '信息',
30
+ success: '成功',
31
+ redirect: '重定向',
32
+ error: '错误',
33
+ show: '显示',
34
+ hide: '隐藏',
35
+ available_items: '可用项',
36
+ child_attributes: '子属性',
37
+ };