@redocly/openapi-docs 3.12.0 → 3.12.2
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.
- package/dist/redocly-openapi-docs.min.js +753 -750
- package/lib/components/ApiInfo/ApiInfo.js +29 -1
- package/lib/components/ApiInfo/Metadata.js +29 -1
- package/lib/components/ApiInfo/index.js +2 -1
- package/lib/components/ApiInfo/styled.js +16 -8
- package/lib/components/CallbackSamples/CallbackSamples.js +25 -4
- package/lib/components/CallbackSamples/index.js +2 -1
- package/lib/components/Callbacks/CallbackDetails.js +17 -3
- package/lib/components/Callbacks/CallbackOperation.js +24 -3
- package/lib/components/Callbacks/CallbackSummary.js +19 -3
- package/lib/components/Callbacks/CallbacksList.js +16 -1
- package/lib/components/Callbacks/index.js +4 -1
- package/lib/components/Callbacks/styled.js +6 -3
- package/lib/components/Content/Content.js +10 -1
- package/lib/components/Content/index.js +2 -1
- package/lib/components/Content/useAutoScroll.js +50 -1
- package/lib/components/ContentItem/ContentItem.js +31 -1
- package/lib/components/ContentItem/index.js +2 -1
- package/lib/components/ContentItem/useIsExpanded.js +33 -1
- package/lib/components/ContentItems/ContentItems.js +19 -1
- package/lib/components/ContentItems/Items.js +13 -1
- package/lib/components/ContentItems/VirtualList.js +35 -1
- package/lib/components/ContentItems/helpers.js +49 -1
- package/lib/components/ContentItems/index.js +2 -1
- package/lib/components/ContentItems/useScrollOnRender.js +26 -1
- package/lib/components/Discriminator/Discriminator.js +27 -2
- package/lib/components/Discriminator/index.js +2 -1
- package/lib/components/Download/DownloadSpecification.js +46 -4
- package/lib/components/Download/index.js +2 -1
- package/lib/components/Download/types.js +2 -0
- package/lib/components/Download/useDownloadInfo.js +42 -1
- package/lib/components/ErrorBoundary/ErrorBoundary.js +22 -2
- package/lib/components/ErrorBoundary/index.js +2 -1
- package/lib/components/ExpandAllButton/ExpandAllButton.js +31 -2
- package/lib/components/ExpandAllButton/index.js +2 -1
- package/lib/components/ExternalDocumentation/ExternalDocumentation.js +18 -4
- package/lib/components/ExternalDocumentation/index.js +2 -1
- package/lib/components/Language/LanguageDropdown.js +21 -1
- package/lib/components/Language/LanguageItem.js +33 -1
- package/lib/components/Language/LanguageList.js +93 -1
- package/lib/components/Language/_tests_/LanguageDropdown.test.js +23 -1
- package/lib/components/Language/constants.js +3 -1
- package/lib/components/Language/index.js +4 -1
- package/lib/components/Language/styled.js +29 -15
- package/lib/components/Markdown/Markdown.js +64 -1
- package/lib/components/Markdown/index.js +3 -1
- package/lib/components/Markdown/types.js +2 -0
- package/lib/components/MediaTypeSwitch/MediaTypesSwitch.js +51 -1
- package/lib/components/MediaTypeSwitch/index.js +2 -1
- package/lib/components/OperationItem/Description.js +9 -1
- package/lib/components/OperationItem/OperationItem.js +70 -5
- package/lib/components/OperationItem/_tests_/OperationItem.test.js +70 -1
- package/lib/components/OperationItem/_tests_/__mocks__/mock-intersection-observer.js +40 -1
- package/lib/components/OperationItem/index.js +2 -1
- package/lib/components/OperationItem/types.js +2 -0
- package/lib/components/Overlay.js +48 -3
- package/lib/components/Overview/Overview.js +20 -1
- package/lib/components/Overview/index.js +2 -1
- package/lib/components/PageFooter/PageFooter.js +19 -1
- package/lib/components/PageFooter/index.js +2 -1
- package/lib/components/Panel/ResponsePanel.js +12 -6
- package/lib/components/Panel/Trigger.js +4 -2
- package/lib/components/Panel/index.js +3 -1
- package/lib/components/PanelItem/PanelItem.js +6 -1
- package/lib/components/PanelItem/index.js +3 -1
- package/lib/components/PanelItem/styled.js +20 -10
- package/lib/components/PayloadSamples/Example.js +6 -1
- package/lib/components/PayloadSamples/ExampleValue.js +30 -1
- package/lib/components/PayloadSamples/MediaTypeSamples.js +36 -2
- package/lib/components/PayloadSamples/PayloadSamples.js +26 -1
- package/lib/components/PayloadSamples/index.js +7 -1
- package/lib/components/PayloadSamples/styled.js +9 -4
- package/lib/components/PayloadSamples/types.js +2 -0
- package/lib/components/PropertyDetails/DescriptionEnums.js +19 -3
- package/lib/components/PropertyDetails/EnumValues.js +37 -1
- package/lib/components/PropertyDetails/Examples.js +26 -1
- package/lib/components/PropertyDetails/Extensions.js +17 -2
- package/lib/components/PropertyDetails/FieldDetail.js +15 -2
- package/lib/components/PropertyDetails/FieldDetails.js +51 -6
- package/lib/components/PropertyDetails/Pattern.js +21 -1
- package/lib/components/PropertyDetails/PlusCircleIcon.js +10 -4
- package/lib/components/PropertyDetails/PropertyDetails.js +22 -5
- package/lib/components/PropertyDetails/SchemaTypeInfo.js +10 -2
- package/lib/components/PropertyDetails/SimpleEnums.js +13 -2
- package/lib/components/PropertyDetails/cycleColorsByLevel.js +18 -1
- package/lib/components/PropertyDetails/index.js +4 -1
- package/lib/components/PropertyDetails/styled.js +15 -7
- package/lib/components/PropertyDetails/types.js +2 -0
- package/lib/components/RedoclyOpenAPIDocs/Providers.js +114 -1
- package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocs.js +57 -1
- package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsStandalone.js +86 -1
- package/lib/components/RedoclyOpenAPIDocs/index.js +5 -1
- package/lib/components/RedoclyOpenAPIDocs/styled.js +4 -2
- package/lib/components/RedoclyOpenAPIDocs/types.js +2 -0
- package/lib/components/RedoclyOpenAPIDocs/utils.js +33 -1
- package/lib/components/RenderHook/RenderHook.js +17 -1
- package/lib/components/RenderHook/index.js +2 -1
- package/lib/components/Replay/EmbeddedReplay.js +41 -3
- package/lib/components/Replay/Replay.js +99 -1
- package/lib/components/Replay/index.js +3 -1
- package/lib/components/Replay/utils.js +208 -1
- package/lib/components/Request/RequestDetails.js +33 -2
- package/lib/components/Request/types.js +2 -0
- package/lib/components/RequestParameters/Body.js +8 -1
- package/lib/components/RequestParameters/ParametersGroup.js +19 -4
- package/lib/components/RequestParameters/RequestParameters.js +40 -1
- package/lib/components/RequestParameters/index.js +4 -1
- package/lib/components/RequestSamples/CodeSample.js +55 -2
- package/lib/components/RequestSamples/Example.js +37 -1
- package/lib/components/RequestSamples/RequestSamples.js +89 -5
- package/lib/components/RequestSamples/index.js +3 -1
- package/lib/components/RequestSamples/useCodeSamples.js +92 -1
- package/lib/components/ResponseSamples/ResponseSamples.js +47 -1
- package/lib/components/ResponseSamples/Summary.js +9 -1
- package/lib/components/ResponseSamples/index.js +2 -1
- package/lib/components/Responses/OperationResponseList.js +42 -2
- package/lib/components/Responses/ResponseDetails.js +18 -1
- package/lib/components/Responses/ResponseHeaders.js +15 -1
- package/lib/components/Responses/index.js +6 -1
- package/lib/components/Responses/styled.js +14 -6
- package/lib/components/Responses/types.js +2 -0
- package/lib/components/RightPanel/RightPanel.js +21 -1
- package/lib/components/RightPanel/index.js +2 -1
- package/lib/components/Samples/ExampleSwitch.js +33 -1
- package/lib/components/Samples/index.js +3 -1
- package/lib/components/Samples/use-example-key.js +12 -1
- package/lib/components/Schema/ArraySchema.js +45 -1
- package/lib/components/Schema/ObjectSchema.js +29 -1
- package/lib/components/Schema/OneOfSchema.js +47 -3
- package/lib/components/Schema/RecursiveSchema.js +10 -1
- package/lib/components/Schema/Schema.js +63 -2
- package/lib/components/Schema/SubSchema.js +20 -1
- package/lib/components/Schema/helpers.js +16 -1
- package/lib/components/Schema/index.js +5 -1
- package/lib/components/Schema/types.js +2 -0
- package/lib/components/Schema/useOneOfLocationIdx.js +11 -1
- package/lib/components/SchemaDefinition/SchemaDefinition.js +65 -2
- package/lib/components/SchemaDefinition/index.js +2 -1
- package/lib/components/SectionContent/SectionContent.js +49 -6
- package/lib/components/SectionContent/index.js +2 -1
- package/lib/components/SectionItem/SectionItem.js +14 -1
- package/lib/components/SectionItem/index.js +2 -1
- package/lib/components/Security/Divider.js +9 -2
- package/lib/components/Security/OAuthFlow.js +11 -1
- package/lib/components/Security/OAuthScopes.js +59 -9
- package/lib/components/Security/Security.js +15 -1
- package/lib/components/Security/SecurityButton.js +31 -7
- package/lib/components/Security/SecurityFlow.js +28 -4
- package/lib/components/Security/SecurityModal.js +34 -5
- package/lib/components/Security/SecuritySchemeItem.js +15 -4
- package/lib/components/Security/helper.js +16 -1
- package/lib/components/Security/index.js +11 -1
- package/lib/components/Security/styled.js +6 -3
- package/lib/components/SelectOrLabel/SelectOrLabel.js +12 -2
- package/lib/components/SelectOrLabel/index.js +2 -1
- package/lib/components/ServerList/ServerList.js +36 -10
- package/lib/components/ServerList/index.js +2 -1
- package/lib/components/ServerList/types.js +2 -0
- package/lib/components/ServerListDropdown/ServerListDropdown.js +54 -1
- package/lib/components/ServerListDropdown/index.js +2 -1
- package/lib/components/ServerListDropdown/styled.js +15 -6
- package/lib/components/SideMenu/SideMenu.js +13 -2
- package/lib/components/SideMenu/hooks/useMenuItems.js +110 -1
- package/lib/components/SideMenu/index.js +2 -1
- package/lib/components/SideMenu/types.js +2 -0
- package/lib/components/StickySidebar/SidebarActions.js +14 -2
- package/lib/components/StickySidebar/StickyResponsiveSidebar.js +37 -7
- package/lib/components/StickySidebar/index.js +2 -1
- package/lib/components/Tabs/Tabs.js +16 -5
- package/lib/components/Tabs/index.js +3 -1
- package/lib/components/Tabs/useTabsState.js +22 -1
- package/lib/components/TagItem/OperationNavigationItems.js +18 -4
- package/lib/components/TagItem/OperationsNavigation.js +46 -2
- package/lib/components/TagItem/TagItem.js +40 -7
- package/lib/components/TagItem/index.js +2 -1
- package/lib/components/TagItem/styled.js +5 -2
- package/lib/components/TagItem/types.js +2 -0
- package/lib/components/ViewNested/ViewNested.js +42 -9
- package/lib/components/ViewNested/index.js +2 -1
- package/lib/components/common/Badges.js +21 -5
- package/lib/components/common/BodyContent/BodyContent.js +31 -4
- package/lib/components/common/BodyContent/index.js +2 -1
- package/lib/components/common/ClearButton/ClearButton.js +5 -1
- package/lib/components/common/ClearButton/index.js +3 -1
- package/lib/components/common/ClearButton/styled.js +5 -2
- package/lib/components/common/ClearButton/types.js +2 -0
- package/lib/components/common/CodeBlockPanel.js +7 -3
- package/lib/components/common/ConstraintsView.js +14 -2
- package/lib/components/common/Dropdown/Dropdown.js +22 -4
- package/lib/components/common/Dropdown/index.js +2 -1
- package/lib/components/common/ExpandableExample/ExpandableExample.js +24 -3
- package/lib/components/common/ExpandableExample/index.js +2 -1
- package/lib/components/common/Extensions.js +17 -2
- package/lib/components/common/Fields/fields-layout.js +76 -51
- package/lib/components/common/Fields/fields.js +39 -17
- package/lib/components/common/Fields/index.js +3 -1
- package/lib/components/common/LinkToField.js +33 -6
- package/lib/components/common/OperationItemTitle.js +12 -6
- package/lib/components/common/SchemaSelection/SchemaSelection.js +51 -1
- package/lib/components/common/SchemaSelection/index.js +2 -1
- package/lib/components/common/Select/Select.js +21 -1
- package/lib/components/common/Select/index.js +3 -1
- package/lib/components/common/Select/styled.js +17 -9
- package/lib/components/common/Select/types.js +2 -0
- package/lib/components/common/Skeleton/LanguageListSkeleton.js +16 -6
- package/lib/components/common/Skeleton/Skeleton.js +15 -5
- package/lib/components/common/Skeleton/index.js +3 -1
- package/lib/components/common/headers.js +4 -2
- package/lib/components/common/index.js +14 -1
- package/lib/components/common/linkify.js +28 -4
- package/lib/components/common/mixins.js +4 -2
- package/lib/components/common/panels.js +52 -29
- package/lib/components/common/schema.js +16 -8
- package/lib/components/common/styled.js +15 -7
- package/lib/components/index.js +25 -1
- package/lib/components/pluggable/RedocExample.js +20 -1
- package/lib/components/pluggable/RedocSchema.js +22 -1
- package/lib/components/pluggable/index.js +3 -1
- package/lib/components/pluggable/styled.components.js +9 -4
- package/lib/constants.js +30 -1
- package/lib/empty.js +7 -1
- package/lib/events/codeSampleCopy.js +19 -1
- package/lib/events/creator.js +5 -1
- package/lib/events/index.js +8 -1
- package/lib/events/languageSwitch.js +18 -1
- package/lib/events/panelToggle.js +16 -1
- package/lib/events/serverSwitch.js +13 -1
- package/lib/events/tryItOpen.js +12 -1
- package/lib/events/tryItSent.js +12 -1
- package/lib/events/types.js +11 -1
- package/lib/hoc/types.js +2 -0
- package/lib/hoc/utils.js +4 -1
- package/lib/hoc/withRouter.js +17 -1
- package/lib/hoc/withStore.js +28 -1
- package/lib/hooks/index.js +9 -1
- package/lib/hooks/useActivateExample.js +35 -1
- package/lib/hooks/useActiveWithFallback.js +12 -1
- package/lib/hooks/useContentItems.js +10 -1
- package/lib/hooks/useLicense.js +17 -1
- package/lib/hooks/usePerformanceMetrics.js +26 -1
- package/lib/hooks/useRouter.js +17 -1
- package/lib/hooks/useTelemetry.js +5 -1
- package/lib/hooks/useTranslate.js +6 -1
- package/lib/hooks/useUppercase2LowercaseRedirect.js +12 -1
- package/lib/icons/CSharpIcon/CSharpIcon.js +7 -1
- package/lib/icons/CSharpIcon/index.js +2 -1
- package/lib/icons/CurlIcon/CurlIcon.js +8 -2
- package/lib/icons/CurlIcon/index.js +2 -1
- package/lib/icons/GOIcon/GOIcon.js +7 -1
- package/lib/icons/GOIcon/index.js +2 -1
- package/lib/icons/JavaIcon/JavaIcon.js +7 -1
- package/lib/icons/JavaIcon/index.js +2 -1
- package/lib/icons/JavaScriptIcon/JavaScriptIcon.js +7 -1
- package/lib/icons/JavaScriptIcon/index.js +2 -1
- package/lib/icons/NodeJSIcon/NodeJSIcon.js +7 -1
- package/lib/icons/NodeJSIcon/index.js +2 -1
- package/lib/icons/PHPIcon/PHPIcon.js +7 -1
- package/lib/icons/PHPIcon/index.js +2 -1
- package/lib/icons/PayloadIcon/PayloadIcon.js +7 -1
- package/lib/icons/PayloadIcon/index.js +2 -1
- package/lib/icons/PythonIcon/PythonIcon.js +7 -1
- package/lib/icons/PythonIcon/index.js +2 -1
- package/lib/icons/RIcon/RIcon.js +7 -1
- package/lib/icons/RIcon/index.js +2 -1
- package/lib/icons/RubyIcon/RubyIcon.js +7 -1
- package/lib/icons/RubyIcon/index.js +2 -1
- package/lib/index.js +49 -1
- package/lib/jotai/app.js +113 -1
- package/lib/jotai/operation.js +28 -1
- package/lib/jotai/replay.js +5 -1
- package/lib/jotai/store.js +8 -1
- package/lib/jotai/use-write-atom.js +9 -1
- package/lib/models/callback.js +28 -1
- package/lib/models/code-sample-options.js +2 -0
- package/lib/models/example.js +17 -1
- package/lib/models/field.js +109 -1
- package/lib/models/group.js +38 -1
- package/lib/models/index.js +14 -1
- package/lib/models/mediaContent.js +26 -1
- package/lib/models/mediaType.js +153 -1
- package/lib/models/operation.js +166 -1
- package/lib/models/request.js +25 -1
- package/lib/models/response.js +46 -1
- package/lib/models/schema.js +474 -2
- package/lib/models/security.js +84 -1
- package/lib/models/tab.js +2 -0
- package/lib/models/types.js +2 -0
- package/lib/services/OpenAPIParser.js +321 -1
- package/lib/services/check.js +104 -1
- package/lib/services/code-samples/constants.js +16 -1
- package/lib/services/code-samples/generator.js +540 -1
- package/lib/services/code-samples/httpsnippet/helpers/code-builder.js +252 -3
- package/lib/services/code-samples/httpsnippet/helpers/code-helpers.js +90 -2
- package/lib/services/code-samples/httpsnippet/helpers/constants.js +28 -1
- package/lib/services/code-samples/httpsnippet/helpers/lodash-int.js +173 -1
- package/lib/services/code-samples/httpsnippet/helpers/mocks/code-helpers-mock.js +76 -37
- package/lib/services/code-samples/httpsnippet/helpers/reducer.js +16 -1
- package/lib/services/code-samples/httpsnippet/helpers/shell.js +20 -1
- package/lib/services/code-samples/httpsnippet/helpers/string-utility.js +19 -1
- package/lib/services/code-samples/httpsnippet/index.js +166 -1
- package/lib/services/code-samples/httpsnippet/targets/__mocks__/mock.js +2340 -146
- package/lib/services/code-samples/httpsnippet/targets/csharp/httpclient.js +227 -2
- package/lib/services/code-samples/httpsnippet/targets/csharp/index.js +11 -1
- package/lib/services/code-samples/httpsnippet/targets/csharpNewtonsoft/httpclient.js +185 -2
- package/lib/services/code-samples/httpsnippet/targets/csharpNewtonsoft/index.js +11 -1
- package/lib/services/code-samples/httpsnippet/targets/go/index.js +11 -1
- package/lib/services/code-samples/httpsnippet/targets/go/native.js +222 -3
- package/lib/services/code-samples/httpsnippet/targets/index.js +28 -1
- package/lib/services/code-samples/httpsnippet/targets/java/httpclient.js +184 -3
- package/lib/services/code-samples/httpsnippet/targets/java/index.js +11 -1
- package/lib/services/code-samples/httpsnippet/targets/java8/apachehttp.js +223 -2
- package/lib/services/code-samples/httpsnippet/targets/java8/index.js +11 -1
- package/lib/services/code-samples/httpsnippet/targets/javascript/fetch.js +147 -1
- package/lib/services/code-samples/httpsnippet/targets/javascript/index.js +11 -1
- package/lib/services/code-samples/httpsnippet/targets/node/fetch.js +199 -1
- package/lib/services/code-samples/httpsnippet/targets/node/index.js +11 -1
- package/lib/services/code-samples/httpsnippet/targets/php/curl.js +203 -5
- package/lib/services/code-samples/httpsnippet/targets/php/index.js +11 -1
- package/lib/services/code-samples/httpsnippet/targets/php/types.js +2 -0
- package/lib/services/code-samples/httpsnippet/targets/php/utils.js +106 -5
- package/lib/services/code-samples/httpsnippet/targets/python/index.js +11 -1
- package/lib/services/code-samples/httpsnippet/targets/python/requests.js +185 -6
- package/lib/services/code-samples/httpsnippet/targets/r/httr.js +111 -1
- package/lib/services/code-samples/httpsnippet/targets/r/index.js +11 -1
- package/lib/services/code-samples/httpsnippet/targets/r/utils.js +18 -6
- package/lib/services/code-samples/httpsnippet/targets/ruby/index.js +11 -1
- package/lib/services/code-samples/httpsnippet/targets/ruby/native.js +169 -1
- package/lib/services/code-samples/httpsnippet/targets/shell/curl.js +94 -6
- package/lib/services/code-samples/httpsnippet/targets/shell/index.js +11 -1
- package/lib/services/code-samples/index.js +3 -1
- package/lib/services/code-samples/types.js +2 -0
- package/lib/services/config-options/helpers.js +49 -1
- package/lib/services/config-options/index.js +3 -1
- package/lib/services/config-options/normalizeOptions.js +83 -1
- package/lib/services/config-options/types.js +2 -0
- package/lib/services/history/helpers.js +63 -1
- package/lib/services/history/index.js +2 -1
- package/lib/services/index.js +9 -1
- package/lib/services/menu/builder.js +47 -1
- package/lib/services/menu/index.js +2 -1
- package/lib/services/menu/markdown.js +93 -1
- package/lib/services/menu/operation.js +50 -1
- package/lib/services/menu/tags.js +166 -1
- package/lib/services/types.js +2 -0
- package/lib/services/utils.js +83 -1
- package/lib/standalone.js +68 -1
- package/lib/styled-components.js +6 -1
- package/lib/types/app.js +2 -0
- package/lib/types/index.js +4 -1
- package/lib/types/open-api.js +2 -0
- package/lib/types/security.js +2 -0
- package/lib/utils/JsonPointer.js +84 -1
- package/lib/utils/areArraysEqual.js +4 -1
- package/lib/utils/argValuesHelpers.js +35 -1
- package/lib/utils/compose.js +2 -1
- package/lib/utils/configure-helpers.js +223 -1
- package/lib/utils/convertSwagger2OpenAPI.js +14 -1
- package/lib/utils/cookies.js +73 -1
- package/lib/utils/debounce.js +22 -1
- package/lib/utils/debug.js +11 -1
- package/lib/utils/dom.js +65 -1
- package/lib/utils/environments.js +13 -1
- package/lib/utils/helpers.js +222 -12
- package/lib/utils/index.js +25 -1
- package/lib/utils/isMobile.js +13 -1
- package/lib/utils/loadAndBundleSpec.js +32 -1
- package/lib/utils/local-storage.js +12 -1
- package/lib/utils/object.js +31 -1
- package/lib/utils/openapi.js +592 -1
- package/lib/utils/parameters.js +13 -1
- package/lib/utils/path.js +22 -1
- package/lib/utils/queryString.js +60 -1
- package/lib/utils/replaceVariables.js +14 -1
- package/lib/utils/saveTextBeforeHeading.js +35 -1
- package/lib/utils/security-details.js +49 -1
- package/lib/utils/session-storage.js +12 -1
- package/lib/utils/simplifyAstStructure.js +22 -1
- package/lib/utils/sort.js +21 -1
- package/lib/utils/string.js +65 -1
- package/lib/utils/telemetry.js +7 -1
- package/lib/utils/test-utils.js +26 -1
- package/lib/utils/theme-helpers.js +24 -3
- package/lib/utils/url.js +38 -1
- package/package.json +4 -4
|
@@ -1 +1,92 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { useAtomValue } from 'jotai';
|
|
2
|
+
import { getCodeSample } from '../../services/index.js';
|
|
3
|
+
import { globalStoreAtom } from '../../jotai/store.js';
|
|
4
|
+
import { operationStore } from '../../jotai/operation.js';
|
|
5
|
+
import { environmentAtom, getLangKey, languageAtom, activeMimeNameAtom } from '../../jotai/app.js';
|
|
6
|
+
import { useTranslate } from '../../hooks/index.js';
|
|
7
|
+
export function useCodeSamples({ payload, isWebhook, definitionSamples, pointer, envVariables, }) {
|
|
8
|
+
const { parser, options: { codeSamples, generatedSamplesMaxDepth }, } = useAtomValue(globalStoreAtom);
|
|
9
|
+
const activeMimeName = useAtomValue(activeMimeNameAtom);
|
|
10
|
+
const operationState = useAtomValue(operationStore(pointer));
|
|
11
|
+
const { languages } = useAtomValue(languageAtom);
|
|
12
|
+
const [environment] = useAtomValue(environmentAtom);
|
|
13
|
+
const translate = useTranslate();
|
|
14
|
+
const orderMap = new Map(languages?.map(({ key, order }) => [key, order]));
|
|
15
|
+
const filteredDefinitionSamples = definitionSamples.filter((item) => orderMap.has(getLangKey(item)));
|
|
16
|
+
const envDefinitionSamples = applyEnvironments(filteredDefinitionSamples, envVariables, environment);
|
|
17
|
+
const definitionExamplesKeys = new Set(envDefinitionSamples.map(getLangKey));
|
|
18
|
+
let generatedSamples = [];
|
|
19
|
+
if (!isWebhook) {
|
|
20
|
+
const generateLanguages = codeSamples.languages?.filter(({ lang, label }) => lang !== 'Payload' && !definitionExamplesKeys.has(getLangKey({ lang, label }))) || [];
|
|
21
|
+
generatedSamples = createCodeSamples(generateLanguages, codeSamples, parser.definition, generatedSamplesMaxDepth, operationState, environment, translate, activeMimeName);
|
|
22
|
+
}
|
|
23
|
+
const allCodeSamples = [...envDefinitionSamples, ...generatedSamples];
|
|
24
|
+
const payloadLabel = languages?.find(({ lang }) => lang === payload?.lang)?.title;
|
|
25
|
+
const payloadLabelKey = payload && getLangKey({ label: payloadLabel, lang: payload.lang });
|
|
26
|
+
if (payload && payloadLabelKey && orderMap.has(payloadLabelKey)) {
|
|
27
|
+
allCodeSamples.push({
|
|
28
|
+
...payload,
|
|
29
|
+
label: payloadLabel,
|
|
30
|
+
order: orderMap.get(payloadLabelKey),
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
// Adding new properties for UI purposes and sort samples
|
|
34
|
+
const samples = allCodeSamples
|
|
35
|
+
.map((sample) => {
|
|
36
|
+
const title = sample.label ?? sample.lang;
|
|
37
|
+
return {
|
|
38
|
+
key: getLangKey(sample),
|
|
39
|
+
title,
|
|
40
|
+
order: typeof orderMap.get(title.toLowerCase()) === 'number'
|
|
41
|
+
? orderMap.get(title.toLowerCase())
|
|
42
|
+
: 9999,
|
|
43
|
+
...sample,
|
|
44
|
+
};
|
|
45
|
+
})
|
|
46
|
+
.sort((a, b) => a.order - b.order);
|
|
47
|
+
return { samples };
|
|
48
|
+
}
|
|
49
|
+
function createCodeSamples(languages, { skipOptionalParameters, withOAuth2Call }, spec, generatedPayloadSamplesMaxDepth, store, environment, translate, activeMimeName) {
|
|
50
|
+
return languages.map(({ lang, label, options }) => {
|
|
51
|
+
return {
|
|
52
|
+
lang,
|
|
53
|
+
label,
|
|
54
|
+
get: (source) => getCodeSample({
|
|
55
|
+
...source,
|
|
56
|
+
lang,
|
|
57
|
+
options: {
|
|
58
|
+
...options,
|
|
59
|
+
skipOptionalParameters,
|
|
60
|
+
withOAuth2Call,
|
|
61
|
+
spec,
|
|
62
|
+
generatedPayloadSamplesMaxDepth,
|
|
63
|
+
store,
|
|
64
|
+
activeMimeName,
|
|
65
|
+
},
|
|
66
|
+
environment,
|
|
67
|
+
translate,
|
|
68
|
+
}),
|
|
69
|
+
};
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
function applyEnvironments(samples, envVariables, currentEnvironment) {
|
|
73
|
+
if (!envVariables || !samples.length)
|
|
74
|
+
return samples;
|
|
75
|
+
const serverUrl = currentEnvironment?.server;
|
|
76
|
+
let envValues = { ...(envVariables.values || {}) };
|
|
77
|
+
if (serverUrl && envVariables.serverValues?.[serverUrl]) {
|
|
78
|
+
envValues = { ...envValues, ...envVariables.serverValues[serverUrl] };
|
|
79
|
+
}
|
|
80
|
+
if (Object.keys(envValues).length === 0)
|
|
81
|
+
return samples;
|
|
82
|
+
return samples.map((sample) => {
|
|
83
|
+
const clonedSample = { ...sample };
|
|
84
|
+
if ('source' in clonedSample && typeof clonedSample.source === 'string') {
|
|
85
|
+
clonedSample.source = clonedSample.source.replace(/\{\{([^}]+)\}\}/g, (match, variableName) => {
|
|
86
|
+
return envValues[variableName] !== undefined ? envValues[variableName] : match; // Keep original if no replacement found
|
|
87
|
+
});
|
|
88
|
+
}
|
|
89
|
+
return clonedSample;
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
//# sourceMappingURL=useCodeSamples.js.map
|
|
@@ -1 +1,47 @@
|
|
|
1
|
-
import{
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import { memo, useCallback } from 'react';
|
|
3
|
+
import { useAtomValue } from 'jotai';
|
|
4
|
+
import { PayloadSamples, StyledCodeBlock } from '../PayloadSamples/index.js';
|
|
5
|
+
import { createCodeSampleCopyEvent } from '../../events/index.js';
|
|
6
|
+
import { globalOptionsAtom } from '../../jotai/store.js';
|
|
7
|
+
import { Summary } from './Summary.js';
|
|
8
|
+
import { Tabs } from '../Tabs/index.js';
|
|
9
|
+
import { CodeBlockPanel } from '../common/index.js';
|
|
10
|
+
import { useTelemetry, useTranslate } from '../../hooks/index.js';
|
|
11
|
+
import { activeMimeNameAtom } from '../../jotai/app.js';
|
|
12
|
+
import { operationStore } from '../../jotai/operation.js';
|
|
13
|
+
function ResponseSamplesComponent({ operation, activeResponseTab, onTabChange, onPanelToggle, }) {
|
|
14
|
+
const telemetry = useTelemetry();
|
|
15
|
+
const { events } = useAtomValue(globalOptionsAtom);
|
|
16
|
+
const translate = useTranslate();
|
|
17
|
+
const responses = operation.responses.filter((response) => response.content?.hasSample ?? false);
|
|
18
|
+
const tabs = operation.responses.map(({ code }) => ({ key: code, title: code }));
|
|
19
|
+
const activeTab = tabs?.find(({ key }) => key === activeResponseTab) || tabs?.[0];
|
|
20
|
+
const activeMimeName = useAtomValue(activeMimeNameAtom);
|
|
21
|
+
const { activeExampleName } = useAtomValue(operationStore(operation.pointer));
|
|
22
|
+
const handleCodeSampleCopy = useCallback(() => {
|
|
23
|
+
telemetry.send({
|
|
24
|
+
type: 'openapi_docs.copy_code_snippet.clicked',
|
|
25
|
+
payload: { snippetType: 'response' },
|
|
26
|
+
});
|
|
27
|
+
const event = createCodeSampleCopyEvent({
|
|
28
|
+
operation,
|
|
29
|
+
type: 'response',
|
|
30
|
+
activeMimeName,
|
|
31
|
+
activeExampleName,
|
|
32
|
+
});
|
|
33
|
+
events?.codeSamplesCopy?.(event);
|
|
34
|
+
}, [telemetry, operation, events, activeMimeName, activeExampleName]);
|
|
35
|
+
const handlePanelToggle = useCallback((isExpanded) => {
|
|
36
|
+
onPanelToggle?.(isExpanded, 'response-samples');
|
|
37
|
+
}, [onPanelToggle]);
|
|
38
|
+
if (!responses.length) {
|
|
39
|
+
return null;
|
|
40
|
+
}
|
|
41
|
+
const renderSummary = () => {
|
|
42
|
+
return (_jsx(Summary, { tabs: _jsx(Tabs, { tabs: tabs, activeTab: activeTab, onChange: (tab) => onTabChange(tab.key) }) }));
|
|
43
|
+
};
|
|
44
|
+
return (_jsx(CodeBlockPanel, { className: "panel-response-samples", header: renderSummary, isExpandable: false, children: operation.responses.map((response) => response.code === activeTab.key ? (_jsx("div", { children: response?.content?.hasSample ? (_jsx(PayloadSamples, { content: response.content, onCopyClick: handleCodeSampleCopy, onPanelToggle: handlePanelToggle })) : (_jsx(StyledCodeBlock, { source: translate('openapi.noResponseContent', 'No content') })) }, response.code)) : null) }));
|
|
45
|
+
}
|
|
46
|
+
export const ResponseSamples = memo(ResponseSamplesComponent);
|
|
47
|
+
//# sourceMappingURL=ResponseSamples.js.map
|
|
@@ -1 +1,9 @@
|
|
|
1
|
-
import{jsx as
|
|
1
|
+
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
|
+
import { PanelHeader } from '@redocly/theme/components/Panel/PanelHeader';
|
|
3
|
+
import { PanelHeaderTitle } from '@redocly/theme/components/Panel/PanelHeaderTitle';
|
|
4
|
+
import { useTranslate } from '../../hooks/index.js';
|
|
5
|
+
export const Summary = ({ tabs }) => {
|
|
6
|
+
const translate = useTranslate();
|
|
7
|
+
return (_jsxs(PanelHeader, { isExpandable: false, children: [_jsx(PanelHeaderTitle, { "data-testid": "title", children: translate('openapi.response', 'Response') }), tabs] }));
|
|
8
|
+
};
|
|
9
|
+
//# sourceMappingURL=Summary.js.map
|
|
@@ -1 +1,2 @@
|
|
|
1
|
-
|
|
1
|
+
export { ResponseSamples } from './ResponseSamples.js';
|
|
2
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -1,4 +1,44 @@
|
|
|
1
|
-
import{
|
|
1
|
+
import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
|
|
2
|
+
import { memo, useMemo } from 'react';
|
|
3
|
+
import { useLocation } from 'react-router-dom';
|
|
4
|
+
import { useAtomValue } from 'jotai';
|
|
5
|
+
import { Tabs, useTabsState } from '../Tabs/index.js';
|
|
6
|
+
import { ResponseDetails } from './ResponseDetails.js';
|
|
7
|
+
import { makeDeepLink } from '../../services/index.js';
|
|
8
|
+
import { Row, StyledTitle } from './styled.js';
|
|
9
|
+
import { LinkToField } from '../common/LinkToField.js';
|
|
10
|
+
import { pathIncludesLink } from '../../utils/index.js';
|
|
11
|
+
import { ExpandAllButton } from '../ExpandAllButton/index.js';
|
|
12
|
+
import { useTranslate } from '../../hooks/index.js';
|
|
13
|
+
import { getActiveMediaType } from '../../models/index.js';
|
|
14
|
+
import { activeMimeNameAtom } from '../../jotai/app.js';
|
|
15
|
+
import { styled } from '../../styled-components.js';
|
|
16
|
+
export const OperationResponseList = memo(({ responses, renderTitle, operationId, operationPointer, activeResponseTab, onTabChange, callbackId, onPanelToggle, }) => {
|
|
17
|
+
const location = useLocation();
|
|
18
|
+
const translate = useTranslate();
|
|
19
|
+
const activeMimeName = useAtomValue(activeMimeNameAtom);
|
|
20
|
+
const tabs = responses.map(({ code }) => ({ key: code, title: code }));
|
|
21
|
+
const defaultTab = tabs.find(({ key }) => key === activeResponseTab ||
|
|
22
|
+
(pathIncludesLink(location, operationId) && pathIncludesLink(location, `c=${key}`)));
|
|
23
|
+
const { activeTab, handleTabChange } = useTabsState({
|
|
24
|
+
tabs,
|
|
25
|
+
defaultTab: defaultTab?.key,
|
|
26
|
+
onChange: onTabChange,
|
|
27
|
+
});
|
|
28
|
+
const tab = tabs.find((t) => t.key === (activeResponseTab || activeTab));
|
|
29
|
+
const response = responses.find((r) => r.code === tab?.key);
|
|
30
|
+
const showExpandAllButton = useMemo(() => {
|
|
31
|
+
if (!response?.content)
|
|
32
|
+
return false;
|
|
33
|
+
const { schema } = getActiveMediaType(response?.content, activeMimeName) || {};
|
|
34
|
+
return schema?.fields?.some(({ schema: fieldSchema }) => !fieldSchema.isPrimitive && !fieldSchema.isCircular);
|
|
35
|
+
}, [activeMimeName, response?.content]);
|
|
36
|
+
if (!tab)
|
|
37
|
+
return null;
|
|
38
|
+
return (_jsxs(_Fragment, { children: [_jsxs(TitleWrap, { children: [renderTitle?.(tab) || (_jsxs(StyledTitle, { children: [_jsx(LinkToField, { to: makeDeepLink(operationId, `response&c=${tab.key}`) }), translate('openapi.responses', 'Responses')] })), _jsx(Tabs, { tabs: tabs, activeTab: tab, onChange: handleTabChange }), showExpandAllButton && (_jsx(ExpandAllButton, { type: "response", operationPointer: operationPointer, onPanelToggle: onPanelToggle }))] }), response ? (_jsx("div", { children: _jsx(ResponseDetails, { response: response, operationId: operationId, callbackId: callbackId }) }, response.code)) : null] }));
|
|
39
|
+
});
|
|
40
|
+
const TitleWrap = styled(Row) `
|
|
2
41
|
flex-wrap: wrap;
|
|
3
42
|
gap: var(--spacing-unit);
|
|
4
|
-
`;
|
|
43
|
+
`;
|
|
44
|
+
//# sourceMappingURL=OperationResponseList.js.map
|
|
@@ -1 +1,18 @@
|
|
|
1
|
-
import{jsx as
|
|
1
|
+
import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
|
+
import { memo } from 'react';
|
|
3
|
+
import { ResponseHeaders } from './ResponseHeaders.js';
|
|
4
|
+
import { StyledDescription } from './styled.js';
|
|
5
|
+
import { BodyContent } from '../common/BodyContent/index.js';
|
|
6
|
+
import { makeDeepLink } from '../../services/index.js';
|
|
7
|
+
function ResponseDetailsComponent({ response, operationId, callbackId, disableDeepLinks, }) {
|
|
8
|
+
const { description, headers, content, summary, code } = response;
|
|
9
|
+
return (_jsxs(_Fragment, { children: [_jsx(StyledDescription, { className: "redoc-markdown", source: summary }), _jsx(StyledDescription, { className: "redoc-markdown", source: description }), _jsx(ResponseHeaders, { headers: headers, deepLink: disableDeepLinks ? undefined : generateDeepLink(operationId, callbackId, code, 'headers') }), _jsx(BodyContent, { content: content, skipWriteOnly: true, deepLink: disableDeepLinks ? undefined : generateDeepLink(operationId, callbackId, code, 'body') })] }));
|
|
10
|
+
}
|
|
11
|
+
export const ResponseDetails = memo(ResponseDetailsComponent);
|
|
12
|
+
function generateDeepLink(operationId, callbackId = '', code, place) {
|
|
13
|
+
const suffix = callbackId
|
|
14
|
+
? `${callbackId}/response&c=${code}/${place}`
|
|
15
|
+
: `response&c=${code}/${place}`;
|
|
16
|
+
return makeDeepLink(operationId, suffix);
|
|
17
|
+
}
|
|
18
|
+
//# sourceMappingURL=ResponseDetails.js.map
|
|
@@ -1 +1,15 @@
|
|
|
1
|
-
import{jsx as
|
|
1
|
+
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
|
+
import { memo } from 'react';
|
|
3
|
+
import { HeadersCaption, StyledHeadersProperties } from './styled.js';
|
|
4
|
+
import { PropertyDetails } from '../PropertyDetails/index.js';
|
|
5
|
+
import { LinkToField } from '../common/LinkToField.js';
|
|
6
|
+
import { useTranslate } from '../../hooks/index.js';
|
|
7
|
+
function ResponseHeadersComponent({ headers, deepLink, }) {
|
|
8
|
+
const translate = useTranslate();
|
|
9
|
+
if (headers === undefined || headers.length === 0) {
|
|
10
|
+
return null;
|
|
11
|
+
}
|
|
12
|
+
return (_jsxs(StyledHeadersProperties, { children: [_jsxs(HeadersCaption, { children: [deepLink && _jsx(LinkToField, { to: deepLink }), translate('openapi.header', 'Headers')] }), headers.map((field, index) => (_jsx(PropertyDetails, { isFirst: index === 0, field: field, disableDeepLinks: !deepLink }, field.name)))] }));
|
|
13
|
+
}
|
|
14
|
+
export const ResponseHeaders = memo(ResponseHeadersComponent);
|
|
15
|
+
//# sourceMappingURL=ResponseHeaders.js.map
|
|
@@ -1 +1,6 @@
|
|
|
1
|
-
|
|
1
|
+
export { OperationResponseList } from './OperationResponseList.js';
|
|
2
|
+
export { ResponseDetails } from './ResponseDetails.js';
|
|
3
|
+
export { ResponseHeaders } from './ResponseHeaders.js';
|
|
4
|
+
export * from './types.js';
|
|
5
|
+
export { HeadersCaption, StyledHeadersProperties, StyledTitle, StyledDescription, } from './styled.js';
|
|
6
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -1,4 +1,7 @@
|
|
|
1
|
-
import{Title
|
|
1
|
+
import { Title } from '../common/OperationItemTitle.js';
|
|
2
|
+
import { Markdown } from '../Markdown/index.js';
|
|
3
|
+
import { styled } from '../../styled-components.js';
|
|
4
|
+
export const HeadersCaption = styled.div `
|
|
2
5
|
position: relative;
|
|
3
6
|
display: flex;
|
|
4
7
|
align-items: center;
|
|
@@ -8,15 +11,20 @@ import{Title as t}from"../common/OperationItemTitle.js";import{Markdown as e}fro
|
|
|
8
11
|
font-weight: var(--font-weight-semibold);
|
|
9
12
|
color: var(--text-color-primary);
|
|
10
13
|
padding: var(--spacing-xxs) 0;
|
|
11
|
-
|
|
14
|
+
`;
|
|
15
|
+
export const StyledHeadersProperties = styled.div `
|
|
12
16
|
margin-top: var(--spacing-md);
|
|
13
|
-
|
|
17
|
+
`;
|
|
18
|
+
export const Row = styled.div `
|
|
14
19
|
display: flex;
|
|
15
20
|
align-items: center;
|
|
16
21
|
margin-top: var(--spacing-base);
|
|
17
|
-
|
|
22
|
+
`;
|
|
23
|
+
export const StyledTitle = styled(Title) `
|
|
18
24
|
margin: 0 var(--spacing-sm) 0 0;
|
|
19
25
|
position: relative;
|
|
20
|
-
|
|
26
|
+
`;
|
|
27
|
+
export const StyledDescription = styled(Markdown) `
|
|
21
28
|
margin-top: var(--spacing-xs);
|
|
22
|
-
`;
|
|
29
|
+
`;
|
|
30
|
+
//# sourceMappingURL=styled.js.map
|
|
@@ -1 +1,21 @@
|
|
|
1
|
-
import{jsx as
|
|
1
|
+
import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
|
+
import { useAtomValue } from 'jotai';
|
|
3
|
+
import { Panel } from '@redocly/theme/components/Panel/Panel';
|
|
4
|
+
import { Markdown as MarkdownWrapper } from '@redocly/theme/components/Markdown/Markdown';
|
|
5
|
+
import { DownloadSpecification } from '../Download/index.js';
|
|
6
|
+
import { Overview } from '../Overview/index.js';
|
|
7
|
+
import { LanguageList } from '../Language/index.js';
|
|
8
|
+
import { ServerList } from '../ServerList/index.js';
|
|
9
|
+
import { globalStoreAtom } from '../../jotai/store.js';
|
|
10
|
+
import { normalizeServers } from '../../utils/index.js';
|
|
11
|
+
import { mergeInMockServer } from '../../models/operation.js';
|
|
12
|
+
import { languageAtom } from '../../jotai/app.js';
|
|
13
|
+
import { useTranslate } from '../../hooks/index.js';
|
|
14
|
+
export const RightPanel = ({ item: { infoDefinition: info }, }) => {
|
|
15
|
+
const translate = useTranslate();
|
|
16
|
+
const { options: { hideDownloadButtons, mockServer }, parser: { definition, definitionUrl }, } = useAtomValue(globalStoreAtom);
|
|
17
|
+
const { languages, activeLanguage } = useAtomValue(languageAtom);
|
|
18
|
+
const servers = normalizeServers(definitionUrl, mergeInMockServer(definition.servers || [], mockServer));
|
|
19
|
+
return (_jsxs(_Fragment, { children: [!hideDownloadButtons && (_jsx(Panel, { className: "panel-download", header: translate('openapi.download.description.title', 'Download OpenAPI description'), isExpandable: false, children: _jsx(DownloadSpecification, {}) })), (info?.license || info?.contact || info?.termsOfService) && (_jsx(Panel, { className: "panel-overview", header: translate('openapi.info.title', 'Overview'), isExpandable: false, children: _jsx(MarkdownWrapper, { children: _jsx(Overview, { info: info, translate: translate }) }) })), !!languages?.length && (_jsx(Panel, { className: "panel-language-list", header: translate('openapi.languages.title', 'Languages'), isExpandable: false, children: _jsx(LanguageList, { languages: languages, activeLanguage: activeLanguage }) })), !!servers.length && (_jsx(Panel, { className: "panel-servers-list", header: translate('openapi.servers.title', 'Servers'), isExpandable: false, children: _jsx(ServerList, { servers: servers, path: "/", translate: translate }) }))] }));
|
|
20
|
+
};
|
|
21
|
+
//# sourceMappingURL=RightPanel.js.map
|
|
@@ -1 +1,2 @@
|
|
|
1
|
-
|
|
1
|
+
export { RightPanel } from './RightPanel.js';
|
|
2
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1,33 @@
|
|
|
1
|
-
import{
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import { useState, useEffect } from 'react';
|
|
3
|
+
import { MimeLabel, Container, Select } from '../common/index.js';
|
|
4
|
+
import { SelectOrLabel } from '../SelectOrLabel/index.js';
|
|
5
|
+
import { normalizeText } from '../../utils/index.js';
|
|
6
|
+
import { useTelemetry } from '../../hooks/index.js';
|
|
7
|
+
export const ExampleSwitch = ({ exampleKey, examples, onChange, className, }) => {
|
|
8
|
+
const telemetry = useTelemetry();
|
|
9
|
+
const examplesKeys = Object.keys(examples);
|
|
10
|
+
const defaultIdx = exampleKey ? examplesKeys.indexOf(exampleKey) : 0;
|
|
11
|
+
const [activeIdx, setActiveIdx] = useState(defaultIdx > -1 ? defaultIdx : 0);
|
|
12
|
+
useEffect(() => setActiveIdx(defaultIdx > -1 ? defaultIdx : 0), [exampleKey, defaultIdx]);
|
|
13
|
+
const options = examplesKeys.map((name, idx) => ({
|
|
14
|
+
value: normalizeText(examples[name].summary) || name,
|
|
15
|
+
idx,
|
|
16
|
+
}));
|
|
17
|
+
const handleChange = ({ idx }) => {
|
|
18
|
+
telemetry.send({
|
|
19
|
+
type: 'openapi_docs.examples_switcher.clicked',
|
|
20
|
+
payload: {
|
|
21
|
+
example: examplesKeys[idx],
|
|
22
|
+
numberOfExamples: examplesKeys.length,
|
|
23
|
+
},
|
|
24
|
+
});
|
|
25
|
+
setActiveIdx(idx);
|
|
26
|
+
onChange(examplesKeys[idx]);
|
|
27
|
+
};
|
|
28
|
+
if (options.length < 2) {
|
|
29
|
+
return null;
|
|
30
|
+
}
|
|
31
|
+
return (_jsx(Container, { "data-testid": "example-switch", className: className, children: _jsx(SelectOrLabel, { Select: Select, Label: MimeLabel, variant: "dark", fullWidth: true, options: options, value: options[activeIdx]?.value, onChange: handleChange }) }));
|
|
32
|
+
};
|
|
33
|
+
//# sourceMappingURL=ExampleSwitch.js.map
|
|
@@ -1 +1,12 @@
|
|
|
1
|
-
import{useAtomValue
|
|
1
|
+
import { useAtomValue } from 'jotai';
|
|
2
|
+
import { operationStore } from '../../jotai/operation.js';
|
|
3
|
+
export function useExampleKey({ pointer } = {}, examples) {
|
|
4
|
+
const operationState = useAtomValue(operationStore(pointer));
|
|
5
|
+
const { activeExampleName } = operationState;
|
|
6
|
+
return {
|
|
7
|
+
exampleKey: activeExampleName && examples[activeExampleName]
|
|
8
|
+
? activeExampleName
|
|
9
|
+
: Object.keys(examples)[0],
|
|
10
|
+
};
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=use-example-key.js.map
|
|
@@ -1 +1,45 @@
|
|
|
1
|
-
import{jsx as
|
|
1
|
+
import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
|
+
import { memo, useCallback } from 'react';
|
|
3
|
+
import { useAtomValue } from 'jotai';
|
|
4
|
+
import { TypeName } from '../common/index.js';
|
|
5
|
+
import { Schema } from './Schema.js';
|
|
6
|
+
import { ObjectSchema } from './ObjectSchema.js';
|
|
7
|
+
import { humanizeConstraints } from '../../utils/index.js';
|
|
8
|
+
import { SubSchema } from './SubSchema.js';
|
|
9
|
+
import { globalOptionsAtom } from '../../jotai/store.js';
|
|
10
|
+
import { getExpandByDefault } from './helpers.js';
|
|
11
|
+
import { ArrayLabel, LabelValue, ArrayClosingLabel } from '../common/styled.js';
|
|
12
|
+
function ArraySchemaComponent({ schema, schema: { minItems, maxItems, items: itemsSchema }, fieldParentsName, ...rest }) {
|
|
13
|
+
const { schemasExpansionLevel } = useAtomValue(globalOptionsAtom);
|
|
14
|
+
const parentSchemaTypes = Array.isArray(rest.parentType) ? rest.parentType : [rest.parentType];
|
|
15
|
+
const isNestedArray = parentSchemaTypes.includes('array') && parentSchemaTypes.length === 1;
|
|
16
|
+
const level = isNestedArray ? (rest.level || 0) + 1 : rest.level;
|
|
17
|
+
const minMaxItems = minItems === undefined && maxItems === undefined
|
|
18
|
+
? ''
|
|
19
|
+
: `(${humanizeConstraints(schema)})`;
|
|
20
|
+
let updatedParentsArray = fieldParentsName
|
|
21
|
+
? [...fieldParentsName.slice(0, -1), fieldParentsName[fieldParentsName.length - 1] + '[]']
|
|
22
|
+
: fieldParentsName;
|
|
23
|
+
const getFilteredFields = useCallback((items) => rest.skipReadOnly || rest.skipWriteOnly
|
|
24
|
+
? items?.filter((item) => !((rest.skipReadOnly && item.schema.readOnly) ||
|
|
25
|
+
(rest.skipWriteOnly && item.schema.writeOnly)))
|
|
26
|
+
: items, [rest.skipReadOnly, rest.skipWriteOnly]);
|
|
27
|
+
if (schema?.fields) {
|
|
28
|
+
return (_jsx(ObjectSchema, { ...rest, shouldCloseArray: isNestedArray, level: level, schema: schema, fieldParentsName: updatedParentsArray, onOneOfChange: rest.onOneOfChange }));
|
|
29
|
+
}
|
|
30
|
+
if (schema.displayType && !itemsSchema && !minMaxItems.length) {
|
|
31
|
+
return (_jsx("div", { children: _jsx(TypeName, { children: schema.displayType }) }));
|
|
32
|
+
}
|
|
33
|
+
const filteredFields = getFilteredFields(itemsSchema?.fields);
|
|
34
|
+
const filteredOneOfFields = getFilteredFields(itemsSchema?.oneOf?.[0]?.fields);
|
|
35
|
+
const propertyLength = filteredFields?.length || filteredOneOfFields?.length;
|
|
36
|
+
const isFirstLevel = rest.level === 1;
|
|
37
|
+
const expandByDefault = getExpandByDefault({
|
|
38
|
+
level: rest.level,
|
|
39
|
+
required: rest.required,
|
|
40
|
+
schemasExpansionLevel,
|
|
41
|
+
});
|
|
42
|
+
return (_jsx(SubSchema, { ...rest, propertyLength: propertyLength, isNestedArray: isNestedArray, level: level, isArray: true, expandable: !isFirstLevel, expandByDefault: expandByDefault, operationPointer: schema.operationPointer, children: _jsxs(_Fragment, { children: [isFirstLevel && (_jsx(ArrayLabel, { children: _jsx(LabelValue, { children: "Array [" }) })), _jsx(Schema, { ...rest, parentType: !isFirstLevel ? schema.type : undefined, level: level, schema: itemsSchema, shouldCloseArray: isNestedArray, fieldParentsName: updatedParentsArray, expandable: false, onOneOfChange: rest.onOneOfChange }), isFirstLevel && (_jsx(ArrayClosingLabel, { className: "array-closing-label", children: _jsx(LabelValue, { children: "]" }) }))] }) }));
|
|
43
|
+
}
|
|
44
|
+
export const ArraySchema = memo(ArraySchemaComponent);
|
|
45
|
+
//# sourceMappingURL=ArraySchema.js.map
|
|
@@ -1 +1,29 @@
|
|
|
1
|
-
import{jsx as
|
|
1
|
+
import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
|
+
import { memo } from 'react';
|
|
3
|
+
import { useAtomValue } from 'jotai';
|
|
4
|
+
import { PropertiesTableCaption } from '../common/index.js';
|
|
5
|
+
import { Discriminator } from '../Discriminator/index.js';
|
|
6
|
+
import { globalOptionsAtom } from '../../jotai/store.js';
|
|
7
|
+
import { PropertyDetails } from '../PropertyDetails/index.js';
|
|
8
|
+
import { SubSchema } from './SubSchema.js';
|
|
9
|
+
import { getExpandByDefault } from './helpers.js';
|
|
10
|
+
import { useTranslate } from '../../hooks/index.js';
|
|
11
|
+
import { ArrayClosingLabel, LabelValue } from '../common/styled.js';
|
|
12
|
+
function ObjectSchemaComponent({ schema, showTitle, discriminator, level, skipWriteOnly, skipReadOnly, fieldParentsName, expandable, deepLink, required, disableDeepLinks, shouldCloseArray, oneOfLevel, slug, onOneOfChange, }) {
|
|
13
|
+
const { fields = [], title } = schema;
|
|
14
|
+
const translate = useTranslate();
|
|
15
|
+
const { schemasExpansionLevel } = useAtomValue(globalOptionsAtom);
|
|
16
|
+
const filteredFields = skipReadOnly || skipWriteOnly
|
|
17
|
+
? fields.filter((item) => !((skipReadOnly && item.schema.readOnly) || (skipWriteOnly && item.schema.writeOnly)))
|
|
18
|
+
: fields;
|
|
19
|
+
const expandByDefault = getExpandByDefault({
|
|
20
|
+
required,
|
|
21
|
+
level,
|
|
22
|
+
schemasExpansionLevel,
|
|
23
|
+
});
|
|
24
|
+
return (_jsxs(SubSchema, { expandable: expandable, expandByDefault: expandByDefault, level: level, propertyLength: filteredFields.length, deepLink: deepLink, operationPointer: schema.operationPointer, children: [_jsxs(_Fragment, { children: [showTitle && _jsx(PropertiesTableCaption, { children: title }), filteredFields.map((field, index) => (_jsx(PropertyDetails, { isFirst: index === 0, field: field, fieldParentsName: Number(level) > 1 ? fieldParentsName : [], renderDiscriminatorSwitch: discriminator?.fieldName === field.name && discriminator?.parentSchema
|
|
25
|
+
? () => (_jsx(Discriminator, { parent: discriminator.parentSchema, onChange: discriminator?.onChange, activeOneOfIdx: discriminator.activeOneOfIdx, translate: translate }))
|
|
26
|
+
: undefined, skipReadOnly: skipReadOnly, skipWriteOnly: skipWriteOnly, showTitle: showTitle, level: level, disableDeepLinks: disableDeepLinks, oneOfLevel: oneOfLevel, slug: slug, onOneOfChange: onOneOfChange }, field.name)))] }), shouldCloseArray && (_jsx(ArrayClosingLabel, { className: "array-closing-label", children: _jsx(LabelValue, { children: "]" }) }))] }));
|
|
27
|
+
}
|
|
28
|
+
export const ObjectSchema = memo(ObjectSchemaComponent);
|
|
29
|
+
//# sourceMappingURL=ObjectSchema.js.map
|
|
@@ -1,10 +1,54 @@
|
|
|
1
|
-
import{jsxs as
|
|
1
|
+
import { jsxs as _jsxs, jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import { memo } from 'react';
|
|
3
|
+
import { useAtom } from 'jotai';
|
|
4
|
+
import { StyledBadge, SelectionTitle } from '../common/index.js';
|
|
5
|
+
import { Markdown } from '../Markdown/index.js';
|
|
6
|
+
import { ConstraintsView } from '../common/ConstraintsView.js';
|
|
7
|
+
import { Schema } from './Schema.js';
|
|
8
|
+
import { operationStore } from '../../jotai/operation.js';
|
|
9
|
+
import { SchemaSelection } from '../common/SchemaSelection/index.js';
|
|
10
|
+
import { useOneOfLocationIdx } from './useOneOfLocationIdx.js';
|
|
11
|
+
import { useTranslate } from '../../hooks/index.js';
|
|
12
|
+
import { styled } from '../../styled-components.js';
|
|
13
|
+
function OneOfSchemaComponent({ schema: { oneOf }, schema, onChange, oneOfLevel = 1, ...rest }) {
|
|
14
|
+
const translate = useTranslate();
|
|
15
|
+
const [store, setOperationStore] = useAtom(operationStore(schema.operationPointer));
|
|
16
|
+
const oneOfIdxLocation = useOneOfLocationIdx(oneOf, oneOfLevel);
|
|
17
|
+
const activeOneOfIdx = oneOfIdxLocation === -1 ? 0 : oneOfIdxLocation;
|
|
18
|
+
const activeSchemaIndex = store.activeOneOf?.[schema.pointer] !== undefined
|
|
19
|
+
? store.activeOneOf[schema.pointer]
|
|
20
|
+
: activeOneOfIdx;
|
|
21
|
+
const activeSchema = oneOf[activeSchemaIndex];
|
|
22
|
+
if (!activeSchema) {
|
|
23
|
+
return null;
|
|
24
|
+
}
|
|
25
|
+
const options = oneOf.map((subSchema, idx) => ({
|
|
26
|
+
label: subSchema.title || subSchema.typePrefix + subSchema.displayType,
|
|
27
|
+
value: idx,
|
|
28
|
+
}));
|
|
29
|
+
const handleChange = (value) => {
|
|
30
|
+
onChange?.({
|
|
31
|
+
pointer: schema.pointer,
|
|
32
|
+
index: value,
|
|
33
|
+
});
|
|
34
|
+
setOperationStore({
|
|
35
|
+
activeExampleName: schema.oneOf?.[value]?.title,
|
|
36
|
+
activeOneOf: { [schema.pointer]: value },
|
|
37
|
+
requestValues: { body: null },
|
|
38
|
+
});
|
|
39
|
+
};
|
|
40
|
+
return (_jsxs(Wrapper, { children: [_jsxs(SelectionTitle, { children: [schema.oneOfType, ":"] }), _jsx(SchemaSelection, { options: options, onChange: handleChange, pointer: schema.operationPointer, schema: schema, defaultOneOfIdx: activeOneOfIdx }), activeSchema.deprecated && (_jsx(StyledBadge, { deprecated: true, children: translate('openapi.badges.deprecated', 'Deprecated') })), activeSchema.description && _jsx(StyledDescription, { source: activeSchema.description }), _jsx(ConstraintsView, { constraints: activeSchema.constraints }), _jsx(Schema, { ...rest, schema: activeSchema, oneOfLevel: oneOfLevel + 1 })] }));
|
|
41
|
+
}
|
|
42
|
+
export const OneOfSchema = memo(OneOfSchemaComponent);
|
|
43
|
+
const StyledDescription = styled(Markdown) `
|
|
2
44
|
margin-top: var(--spacing-xs);
|
|
3
45
|
font-size: var(--font-size-base);
|
|
4
46
|
line-height: var(--line-height-base);
|
|
5
|
-
|
|
47
|
+
`;
|
|
48
|
+
const Wrapper = styled.div `
|
|
6
49
|
display: flex;
|
|
7
50
|
flex-direction: column;
|
|
8
51
|
align-items: flex-start;
|
|
9
52
|
width: 100%;
|
|
10
|
-
`;
|
|
53
|
+
`;
|
|
54
|
+
//# sourceMappingURL=OneOfSchema.js.map
|
|
@@ -1 +1,10 @@
|
|
|
1
|
-
import{jsx as
|
|
1
|
+
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
|
+
import { memo } from 'react';
|
|
3
|
+
import { RecursiveLabel, TypeName, TypeTitle } from '../common/index.js';
|
|
4
|
+
import { useTranslate } from '../../hooks/index.js';
|
|
5
|
+
function RecursiveSchemaComponent({ schema }) {
|
|
6
|
+
const translate = useTranslate();
|
|
7
|
+
return (_jsxs("div", { children: [_jsx(TypeName, { children: schema.displayType }), schema.title && _jsxs(TypeTitle, { children: [" ", schema.title, " "] }), _jsxs(RecursiveLabel, { children: [" ", translate('openapi.recursive', 'Recursive'), " "] })] }));
|
|
8
|
+
}
|
|
9
|
+
export const RecursiveSchema = memo(RecursiveSchemaComponent);
|
|
10
|
+
//# sourceMappingURL=RecursiveSchema.js.map
|