@redocly/openapi-docs 3.0.0-alpha.13 → 3.0.0-alpha.14
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/console.redocly-openapi-docs.min.js +507 -0
- package/dist/oauth2-redirect.js +3 -3
- package/dist/redocly-openapi-docs.min.js +6792 -0
- package/lib/components/ApiInfo/ApiInfo.d.ts +1 -4
- package/lib/components/ApiInfo/ApiInfo.js +1 -1
- package/lib/components/ApiInfo/index.d.ts +0 -1
- package/lib/components/ApiInfo/styled.d.ts +3 -1
- package/lib/components/ApiInfo/styled.js +1 -1
- package/lib/components/ApiInfo/types.d.ts +9 -4
- package/lib/components/CallbackSamples/CallbackSamples.d.ts +2 -3
- package/lib/components/CallbackSamples/CallbackSamples.js +1 -1
- package/lib/components/Callbacks/CallbackDetails.d.ts +1 -1
- package/lib/components/Callbacks/CallbackDetails.js +1 -1
- package/lib/components/Callbacks/CallbackOperation.js +1 -1
- package/lib/components/Callbacks/CallbacksList.js +1 -1
- package/lib/components/ChangeViewButton/ChangeViewButton.d.ts +1 -0
- package/lib/components/ChangeViewButton/ChangeViewButton.js +2 -0
- package/lib/components/ChangeViewButton/index.d.ts +1 -0
- package/lib/components/ChangeViewButton/index.js +2 -0
- package/lib/components/ChangeViewButton/styled.d.ts +3 -0
- package/lib/components/ChangeViewButton/styled.js +18 -0
- package/lib/components/ContentItem/ContentItem.d.ts +6 -6
- package/lib/components/ContentItem/ContentItem.js +1 -1
- package/lib/components/ContentItems/ContentItems.d.ts +10 -4
- package/lib/components/ContentItems/ContentItems.js +1 -1
- package/lib/components/ContentItems/helpers.d.ts +11 -0
- package/lib/components/ContentItems/helpers.js +2 -0
- package/lib/components/ContentItems/useAutoScroll.d.ts +1 -0
- package/lib/components/ContentItems/useAutoScroll.js +2 -0
- package/lib/components/DiscriminatorDropdown/DiscriminatorDropdown.d.ts +2 -2
- package/lib/components/DiscriminatorDropdown/DiscriminatorDropdown.js +1 -1
- package/lib/components/Download/DownloadButtonWithLabel.d.ts +3 -4
- package/lib/components/Download/DownloadButtonWithLabel.js +1 -1
- package/lib/components/Download/types.d.ts +12 -0
- package/lib/components/Download/useDownloadInfo.d.ts +2 -0
- package/lib/components/Download/useDownloadInfo.js +2 -0
- package/lib/components/Endpoint/Endpoint.js +1 -1
- package/lib/components/Endpoint/ServerList.js +1 -1
- package/lib/components/ExternalDocumentation/ExternalDocumentation.d.ts +2 -2
- package/lib/components/ExternalDocumentation/ExternalDocumentation.js +2 -2
- package/lib/components/Fields/DescriptionEnums.js +1 -1
- package/lib/components/Fields/EnumValues.js +1 -1
- package/lib/components/Fields/Examples.js +1 -1
- package/lib/components/Fields/Extensions.js +2 -2
- package/lib/components/Fields/Field.d.ts +3 -2
- package/lib/components/Fields/Field.js +1 -1
- package/lib/components/Fields/FieldDetails.d.ts +2 -3
- package/lib/components/Fields/FieldDetails.js +1 -1
- package/lib/components/Fields/SimpleEnums.js +1 -1
- package/lib/components/Fields/types.d.ts +0 -1
- package/lib/components/GenericChildrenSwitcher/GenericChildrenSwitcher.js +1 -1
- package/lib/components/Markdown/Markdown.d.ts +1 -1
- package/lib/components/Markdown/Markdown.js +1 -1
- package/lib/components/Markdown/index.d.ts +0 -2
- package/lib/components/Markdown/index.js +1 -1
- package/lib/components/Markdown/styled.js +1 -3
- package/lib/components/Markdown/types.d.ts +5 -13
- package/lib/components/MediaTypeSwitch/MediaTypesSwitch.d.ts +2 -2
- package/lib/components/MediaTypeSwitch/MediaTypesSwitch.js +1 -1
- package/lib/components/NextSectionButton/NextSectionButton.d.ts +8 -0
- package/lib/components/NextSectionButton/NextSectionButton.js +2 -0
- package/lib/components/NextSectionButton/index.d.ts +1 -0
- package/lib/components/NextSectionButton/index.js +2 -0
- package/lib/components/NextSectionButton/styled.d.ts +1 -0
- package/lib/components/NextSectionButton/styled.js +18 -0
- package/lib/components/OperationItem/OperationItem.d.ts +3 -0
- package/lib/components/OperationItem/OperationItem.js +9 -0
- package/lib/components/OperationItem/index.d.ts +2 -0
- package/lib/components/OperationItem/index.js +2 -0
- package/lib/components/OperationItem/types.d.ts +4 -0
- package/lib/components/{Operation → OperationItem}/types.js +0 -0
- package/lib/components/Overlay.d.ts +2 -7
- package/lib/components/Overlay.js +1 -1
- package/lib/components/Panel/ResponsePanel.js +2 -2
- package/lib/components/Parameters/BodyContent.d.ts +3 -2
- package/lib/components/Parameters/BodyContent.js +1 -1
- package/lib/components/Parameters/ParametersGroup.js +1 -1
- package/lib/components/PayloadSamples/MediaTypeSamples.d.ts +2 -3
- package/lib/components/PayloadSamples/MediaTypeSamples.js +1 -1
- package/lib/components/PayloadSamples/PayloadSamples.d.ts +2 -3
- package/lib/components/PayloadSamples/PayloadSamples.js +1 -1
- package/lib/components/PayloadSamples/types.d.ts +1 -2
- package/lib/components/PayloadSamples/useExternalExample.js +1 -1
- package/lib/components/RedoclyOpenAPIDocs/Providers.d.ts +6 -0
- package/lib/components/RedoclyOpenAPIDocs/Providers.js +2 -0
- package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocs.d.ts +4 -0
- package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocs.js +2 -0
- package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsMultiStandalone.d.ts +2 -0
- package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsMultiStandalone.js +2 -0
- package/lib/components/RedoclyOpenAPIDocs/index.d.ts +5 -0
- package/lib/components/RedoclyOpenAPIDocs/index.js +2 -0
- package/lib/components/RedoclyOpenAPIDocs/styled.d.ts +13 -0
- package/lib/components/RedoclyOpenAPIDocs/styled.js +170 -0
- package/lib/components/RedoclyOpenAPIDocs/types.d.ts +63 -0
- package/lib/components/{types.js → RedoclyOpenAPIDocs/types.js} +0 -0
- package/lib/components/RedoclyOpenAPIDocs/utils.d.ts +10 -0
- package/lib/components/RedoclyOpenAPIDocs/utils.js +2 -0
- package/lib/components/RequestSamples/CodeSample.d.ts +1 -1
- package/lib/components/RequestSamples/CodeSample.js +1 -1
- package/lib/components/RequestSamples/Example.d.ts +2 -2
- package/lib/components/RequestSamples/Example.js +1 -1
- package/lib/components/RequestSamples/RequestSamples.d.ts +1 -1
- package/lib/components/RequestSamples/RequestSamples.js +1 -1
- package/lib/components/ResponseSamples/ResponseSamples.d.ts +4 -1
- package/lib/components/ResponseSamples/ResponseSamples.js +1 -1
- package/lib/components/Responses/Response.d.ts +1 -3
- package/lib/components/Responses/Response.js +1 -1
- package/lib/components/Responses/ResponseSummary.js +14 -1
- package/lib/components/Responses/styled.js +2 -2
- package/lib/components/Samples/SamplesTabs.d.ts +3 -2
- package/lib/components/Samples/SamplesTabs.js +1 -1
- package/lib/components/Samples/use-example-key.d.ts +1 -1
- package/lib/components/Samples/use-example-key.js +1 -1
- package/lib/components/Schema/ObjectSchema.d.ts +1 -1
- package/lib/components/Schema/ObjectSchema.js +1 -1
- package/lib/components/Schema/OneOfSchema.d.ts +1 -1
- package/lib/components/Schema/OneOfSchema.js +1 -1
- package/lib/components/Schema/RecursiveSchema.d.ts +1 -1
- package/lib/components/Schema/RecursiveSchema.js +1 -1
- package/lib/components/Schema/Schema.d.ts +1 -1
- package/lib/components/Schema/Schema.js +1 -1
- package/lib/components/SchemaDefinition/SchemaDefinition.d.ts +1 -7
- package/lib/components/SchemaDefinition/SchemaDefinition.js +1 -1
- package/lib/components/Search/MenuItemSearch.d.ts +2 -0
- package/lib/components/Search/MenuItemSearch.js +2 -0
- package/lib/components/Search/Search.d.ts +3 -0
- package/lib/components/Search/Search.js +2 -0
- package/lib/components/Search/SearchBox.d.ts +2 -8
- package/lib/components/Search/SearchBox.js +1 -1
- package/lib/components/Search/index.d.ts +1 -0
- package/lib/components/Search/index.js +1 -1
- package/lib/components/Search/types.d.ts +11 -8
- package/lib/components/Search/utils.js +1 -1
- package/lib/components/SectionContent/SectionContent.d.ts +15 -0
- package/lib/components/SectionContent/SectionContent.js +2 -0
- package/lib/components/SectionContent/index.d.ts +1 -0
- package/lib/components/SectionContent/index.js +2 -0
- package/lib/components/SectionItem/SectionItem.d.ts +2 -3
- package/lib/components/SectionItem/SectionItem.js +1 -1
- package/lib/components/SecurityRequirement/PanelDescription.d.ts +1 -6
- package/lib/components/SecurityRequirement/RequirementElement.d.ts +2 -7
- package/lib/components/SecurityRequirement/RequirementElement.js +3 -3
- package/lib/components/SecurityRequirement/SecurityDefs.d.ts +1 -7
- package/lib/components/SecurityRequirement/SecurityDefs.js +1 -1
- package/lib/components/SecurityRequirement/SecurityRequirement.d.ts +3 -6
- package/lib/components/SecurityRequirement/SecurityRequirement.js +1 -1
- package/lib/components/SecurityRequirement/constants.d.ts +6 -6
- package/lib/components/SecurityRequirement/constants.js +1 -1
- package/lib/components/SecurityRequirement/types.d.ts +19 -0
- package/lib/components/SecurityRequirement/types.js +2 -0
- package/lib/components/SecurityRequirement/useSecurityRequirements.d.ts +3 -0
- package/lib/components/SecurityRequirement/useSecurityRequirements.js +2 -0
- package/lib/components/SecuritySchemes/OAuthFlow.d.ts +3 -0
- package/lib/components/SecuritySchemes/OAuthFlow.js +2 -0
- package/lib/components/SecuritySchemes/helpers.d.ts +1 -1
- package/lib/components/SecuritySchemes/index.d.ts +1 -1
- package/lib/components/SecuritySchemes/index.js +1 -1
- package/lib/components/SecuritySchemes/types.d.ts +0 -1
- package/lib/components/SideMenu/MenuItem.d.ts +7 -5
- package/lib/components/SideMenu/MenuItem.js +1 -1
- package/lib/components/SideMenu/MenuItemEternalLink.d.ts +1 -2
- package/lib/components/SideMenu/MenuItemEternalLink.js +1 -1
- package/lib/components/SideMenu/MenuItemLink.d.ts +3 -0
- package/lib/components/SideMenu/MenuItemLink.js +2 -0
- package/lib/components/SideMenu/MenuItems.d.ts +2 -1
- package/lib/components/SideMenu/MenuItems.js +1 -1
- package/lib/components/SideMenu/MenuOperationItemContent.d.ts +5 -3
- package/lib/components/SideMenu/MenuOperationItemContent.js +2 -2
- package/lib/components/SideMenu/SideMenu.d.ts +8 -5
- package/lib/components/SideMenu/SideMenu.js +1 -1
- package/lib/components/SideMenu/styled.d.ts +10 -5
- package/lib/components/SideMenu/styled.js +12 -12
- package/lib/components/SideMenu/types.d.ts +10 -4
- package/lib/components/SideMenu/useMenuItemLink.d.ts +18 -0
- package/lib/components/SideMenu/useMenuItemLink.js +2 -0
- package/lib/components/StickySidebar/StickyResponsiveSidebar.d.ts +4 -6
- package/lib/components/StickySidebar/StickyResponsiveSidebar.js +2 -3
- package/lib/components/Tabs/CollapsingTabs/CollapsingTabs.d.ts +2 -1
- package/lib/components/Tabs/CollapsingTabs/CollapsingTabs.js +1 -1
- package/lib/components/Tabs/CollapsingTabs/CollapsingTabsBase.d.ts +1 -1
- package/lib/components/Tabs/CollapsingTabs/CollapsingTabsBase.js +1 -1
- package/lib/components/TagItem/TagItem.d.ts +2 -0
- package/lib/components/TagItem/TagItem.js +2 -0
- package/lib/components/TagItem/index.d.ts +1 -0
- package/lib/components/TagItem/index.js +2 -0
- package/lib/components/TagItems/TagItems.d.ts +13 -0
- package/lib/components/TagItems/TagItems.js +2 -0
- package/lib/components/TagItems/index.d.ts +1 -0
- package/lib/components/TagItems/index.js +2 -0
- package/lib/components/ToggleRightPanelButton/ToggleRightPanelButton.d.ts +1 -0
- package/lib/components/ToggleRightPanelButton/ToggleRightPanelButton.js +2 -0
- package/lib/components/ToggleRightPanelButton/index.d.ts +1 -0
- package/lib/components/ToggleRightPanelButton/index.js +2 -0
- package/lib/components/ToggleRightPanelButton/styled.d.ts +3 -0
- package/lib/components/ToggleRightPanelButton/styled.js +17 -0
- package/lib/components/VersionSwitcher.d.ts +4 -3
- package/lib/components/VersionSwitcher.js +1 -1
- package/lib/components/common/Dropdown/Dropdown.js +2 -2
- package/lib/components/common/Fields/fields-layout.d.ts +0 -1
- package/lib/components/common/Fields/fields-layout.js +1 -6
- package/lib/components/common/LinkToField.d.ts +11 -2
- package/lib/components/common/LinkToField.js +9 -22
- package/lib/components/common/Portal/Portal.d.ts +6 -0
- package/lib/components/common/Portal/Portal.js +2 -0
- package/lib/components/common/Portal/index.d.ts +1 -0
- package/lib/components/common/Portal/index.js +2 -0
- package/lib/components/{ContentItems → common/Skeleton}/Skeleton.d.ts +0 -0
- package/lib/components/{ContentItems → common/Skeleton}/Skeleton.js +2 -2
- package/lib/components/common/Skeleton/index.d.ts +1 -0
- package/lib/components/common/Skeleton/index.js +2 -0
- package/lib/components/common/headers.d.ts +0 -6
- package/lib/components/common/headers.js +1 -25
- package/lib/components/common/index.d.ts +4 -2
- package/lib/components/common/index.js +1 -1
- package/lib/components/common/linkify.d.ts +3 -7
- package/lib/components/common/linkify.js +6 -51
- package/lib/components/common/panels.js +7 -4
- package/lib/components/common/perfect-scrollbar.js +2 -2
- package/lib/components/icons/LockIcon.d.ts +1 -1
- package/lib/components/icons/Spinner.d.ts +1 -1
- package/lib/components/index.d.ts +8 -9
- package/lib/components/index.js +1 -1
- package/lib/components/pluggable/PullRight.d.ts +3 -2
- package/lib/components/pluggable/PullRight.js +1 -55
- package/lib/components/pluggable/RedocExample.d.ts +1 -3
- package/lib/components/pluggable/RedocExample.js +1 -1
- package/lib/components/pluggable/RedocRequestBody.d.ts +1 -3
- package/lib/components/pluggable/RedocRequestBody.js +1 -1
- package/lib/components/pluggable/RedocResponse.d.ts +1 -3
- package/lib/components/pluggable/RedocResponse.js +1 -1
- package/lib/components/pluggable/RedocSchema.d.ts +1 -3
- package/lib/components/pluggable/RedocSchema.js +1 -1
- package/lib/components/rightPanel/CodemirrorInput/CodemirrorInput.js +1 -1
- package/lib/components/rightPanel/CodemirrorInput/helpers.d.ts +1 -10
- package/lib/components/rightPanel/CodemirrorInput/helpers.js +1 -1
- package/lib/components/rightPanel/Console/Console.d.ts +2 -2
- package/lib/components/rightPanel/Console/Console.js +1 -1
- package/lib/components/rightPanel/Console/ConsoleLazy.js +1 -1
- package/lib/components/rightPanel/Console/ConsoleWrapper.d.ts +5 -2
- package/lib/components/rightPanel/Console/ConsoleWrapper.js +1 -1
- package/lib/components/rightPanel/Console/Request.d.ts +3 -12
- package/lib/components/rightPanel/Console/Request.js +1 -1
- package/lib/components/rightPanel/Console/types.d.ts +14 -3
- package/lib/components/rightPanel/OAuth2Flow/OAuth2Flow.js +1 -1
- package/lib/components/rightPanel/OpenIDConnect.d.ts +2 -2
- package/lib/components/rightPanel/RequestBody/Body.d.ts +1 -1
- package/lib/components/rightPanel/RequestBody/Body.js +1 -1
- package/lib/components/rightPanel/RequestBody/RequestBody.d.ts +1 -1
- package/lib/components/rightPanel/RequestBody/RequestBody.js +1 -1
- package/lib/components/rightPanel/RequestBody/types.d.ts +1 -0
- package/lib/components/rightPanel/RequestBodyForm.d.ts +6 -3
- package/lib/components/rightPanel/RequestBodyForm.js +1 -1
- package/lib/components/rightPanel/ResponseHeadersList.js +1 -1
- package/lib/components/rightPanel/ServerVariable.d.ts +1 -1
- package/lib/components/rightPanel/ServerVariable.js +1 -1
- package/lib/components/rightPanel/ServersDropdown/ServersDropdown.d.ts +2 -1
- package/lib/components/rightPanel/ServersDropdown/ServersDropdown.js +1 -1
- package/lib/components/rightPanel/utils.d.ts +3 -2
- package/lib/components/rightPanel/utils.js +1 -1
- package/lib/constants.d.ts +0 -2
- package/lib/constants.js +1 -1
- package/lib/events/codeSampleCopy.js +1 -1
- package/lib/events/types.d.ts +2 -2
- package/lib/hoc/types.d.ts +38 -0
- package/lib/hoc/types.js +2 -0
- package/lib/hoc/utils.d.ts +2 -0
- package/lib/hoc/utils.js +2 -0
- package/lib/hoc/withRouter.d.ts +3 -0
- package/lib/hoc/withRouter.js +2 -0
- package/lib/hooks/index.d.ts +4 -0
- package/lib/hooks/index.js +1 -1
- package/lib/hooks/useActivateExample.d.ts +2 -0
- package/lib/hooks/useActivateExample.js +2 -0
- package/lib/hooks/useContentItems.d.ts +12 -0
- package/lib/hooks/useContentItems.js +2 -0
- package/lib/hooks/useLicense.d.ts +5 -0
- package/lib/hooks/useLicense.js +2 -0
- package/lib/hooks/useRouter.d.ts +11 -0
- package/lib/hooks/useRouter.js +2 -0
- package/lib/index.d.ts +2 -1
- package/lib/index.js +1 -1
- package/lib/models/callback.d.ts +5 -0
- package/lib/models/callback.js +2 -0
- package/lib/models/example.d.ts +10 -0
- package/lib/models/example.js +2 -0
- package/lib/models/field.d.ts +7 -0
- package/lib/models/field.js +2 -0
- package/lib/models/group.d.ts +4 -0
- package/lib/models/group.js +2 -0
- package/lib/models/index.d.ts +13 -14
- package/lib/models/index.js +1 -1
- package/lib/models/mediaContent.d.ts +7 -0
- package/lib/models/mediaContent.js +2 -0
- package/lib/models/mediaType.d.ts +20 -0
- package/lib/models/mediaType.js +2 -0
- package/lib/models/operation.d.ts +18 -0
- package/lib/models/operation.js +2 -0
- package/lib/models/request.d.ts +12 -0
- package/lib/models/request.js +2 -0
- package/lib/models/response.d.ts +15 -0
- package/lib/models/response.js +2 -0
- package/lib/models/schema.d.ts +14 -0
- package/lib/models/schema.js +2 -0
- package/lib/models/security.d.ts +13 -0
- package/lib/models/security.js +2 -0
- package/lib/models/types.d.ts +233 -3
- package/lib/recoil/app.d.ts +32 -0
- package/lib/recoil/app.js +2 -0
- package/lib/recoil/operation.d.ts +11 -0
- package/lib/recoil/operation.js +2 -0
- package/lib/recoil/store.d.ts +19 -0
- package/lib/recoil/store.js +2 -0
- package/lib/services/OpenAPIParser.d.ts +1 -1
- package/lib/services/OpenAPIParser.js +1 -1
- package/lib/services/Options/index.d.ts +1 -1
- package/lib/services/Options/index.js +1 -1
- package/lib/services/Options/{NormalizedOptions.d.ts → normalizeOptions.d.ts} +1 -1
- package/lib/services/Options/normalizeOptions.js +2 -0
- package/lib/services/Options/types.d.ts +31 -15
- package/lib/services/code-samples/generator.js +1 -1
- package/lib/services/code-samples/httpsnippet/targets/index.d.ts +1 -1
- package/lib/services/code-samples/httpsnippet/targets/javascript/index.d.ts +1 -1
- package/lib/services/code-samples/httpsnippet/targets/shell/curl.d.ts +2 -2
- package/lib/services/code-samples/types.d.ts +2 -2
- package/lib/services/history/helpers.d.ts +1 -1
- package/lib/services/history/helpers.js +1 -1
- package/lib/services/history/index.d.ts +1 -4
- package/lib/services/history/index.js +1 -1
- package/lib/services/index.d.ts +2 -7
- package/lib/services/index.js +1 -1
- package/lib/services/menu/builder.d.ts +9 -0
- package/lib/services/menu/builder.js +2 -0
- package/lib/services/menu/helpers.d.ts +6 -0
- package/lib/services/menu/helpers.js +2 -0
- package/lib/services/menu/index.d.ts +1 -0
- package/lib/services/menu/index.js +2 -0
- package/lib/services/menu/markdown.d.ts +11 -0
- package/lib/services/menu/markdown.js +2 -0
- package/lib/services/menu/operation.d.ts +13 -0
- package/lib/services/menu/operation.js +2 -0
- package/lib/services/menu/tags.d.ts +27 -0
- package/lib/services/menu/tags.js +2 -0
- package/lib/services/search/DeepSearchStore.d.ts +3 -3
- package/lib/services/search/DeepSearchStore.js +1 -1
- package/lib/services/search/SearchStore.d.ts +1 -1
- package/lib/services/search/useSearch.d.ts +13 -0
- package/lib/services/search/useSearch.js +2 -0
- package/lib/services/types.d.ts +42 -91
- package/lib/services/types.js +1 -1
- package/lib/services/utils.d.ts +1 -0
- package/lib/services/utils.js +1 -1
- package/lib/standalone.d.ts +5 -5
- package/lib/standalone.js +1 -1
- package/lib/testProviders.d.ts +2 -2
- package/lib/testProviders.js +1 -1
- package/lib/types/app.d.ts +1 -0
- package/lib/types/app.js +2 -0
- package/lib/types/index.d.ts +1 -0
- package/lib/types/index.js +1 -1
- package/lib/types/open-api.d.ts +15 -15
- package/lib/utils/compose.d.ts +1 -0
- package/lib/utils/compose.js +2 -0
- package/lib/utils/helpers.d.ts +2 -1
- package/lib/utils/helpers.js +1 -1
- package/lib/utils/index.d.ts +3 -2
- package/lib/utils/index.js +1 -1
- package/lib/utils/local-storage.js +1 -1
- package/lib/utils/openapi.d.ts +11 -7
- package/lib/utils/openapi.js +1 -1
- package/lib/utils/saveTextBeforeHeading.d.ts +1 -0
- package/lib/utils/saveTextBeforeHeading.js +2 -0
- package/lib/utils/typeGuards.d.ts +3 -0
- package/lib/utils/typeGuards.js +2 -0
- package/lib-esm/components/ApiInfo/ApiInfo.d.ts +1 -4
- package/lib-esm/components/ApiInfo/ApiInfo.js +1 -1
- package/lib-esm/components/ApiInfo/index.d.ts +0 -1
- package/lib-esm/components/ApiInfo/styled.d.ts +3 -1
- package/lib-esm/components/ApiInfo/styled.js +1 -1
- package/lib-esm/components/ApiInfo/types.d.ts +9 -4
- package/lib-esm/components/CallbackSamples/CallbackSamples.d.ts +2 -3
- package/lib-esm/components/CallbackSamples/CallbackSamples.js +1 -1
- package/lib-esm/components/Callbacks/CallbackDetails.d.ts +1 -1
- package/lib-esm/components/Callbacks/CallbackDetails.js +1 -1
- package/lib-esm/components/Callbacks/CallbackOperation.js +1 -1
- package/lib-esm/components/Callbacks/CallbacksList.js +1 -1
- package/lib-esm/components/ChangeViewButton/ChangeViewButton.d.ts +1 -0
- package/lib-esm/components/ChangeViewButton/ChangeViewButton.js +2 -0
- package/lib-esm/components/ChangeViewButton/index.d.ts +1 -0
- package/lib-esm/components/ChangeViewButton/index.js +2 -0
- package/lib-esm/components/ChangeViewButton/styled.d.ts +3 -0
- package/lib-esm/components/ChangeViewButton/styled.js +18 -0
- package/lib-esm/components/ContentItem/ContentItem.d.ts +6 -6
- package/lib-esm/components/ContentItem/ContentItem.js +1 -1
- package/lib-esm/components/ContentItems/ContentItems.d.ts +10 -4
- package/lib-esm/components/ContentItems/ContentItems.js +1 -1
- package/lib-esm/components/ContentItems/helpers.d.ts +11 -0
- package/lib-esm/components/ContentItems/helpers.js +2 -0
- package/lib-esm/components/ContentItems/useAutoScroll.d.ts +1 -0
- package/lib-esm/components/ContentItems/useAutoScroll.js +2 -0
- package/lib-esm/components/DiscriminatorDropdown/DiscriminatorDropdown.d.ts +2 -2
- package/lib-esm/components/DiscriminatorDropdown/DiscriminatorDropdown.js +1 -1
- package/lib-esm/components/Download/DownloadButtonWithLabel.d.ts +3 -4
- package/lib-esm/components/Download/DownloadButtonWithLabel.js +1 -1
- package/lib-esm/components/Download/types.d.ts +12 -0
- package/lib-esm/components/Download/useDownloadInfo.d.ts +2 -0
- package/lib-esm/components/Download/useDownloadInfo.js +2 -0
- package/lib-esm/components/Endpoint/Endpoint.js +1 -1
- package/lib-esm/components/Endpoint/ServerList.js +1 -1
- package/lib-esm/components/ExternalDocumentation/ExternalDocumentation.d.ts +2 -2
- package/lib-esm/components/ExternalDocumentation/ExternalDocumentation.js +3 -3
- package/lib-esm/components/Fields/DescriptionEnums.js +1 -1
- package/lib-esm/components/Fields/EnumValues.js +1 -1
- package/lib-esm/components/Fields/Examples.js +1 -1
- package/lib-esm/components/Fields/Extensions.js +2 -2
- package/lib-esm/components/Fields/Field.d.ts +3 -2
- package/lib-esm/components/Fields/Field.js +1 -1
- package/lib-esm/components/Fields/FieldDetails.d.ts +2 -3
- package/lib-esm/components/Fields/FieldDetails.js +1 -1
- package/lib-esm/components/Fields/SimpleEnums.js +1 -1
- package/lib-esm/components/Fields/types.d.ts +0 -1
- package/lib-esm/components/GenericChildrenSwitcher/GenericChildrenSwitcher.js +1 -1
- package/lib-esm/components/Markdown/Markdown.d.ts +1 -1
- package/lib-esm/components/Markdown/Markdown.js +1 -1
- package/lib-esm/components/Markdown/index.d.ts +0 -2
- package/lib-esm/components/Markdown/index.js +1 -1
- package/lib-esm/components/Markdown/styled.js +1 -3
- package/lib-esm/components/Markdown/types.d.ts +5 -13
- package/lib-esm/components/MediaTypeSwitch/MediaTypesSwitch.d.ts +2 -2
- package/lib-esm/components/MediaTypeSwitch/MediaTypesSwitch.js +1 -1
- package/lib-esm/components/NextSectionButton/NextSectionButton.d.ts +8 -0
- package/lib-esm/components/NextSectionButton/NextSectionButton.js +2 -0
- package/lib-esm/components/NextSectionButton/index.d.ts +1 -0
- package/lib-esm/components/NextSectionButton/index.js +2 -0
- package/lib-esm/components/NextSectionButton/styled.d.ts +1 -0
- package/lib-esm/components/NextSectionButton/styled.js +18 -0
- package/lib-esm/components/OperationItem/OperationItem.d.ts +3 -0
- package/lib-esm/components/OperationItem/OperationItem.js +9 -0
- package/lib-esm/components/OperationItem/index.d.ts +2 -0
- package/lib-esm/components/OperationItem/index.js +2 -0
- package/lib-esm/components/OperationItem/types.d.ts +4 -0
- package/lib-esm/components/{Operation → OperationItem}/types.js +0 -0
- package/lib-esm/components/Overlay.d.ts +2 -7
- package/lib-esm/components/Overlay.js +1 -1
- package/lib-esm/components/Panel/ResponsePanel.js +1 -1
- package/lib-esm/components/Parameters/BodyContent.d.ts +3 -2
- package/lib-esm/components/Parameters/BodyContent.js +1 -1
- package/lib-esm/components/Parameters/ParametersGroup.js +1 -1
- package/lib-esm/components/PayloadSamples/MediaTypeSamples.d.ts +2 -3
- package/lib-esm/components/PayloadSamples/MediaTypeSamples.js +1 -1
- package/lib-esm/components/PayloadSamples/PayloadSamples.d.ts +2 -3
- package/lib-esm/components/PayloadSamples/PayloadSamples.js +1 -1
- package/lib-esm/components/PayloadSamples/types.d.ts +1 -2
- package/lib-esm/components/PayloadSamples/useExternalExample.js +1 -1
- package/lib-esm/components/RedoclyOpenAPIDocs/Providers.d.ts +6 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/Providers.js +2 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocs.d.ts +4 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocs.js +2 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsMultiStandalone.d.ts +2 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsMultiStandalone.js +2 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/index.d.ts +5 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/index.js +2 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/styled.d.ts +13 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/styled.js +170 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/types.d.ts +63 -0
- package/lib-esm/components/{types.js → RedoclyOpenAPIDocs/types.js} +0 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/utils.d.ts +10 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/utils.js +2 -0
- package/lib-esm/components/RequestSamples/CodeSample.d.ts +1 -1
- package/lib-esm/components/RequestSamples/CodeSample.js +1 -1
- package/lib-esm/components/RequestSamples/Example.d.ts +2 -2
- package/lib-esm/components/RequestSamples/Example.js +1 -1
- package/lib-esm/components/RequestSamples/RequestSamples.d.ts +1 -1
- package/lib-esm/components/RequestSamples/RequestSamples.js +1 -1
- package/lib-esm/components/ResponseSamples/ResponseSamples.d.ts +4 -1
- package/lib-esm/components/ResponseSamples/ResponseSamples.js +1 -1
- package/lib-esm/components/Responses/Response.d.ts +1 -3
- package/lib-esm/components/Responses/Response.js +1 -1
- package/lib-esm/components/Responses/ResponseSummary.js +14 -1
- package/lib-esm/components/Responses/styled.js +2 -2
- package/lib-esm/components/Samples/SamplesTabs.d.ts +3 -2
- package/lib-esm/components/Samples/SamplesTabs.js +1 -1
- package/lib-esm/components/Samples/use-example-key.d.ts +1 -1
- package/lib-esm/components/Samples/use-example-key.js +1 -1
- package/lib-esm/components/Schema/ObjectSchema.d.ts +1 -1
- package/lib-esm/components/Schema/ObjectSchema.js +1 -1
- package/lib-esm/components/Schema/OneOfSchema.d.ts +1 -1
- package/lib-esm/components/Schema/OneOfSchema.js +1 -1
- package/lib-esm/components/Schema/RecursiveSchema.d.ts +1 -1
- package/lib-esm/components/Schema/RecursiveSchema.js +1 -1
- package/lib-esm/components/Schema/Schema.d.ts +1 -1
- package/lib-esm/components/Schema/Schema.js +1 -1
- package/lib-esm/components/SchemaDefinition/SchemaDefinition.d.ts +1 -7
- package/lib-esm/components/SchemaDefinition/SchemaDefinition.js +1 -1
- package/lib-esm/components/Search/MenuItemSearch.d.ts +2 -0
- package/lib-esm/components/Search/MenuItemSearch.js +2 -0
- package/lib-esm/components/Search/Search.d.ts +3 -0
- package/lib-esm/components/Search/Search.js +2 -0
- package/lib-esm/components/Search/SearchBox.d.ts +2 -8
- package/lib-esm/components/Search/SearchBox.js +1 -1
- package/lib-esm/components/Search/index.d.ts +1 -0
- package/lib-esm/components/Search/index.js +1 -1
- package/lib-esm/components/Search/types.d.ts +11 -8
- package/lib-esm/components/Search/utils.js +1 -1
- package/lib-esm/components/SectionContent/SectionContent.d.ts +15 -0
- package/lib-esm/components/SectionContent/SectionContent.js +2 -0
- package/lib-esm/components/SectionContent/index.d.ts +1 -0
- package/lib-esm/components/SectionContent/index.js +2 -0
- package/lib-esm/components/SectionItem/SectionItem.d.ts +2 -3
- package/lib-esm/components/SectionItem/SectionItem.js +1 -1
- package/lib-esm/components/SecurityRequirement/PanelDescription.d.ts +1 -6
- package/lib-esm/components/SecurityRequirement/RequirementElement.d.ts +2 -7
- package/lib-esm/components/SecurityRequirement/RequirementElement.js +1 -1
- package/lib-esm/components/SecurityRequirement/SecurityDefs.d.ts +1 -7
- package/lib-esm/components/SecurityRequirement/SecurityDefs.js +1 -1
- package/lib-esm/components/SecurityRequirement/SecurityRequirement.d.ts +3 -6
- package/lib-esm/components/SecurityRequirement/SecurityRequirement.js +1 -1
- package/lib-esm/components/SecurityRequirement/constants.d.ts +6 -6
- package/lib-esm/components/SecurityRequirement/constants.js +1 -1
- package/lib-esm/components/SecurityRequirement/types.d.ts +19 -0
- package/lib-esm/components/SecurityRequirement/types.js +2 -0
- package/lib-esm/components/SecurityRequirement/useSecurityRequirements.d.ts +3 -0
- package/lib-esm/components/SecurityRequirement/useSecurityRequirements.js +2 -0
- package/lib-esm/components/SecuritySchemes/OAuthFlow.d.ts +3 -0
- package/lib-esm/components/SecuritySchemes/OAuthFlow.js +2 -0
- package/lib-esm/components/SecuritySchemes/helpers.d.ts +1 -1
- package/lib-esm/components/SecuritySchemes/index.d.ts +1 -1
- package/lib-esm/components/SecuritySchemes/index.js +1 -1
- package/lib-esm/components/SecuritySchemes/types.d.ts +0 -1
- package/lib-esm/components/SideMenu/MenuItem.d.ts +7 -5
- package/lib-esm/components/SideMenu/MenuItem.js +1 -1
- package/lib-esm/components/SideMenu/MenuItemEternalLink.d.ts +1 -2
- package/lib-esm/components/SideMenu/MenuItemEternalLink.js +1 -1
- package/lib-esm/components/SideMenu/MenuItemLink.d.ts +3 -0
- package/lib-esm/components/SideMenu/MenuItemLink.js +2 -0
- package/lib-esm/components/SideMenu/MenuItems.d.ts +2 -1
- package/lib-esm/components/SideMenu/MenuItems.js +1 -1
- package/lib-esm/components/SideMenu/MenuOperationItemContent.d.ts +5 -3
- package/lib-esm/components/SideMenu/MenuOperationItemContent.js +2 -2
- package/lib-esm/components/SideMenu/SideMenu.d.ts +8 -5
- package/lib-esm/components/SideMenu/SideMenu.js +1 -1
- package/lib-esm/components/SideMenu/styled.d.ts +10 -5
- package/lib-esm/components/SideMenu/styled.js +12 -12
- package/lib-esm/components/SideMenu/types.d.ts +10 -4
- package/lib-esm/components/SideMenu/useMenuItemLink.d.ts +18 -0
- package/lib-esm/components/SideMenu/useMenuItemLink.js +2 -0
- package/lib-esm/components/StickySidebar/StickyResponsiveSidebar.d.ts +4 -6
- package/lib-esm/components/StickySidebar/StickyResponsiveSidebar.js +2 -3
- package/lib-esm/components/Tabs/CollapsingTabs/CollapsingTabs.d.ts +2 -1
- package/lib-esm/components/Tabs/CollapsingTabs/CollapsingTabs.js +1 -1
- package/lib-esm/components/Tabs/CollapsingTabs/CollapsingTabsBase.d.ts +1 -1
- package/lib-esm/components/Tabs/CollapsingTabs/CollapsingTabsBase.js +1 -1
- package/lib-esm/components/TagItem/TagItem.d.ts +2 -0
- package/lib-esm/components/TagItem/TagItem.js +2 -0
- package/lib-esm/components/TagItem/index.d.ts +1 -0
- package/lib-esm/components/TagItem/index.js +2 -0
- package/lib-esm/components/TagItems/TagItems.d.ts +13 -0
- package/lib-esm/components/TagItems/TagItems.js +2 -0
- package/lib-esm/components/TagItems/index.d.ts +1 -0
- package/lib-esm/components/TagItems/index.js +2 -0
- package/lib-esm/components/ToggleRightPanelButton/ToggleRightPanelButton.d.ts +1 -0
- package/lib-esm/components/ToggleRightPanelButton/ToggleRightPanelButton.js +2 -0
- package/lib-esm/components/ToggleRightPanelButton/index.d.ts +1 -0
- package/lib-esm/components/ToggleRightPanelButton/index.js +2 -0
- package/lib-esm/components/ToggleRightPanelButton/styled.d.ts +3 -0
- package/lib-esm/components/ToggleRightPanelButton/styled.js +17 -0
- package/lib-esm/components/VersionSwitcher.d.ts +4 -3
- package/lib-esm/components/VersionSwitcher.js +1 -1
- package/lib-esm/components/common/Dropdown/Dropdown.js +2 -2
- package/lib-esm/components/common/Fields/fields-layout.d.ts +0 -1
- package/lib-esm/components/common/Fields/fields-layout.js +0 -5
- package/lib-esm/components/common/LinkToField.d.ts +11 -2
- package/lib-esm/components/common/LinkToField.js +9 -22
- package/lib-esm/components/common/Portal/Portal.d.ts +6 -0
- package/lib-esm/components/common/Portal/Portal.js +2 -0
- package/lib-esm/components/common/Portal/index.d.ts +1 -0
- package/lib-esm/components/common/Portal/index.js +2 -0
- package/lib-esm/components/{ContentItems → common/Skeleton}/Skeleton.d.ts +0 -0
- package/lib-esm/components/{ContentItems → common/Skeleton}/Skeleton.js +1 -1
- package/lib-esm/components/common/Skeleton/index.d.ts +1 -0
- package/lib-esm/components/common/Skeleton/index.js +2 -0
- package/lib-esm/components/common/headers.d.ts +0 -6
- package/lib-esm/components/common/headers.js +1 -25
- package/lib-esm/components/common/index.d.ts +4 -2
- package/lib-esm/components/common/index.js +1 -1
- package/lib-esm/components/common/linkify.d.ts +3 -7
- package/lib-esm/components/common/linkify.js +6 -51
- package/lib-esm/components/common/panels.js +13 -10
- package/lib-esm/components/common/perfect-scrollbar.js +2 -2
- package/lib-esm/components/icons/LockIcon.d.ts +1 -1
- package/lib-esm/components/icons/Spinner.d.ts +1 -1
- package/lib-esm/components/index.d.ts +8 -9
- package/lib-esm/components/index.js +1 -1
- package/lib-esm/components/pluggable/PullRight.d.ts +3 -2
- package/lib-esm/components/pluggable/PullRight.js +1 -55
- package/lib-esm/components/pluggable/RedocExample.d.ts +1 -3
- package/lib-esm/components/pluggable/RedocExample.js +1 -1
- package/lib-esm/components/pluggable/RedocRequestBody.d.ts +1 -3
- package/lib-esm/components/pluggable/RedocRequestBody.js +1 -1
- package/lib-esm/components/pluggable/RedocResponse.d.ts +1 -3
- package/lib-esm/components/pluggable/RedocResponse.js +1 -1
- package/lib-esm/components/pluggable/RedocSchema.d.ts +1 -3
- package/lib-esm/components/pluggable/RedocSchema.js +1 -1
- package/lib-esm/components/rightPanel/CodemirrorInput/CodemirrorInput.js +1 -1
- package/lib-esm/components/rightPanel/CodemirrorInput/helpers.d.ts +1 -10
- package/lib-esm/components/rightPanel/CodemirrorInput/helpers.js +1 -1
- package/lib-esm/components/rightPanel/Console/Console.d.ts +2 -2
- package/lib-esm/components/rightPanel/Console/Console.js +1 -1
- package/lib-esm/components/rightPanel/Console/ConsoleLazy.js +1 -1
- package/lib-esm/components/rightPanel/Console/ConsoleWrapper.d.ts +5 -2
- package/lib-esm/components/rightPanel/Console/ConsoleWrapper.js +1 -1
- package/lib-esm/components/rightPanel/Console/Request.d.ts +3 -12
- package/lib-esm/components/rightPanel/Console/Request.js +1 -1
- package/lib-esm/components/rightPanel/Console/types.d.ts +14 -3
- package/lib-esm/components/rightPanel/OAuth2Flow/OAuth2Flow.js +1 -1
- package/lib-esm/components/rightPanel/OpenIDConnect.d.ts +2 -2
- package/lib-esm/components/rightPanel/RequestBody/Body.d.ts +1 -1
- package/lib-esm/components/rightPanel/RequestBody/Body.js +1 -1
- package/lib-esm/components/rightPanel/RequestBody/RequestBody.d.ts +1 -1
- package/lib-esm/components/rightPanel/RequestBody/RequestBody.js +1 -1
- package/lib-esm/components/rightPanel/RequestBody/types.d.ts +1 -0
- package/lib-esm/components/rightPanel/RequestBodyForm.d.ts +6 -3
- package/lib-esm/components/rightPanel/RequestBodyForm.js +1 -1
- package/lib-esm/components/rightPanel/ResponseHeadersList.js +1 -1
- package/lib-esm/components/rightPanel/ServerVariable.d.ts +1 -1
- package/lib-esm/components/rightPanel/ServerVariable.js +1 -1
- package/lib-esm/components/rightPanel/ServersDropdown/ServersDropdown.d.ts +2 -1
- package/lib-esm/components/rightPanel/ServersDropdown/ServersDropdown.js +1 -1
- package/lib-esm/components/rightPanel/utils.d.ts +3 -2
- package/lib-esm/components/rightPanel/utils.js +1 -1
- package/lib-esm/constants.d.ts +0 -2
- package/lib-esm/constants.js +1 -1
- package/lib-esm/events/codeSampleCopy.js +1 -1
- package/lib-esm/events/types.d.ts +2 -2
- package/lib-esm/hoc/types.d.ts +38 -0
- package/lib-esm/hoc/types.js +2 -0
- package/lib-esm/hoc/utils.d.ts +2 -0
- package/lib-esm/hoc/utils.js +2 -0
- package/lib-esm/hoc/withRouter.d.ts +3 -0
- package/lib-esm/hoc/withRouter.js +2 -0
- package/lib-esm/hooks/index.d.ts +4 -0
- package/lib-esm/hooks/index.js +1 -1
- package/lib-esm/hooks/useActivateExample.d.ts +2 -0
- package/lib-esm/hooks/useActivateExample.js +2 -0
- package/lib-esm/hooks/useContentItems.d.ts +12 -0
- package/lib-esm/hooks/useContentItems.js +2 -0
- package/lib-esm/hooks/useLicense.d.ts +5 -0
- package/lib-esm/hooks/useLicense.js +2 -0
- package/lib-esm/hooks/useRouter.d.ts +11 -0
- package/lib-esm/hooks/useRouter.js +2 -0
- package/lib-esm/index.d.ts +2 -1
- package/lib-esm/index.js +1 -1
- package/lib-esm/models/callback.d.ts +5 -0
- package/lib-esm/models/callback.js +2 -0
- package/lib-esm/models/example.d.ts +10 -0
- package/lib-esm/models/example.js +2 -0
- package/lib-esm/models/field.d.ts +7 -0
- package/lib-esm/models/field.js +2 -0
- package/lib-esm/models/group.d.ts +4 -0
- package/lib-esm/models/group.js +2 -0
- package/lib-esm/models/index.d.ts +13 -14
- package/lib-esm/models/index.js +1 -1
- package/lib-esm/models/mediaContent.d.ts +7 -0
- package/lib-esm/models/mediaContent.js +2 -0
- package/lib-esm/models/mediaType.d.ts +20 -0
- package/lib-esm/models/mediaType.js +2 -0
- package/lib-esm/models/operation.d.ts +18 -0
- package/lib-esm/models/operation.js +2 -0
- package/lib-esm/models/request.d.ts +12 -0
- package/lib-esm/models/request.js +2 -0
- package/lib-esm/models/response.d.ts +15 -0
- package/lib-esm/models/response.js +2 -0
- package/lib-esm/models/schema.d.ts +14 -0
- package/lib-esm/models/schema.js +2 -0
- package/lib-esm/models/security.d.ts +13 -0
- package/lib-esm/models/security.js +2 -0
- package/lib-esm/models/types.d.ts +233 -3
- package/lib-esm/recoil/app.d.ts +32 -0
- package/lib-esm/recoil/app.js +2 -0
- package/lib-esm/recoil/operation.d.ts +11 -0
- package/lib-esm/recoil/operation.js +2 -0
- package/lib-esm/recoil/store.d.ts +19 -0
- package/lib-esm/recoil/store.js +2 -0
- package/lib-esm/services/OpenAPIParser.d.ts +1 -1
- package/lib-esm/services/OpenAPIParser.js +1 -1
- package/lib-esm/services/Options/index.d.ts +1 -1
- package/lib-esm/services/Options/index.js +1 -1
- package/lib-esm/services/Options/{NormalizedOptions.d.ts → normalizeOptions.d.ts} +1 -1
- package/lib-esm/services/Options/normalizeOptions.js +2 -0
- package/lib-esm/services/Options/types.d.ts +31 -15
- package/lib-esm/services/code-samples/generator.js +1 -1
- package/lib-esm/services/code-samples/httpsnippet/targets/index.d.ts +1 -1
- package/lib-esm/services/code-samples/httpsnippet/targets/javascript/index.d.ts +1 -1
- package/lib-esm/services/code-samples/httpsnippet/targets/shell/curl.d.ts +2 -2
- package/lib-esm/services/code-samples/types.d.ts +2 -2
- package/lib-esm/services/history/helpers.d.ts +1 -1
- package/lib-esm/services/history/helpers.js +1 -1
- package/lib-esm/services/history/index.d.ts +1 -4
- package/lib-esm/services/history/index.js +1 -1
- package/lib-esm/services/index.d.ts +2 -7
- package/lib-esm/services/index.js +1 -1
- package/lib-esm/services/menu/builder.d.ts +9 -0
- package/lib-esm/services/menu/builder.js +2 -0
- package/lib-esm/services/menu/helpers.d.ts +6 -0
- package/lib-esm/services/menu/helpers.js +2 -0
- package/lib-esm/services/menu/index.d.ts +1 -0
- package/lib-esm/services/menu/index.js +2 -0
- package/lib-esm/services/menu/markdown.d.ts +11 -0
- package/lib-esm/services/menu/markdown.js +2 -0
- package/lib-esm/services/menu/operation.d.ts +13 -0
- package/lib-esm/services/menu/operation.js +2 -0
- package/lib-esm/services/menu/tags.d.ts +27 -0
- package/lib-esm/services/menu/tags.js +2 -0
- package/lib-esm/services/search/DeepSearchStore.d.ts +3 -3
- package/lib-esm/services/search/DeepSearchStore.js +1 -1
- package/lib-esm/services/search/SearchStore.d.ts +1 -1
- package/lib-esm/services/search/useSearch.d.ts +13 -0
- package/lib-esm/services/search/useSearch.js +2 -0
- package/lib-esm/services/types.d.ts +42 -91
- package/lib-esm/services/types.js +1 -1
- package/lib-esm/services/utils.d.ts +1 -0
- package/lib-esm/services/utils.js +1 -1
- package/lib-esm/standalone.d.ts +5 -5
- package/lib-esm/standalone.js +1 -1
- package/lib-esm/testProviders.d.ts +2 -2
- package/lib-esm/testProviders.js +1 -1
- package/lib-esm/types/app.d.ts +1 -0
- package/lib-esm/types/app.js +2 -0
- package/lib-esm/types/index.d.ts +1 -0
- package/lib-esm/types/index.js +1 -1
- package/lib-esm/types/open-api.d.ts +15 -15
- package/lib-esm/utils/compose.d.ts +1 -0
- package/lib-esm/utils/compose.js +2 -0
- package/lib-esm/utils/helpers.d.ts +2 -1
- package/lib-esm/utils/helpers.js +1 -1
- package/lib-esm/utils/index.d.ts +3 -2
- package/lib-esm/utils/index.js +1 -1
- package/lib-esm/utils/local-storage.js +1 -1
- package/lib-esm/utils/openapi.d.ts +11 -7
- package/lib-esm/utils/openapi.js +1 -1
- package/lib-esm/utils/saveTextBeforeHeading.d.ts +1 -0
- package/lib-esm/utils/saveTextBeforeHeading.js +2 -0
- package/lib-esm/utils/typeGuards.d.ts +3 -0
- package/lib-esm/utils/typeGuards.js +2 -0
- package/package.json +11 -15
- package/bin/cli/assets/redoc-fast-scroll.js +0 -22
- package/bin/cli/assets/template.hbs +0 -24
- package/bin/cli/commands/redocly-docs-cli.min.js +0 -6187
- package/bin/cli/commands/redocly-docs-cli.min.js.LICENSE.txt +0 -358
- package/dist/console.redocly-reference-docs.min.js +0 -507
- package/dist/redocly-reference-docs.min.js +0 -6289
- package/lib/cli/assets/redoc-fast-scroll.d.ts +0 -0
- package/lib/cli/assets/redoc-fast-scroll.js +0 -2
- package/lib/cli/cli.d.ts +0 -2
- package/lib/cli/cli.js +0 -3
- package/lib/cli/commands/bundle.d.ts +0 -1
- package/lib/cli/commands/bundle.js +0 -2
- package/lib/cli/commands/index.d.ts +0 -1
- package/lib/cli/commands/index.js +0 -2
- package/lib/cli/constants.d.ts +0 -3
- package/lib/cli/constants.js +0 -2
- package/lib/cli/utils.d.ts +0 -16
- package/lib/cli/utils.js +0 -2
- package/lib/components/Markdown/AdvancedMarkdown.d.ts +0 -2
- package/lib/components/Markdown/AdvancedMarkdown.js +0 -2
- package/lib/components/Markdown/SanitizedMarkdownHTML.d.ts +0 -6
- package/lib/components/Markdown/SanitizedMarkdownHTML.js +0 -2
- package/lib/components/NextSectionButton.d.ts +0 -13
- package/lib/components/NextSectionButton.js +0 -8
- package/lib/components/Operation/Operation.d.ts +0 -4
- package/lib/components/Operation/Operation.js +0 -8
- package/lib/components/Operation/index.d.ts +0 -2
- package/lib/components/Operation/index.js +0 -2
- package/lib/components/Operation/types.d.ts +0 -6
- package/lib/components/ProProviders.d.ts +0 -9
- package/lib/components/ProProviders.js +0 -2
- package/lib/components/RedoclyReferenceDocs.d.ts +0 -26
- package/lib/components/RedoclyReferenceDocs.js +0 -54
- package/lib/components/RedoclyReferenceDocsMultiStandalone.d.ts +0 -7
- package/lib/components/RedoclyReferenceDocsMultiStandalone.js +0 -2
- package/lib/components/Search/MenuItemProSearch.d.ts +0 -2
- package/lib/components/Search/MenuItemProSearch.js +0 -2
- package/lib/components/SecuritySchemes/SecuritySchemes.d.ts +0 -3
- package/lib/components/SecuritySchemes/SecuritySchemes.js +0 -2
- package/lib/components/SideMenu/MenuItemLinkOrLabel.d.ts +0 -7
- package/lib/components/SideMenu/MenuItemLinkOrLabel.js +0 -2
- package/lib/components/StoreProvider.d.ts +0 -22
- package/lib/components/StoreProvider.js +0 -2
- package/lib/components/styled.elements.d.ts +0 -19
- package/lib/components/styled.elements.js +0 -166
- package/lib/components/types.d.ts +0 -8
- package/lib/context/OptionsProvider.d.ts +0 -6
- package/lib/context/OptionsProvider.js +0 -2
- package/lib/context/StoreProvider.d.ts +0 -6
- package/lib/context/StoreProvider.js +0 -2
- package/lib/context/index.d.ts +0 -2
- package/lib/context/index.js +0 -2
- package/lib/models/ApiInfo.d.ts +0 -17
- package/lib/models/ApiInfo.js +0 -2
- package/lib/models/Callback.d.ts +0 -11
- package/lib/models/Callback.js +0 -2
- package/lib/models/Example.d.ts +0 -17
- package/lib/models/Example.js +0 -2
- package/lib/models/Field.d.ts +0 -34
- package/lib/models/Field.js +0 -2
- package/lib/models/Group.d.ts +0 -26
- package/lib/models/Group.js +0 -2
- package/lib/models/MediaContent.d.ts +0 -31
- package/lib/models/MediaContent.js +0 -2
- package/lib/models/MediaType.d.ts +0 -27
- package/lib/models/MediaType.js +0 -2
- package/lib/models/Operation.d.ts +0 -92
- package/lib/models/Operation.js +0 -2
- package/lib/models/RequestBody.d.ts +0 -18
- package/lib/models/RequestBody.js +0 -2
- package/lib/models/Response.d.ts +0 -28
- package/lib/models/Response.js +0 -2
- package/lib/models/Schema.d.ts +0 -78
- package/lib/models/Schema.js +0 -2
- package/lib/models/SecurityRequirement.d.ts +0 -12
- package/lib/models/SecurityRequirement.js +0 -2
- package/lib/models/SecuritySchemes.d.ts +0 -25
- package/lib/models/SecuritySchemes.js +0 -2
- package/lib/models/Webhook.d.ts +0 -8
- package/lib/models/Webhook.js +0 -2
- package/lib/services/MarkdownRenderer.d.ts +0 -23
- package/lib/services/MarkdownRenderer.js +0 -2
- package/lib/services/MenuBuilder.d.ts +0 -63
- package/lib/services/MenuBuilder.js +0 -2
- package/lib/services/Options/NormalizedOptions.js +0 -2
- package/lib/services/ProMenu.d.ts +0 -108
- package/lib/services/ProMenu.js +0 -2
- package/lib/services/ProStore.d.ts +0 -92
- package/lib/services/ProStore.js +0 -2
- package/lib/services/ScrollService.d.ts +0 -18
- package/lib/services/ScrollService.js +0 -2
- package/lib/services/SpecStore.d.ts +0 -18
- package/lib/services/SpecStore.js +0 -2
- package/lib/services/VersionedSpecStore.d.ts +0 -42
- package/lib/services/VersionedSpecStore.js +0 -2
- package/lib/services/history/FakeHistoryService.d.ts +0 -20
- package/lib/services/history/FakeHistoryService.js +0 -2
- package/lib/services/history/HistoryService.d.ts +0 -15
- package/lib/services/history/HistoryService.js +0 -2
- package/lib/services/history/ProHashHistoryService.d.ts +0 -25
- package/lib/services/history/ProHashHistoryService.js +0 -2
- package/lib/services/history/PushStateHistoryService.d.ts +0 -24
- package/lib/services/history/PushStateHistoryService.js +0 -2
- package/lib/utils/memoize.d.ts +0 -1
- package/lib/utils/memoize.js +0 -2
- package/lib/utils/store.d.ts +0 -3
- package/lib/utils/store.js +0 -2
- package/lib-esm/cli/assets/redoc-fast-scroll.d.ts +0 -0
- package/lib-esm/cli/assets/redoc-fast-scroll.js +0 -2
- package/lib-esm/cli/cli.d.ts +0 -2
- package/lib-esm/cli/cli.js +0 -3
- package/lib-esm/cli/commands/bundle.d.ts +0 -1
- package/lib-esm/cli/commands/bundle.js +0 -2
- package/lib-esm/cli/commands/index.d.ts +0 -1
- package/lib-esm/cli/commands/index.js +0 -2
- package/lib-esm/cli/constants.d.ts +0 -3
- package/lib-esm/cli/constants.js +0 -2
- package/lib-esm/cli/utils.d.ts +0 -16
- package/lib-esm/cli/utils.js +0 -2
- package/lib-esm/components/Markdown/AdvancedMarkdown.d.ts +0 -2
- package/lib-esm/components/Markdown/AdvancedMarkdown.js +0 -2
- package/lib-esm/components/Markdown/SanitizedMarkdownHTML.d.ts +0 -6
- package/lib-esm/components/Markdown/SanitizedMarkdownHTML.js +0 -2
- package/lib-esm/components/NextSectionButton.d.ts +0 -13
- package/lib-esm/components/NextSectionButton.js +0 -8
- package/lib-esm/components/Operation/Operation.d.ts +0 -4
- package/lib-esm/components/Operation/Operation.js +0 -8
- package/lib-esm/components/Operation/index.d.ts +0 -2
- package/lib-esm/components/Operation/index.js +0 -2
- package/lib-esm/components/Operation/types.d.ts +0 -6
- package/lib-esm/components/ProProviders.d.ts +0 -9
- package/lib-esm/components/ProProviders.js +0 -2
- package/lib-esm/components/RedoclyReferenceDocs.d.ts +0 -26
- package/lib-esm/components/RedoclyReferenceDocs.js +0 -54
- package/lib-esm/components/RedoclyReferenceDocsMultiStandalone.d.ts +0 -7
- package/lib-esm/components/RedoclyReferenceDocsMultiStandalone.js +0 -2
- package/lib-esm/components/Search/MenuItemProSearch.d.ts +0 -2
- package/lib-esm/components/Search/MenuItemProSearch.js +0 -2
- package/lib-esm/components/SecuritySchemes/SecuritySchemes.d.ts +0 -3
- package/lib-esm/components/SecuritySchemes/SecuritySchemes.js +0 -2
- package/lib-esm/components/SideMenu/MenuItemLinkOrLabel.d.ts +0 -7
- package/lib-esm/components/SideMenu/MenuItemLinkOrLabel.js +0 -2
- package/lib-esm/components/StoreProvider.d.ts +0 -22
- package/lib-esm/components/StoreProvider.js +0 -2
- package/lib-esm/components/styled.elements.d.ts +0 -19
- package/lib-esm/components/styled.elements.js +0 -166
- package/lib-esm/components/types.d.ts +0 -8
- package/lib-esm/context/OptionsProvider.d.ts +0 -6
- package/lib-esm/context/OptionsProvider.js +0 -2
- package/lib-esm/context/StoreProvider.d.ts +0 -6
- package/lib-esm/context/StoreProvider.js +0 -2
- package/lib-esm/context/index.d.ts +0 -2
- package/lib-esm/context/index.js +0 -2
- package/lib-esm/models/ApiInfo.d.ts +0 -17
- package/lib-esm/models/ApiInfo.js +0 -2
- package/lib-esm/models/Callback.d.ts +0 -11
- package/lib-esm/models/Callback.js +0 -2
- package/lib-esm/models/Example.d.ts +0 -17
- package/lib-esm/models/Example.js +0 -2
- package/lib-esm/models/Field.d.ts +0 -34
- package/lib-esm/models/Field.js +0 -2
- package/lib-esm/models/Group.d.ts +0 -26
- package/lib-esm/models/Group.js +0 -2
- package/lib-esm/models/MediaContent.d.ts +0 -31
- package/lib-esm/models/MediaContent.js +0 -2
- package/lib-esm/models/MediaType.d.ts +0 -27
- package/lib-esm/models/MediaType.js +0 -2
- package/lib-esm/models/Operation.d.ts +0 -92
- package/lib-esm/models/Operation.js +0 -2
- package/lib-esm/models/RequestBody.d.ts +0 -18
- package/lib-esm/models/RequestBody.js +0 -2
- package/lib-esm/models/Response.d.ts +0 -28
- package/lib-esm/models/Response.js +0 -2
- package/lib-esm/models/Schema.d.ts +0 -78
- package/lib-esm/models/Schema.js +0 -2
- package/lib-esm/models/SecurityRequirement.d.ts +0 -12
- package/lib-esm/models/SecurityRequirement.js +0 -2
- package/lib-esm/models/SecuritySchemes.d.ts +0 -25
- package/lib-esm/models/SecuritySchemes.js +0 -2
- package/lib-esm/models/Webhook.d.ts +0 -8
- package/lib-esm/models/Webhook.js +0 -2
- package/lib-esm/services/MarkdownRenderer.d.ts +0 -23
- package/lib-esm/services/MarkdownRenderer.js +0 -2
- package/lib-esm/services/MenuBuilder.d.ts +0 -63
- package/lib-esm/services/MenuBuilder.js +0 -2
- package/lib-esm/services/Options/NormalizedOptions.js +0 -2
- package/lib-esm/services/ProMenu.d.ts +0 -108
- package/lib-esm/services/ProMenu.js +0 -2
- package/lib-esm/services/ProStore.d.ts +0 -92
- package/lib-esm/services/ProStore.js +0 -2
- package/lib-esm/services/ScrollService.d.ts +0 -18
- package/lib-esm/services/ScrollService.js +0 -2
- package/lib-esm/services/SpecStore.d.ts +0 -18
- package/lib-esm/services/SpecStore.js +0 -2
- package/lib-esm/services/VersionedSpecStore.d.ts +0 -42
- package/lib-esm/services/VersionedSpecStore.js +0 -2
- package/lib-esm/services/history/FakeHistoryService.d.ts +0 -20
- package/lib-esm/services/history/FakeHistoryService.js +0 -2
- package/lib-esm/services/history/HistoryService.d.ts +0 -15
- package/lib-esm/services/history/HistoryService.js +0 -2
- package/lib-esm/services/history/ProHashHistoryService.d.ts +0 -25
- package/lib-esm/services/history/ProHashHistoryService.js +0 -2
- package/lib-esm/services/history/PushStateHistoryService.d.ts +0 -24
- package/lib-esm/services/history/PushStateHistoryService.js +0 -2
- package/lib-esm/utils/memoize.d.ts +0 -1
- package/lib-esm/utils/memoize.js +0 -2
- package/lib-esm/utils/store.d.ts +0 -3
- package/lib-esm/utils/store.js +0 -2
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
var __rest=this&&this.__rest||function(e,t){var r={};for(var o in e)Object.prototype.hasOwnProperty.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var a=0;for(o=Object.getOwnPropertySymbols(e);a<o.length;a++)t.indexOf(o[a])<0&&Object.prototype.propertyIsEnumerable.call(e,o[a])&&(r[o[a]]=e[o[a]])}return r};import React from"react";import{useRouter}from"../hooks";import{getDisplayName}from"./utils";import{IS_BROWSER}from"../utils";export function withRouter(e){const t=t=>{var r,o,{enableRouter:a=!0}=t,n=__rest(t,["enableRouter"]);const s=null!==(r=n.basePath)&&void 0!==r?r:"/",i=null!==(o=n.router)&&void 0!==o?o:"history",{Router:l,routerProps:u}=useRouter(i,s);return IS_BROWSER&&a?React.createElement(l,Object.assign({},u,{key:s}),React.createElement(e,Object.assign({},n))):React.createElement(e,Object.assign({},n))};return t.displayName=`WithRouter(${getDisplayName(e)})`,t}
|
|
2
|
+
//# sourceMappingURL=withRouter.js.map
|
package/lib-esm/hooks/index.d.ts
CHANGED
|
@@ -1,2 +1,6 @@
|
|
|
1
1
|
export { useDimensions } from './useDimensions';
|
|
2
2
|
export { usePrevious } from './usePrevious';
|
|
3
|
+
export { useLicense } from './useLicense';
|
|
4
|
+
export { useActivateExample } from './useActivateExample';
|
|
5
|
+
export { useRouter } from './useRouter';
|
|
6
|
+
export { useContentItems } from './useContentItems';
|
package/lib-esm/hooks/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export{useDimensions}from"./useDimensions";export{usePrevious}from"./usePrevious";
|
|
1
|
+
export{useDimensions}from"./useDimensions";export{usePrevious}from"./usePrevious";export{useLicense}from"./useLicense";export{useActivateExample}from"./useActivateExample";export{useRouter}from"./useRouter";export{useContentItems}from"./useContentItems";
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import{useCallback}from"react";import{useSetRecoilState}from"recoil";import{getActiveMediaType}from"../models";import{operationStore}from"../recoil/operation";export function useActivateExample(e){const i=useSetRecoilState(operationStore((null==e?void 0:e.operation.pointer)||"no_operation_pointer")),o=e?getActiveMediaType(e):void 0;return useCallback((e=>{var t,a,l;if(o)if(o.examples&&(null===(t=o.schema)||void 0===t?void 0:t.oneOf)&&Object.keys(o.examples).includes(e)){const t=null===(l=null===(a=o.schema)||void 0===a?void 0:a.oneOf)||void 0===l?void 0:l.findIndex((i=>i.title===e));i((e=>{var i,a,l;return Object.assign(Object.assign({},e),{activeOneOf:t,activeExampleName:(null===(l=null===(a=null===(i=o.schema)||void 0===i?void 0:i.oneOf)||void 0===a?void 0:a[t])||void 0===l?void 0:l.title)||e.activeExampleName})}))}else i((i=>Object.assign(Object.assign({},i),{activeExampleName:e})))}),[o,i])}
|
|
2
|
+
//# sourceMappingURL=useActivateExample.js.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { ContentItemModel } from '../models';
|
|
2
|
+
import type { ExtendedMenuItem, IMenuItem, OpenAPIParser, Options } from '../services';
|
|
3
|
+
type UseContentItemsInput = {
|
|
4
|
+
parser: OpenAPIParser;
|
|
5
|
+
options: Options;
|
|
6
|
+
};
|
|
7
|
+
type UseContentItemsReturnType = {
|
|
8
|
+
contentItems: ContentItemModel[];
|
|
9
|
+
flatItems: (ExtendedMenuItem & IMenuItem)[];
|
|
10
|
+
};
|
|
11
|
+
export declare const useContentItems: ({ options, parser, }: UseContentItemsInput) => UseContentItemsReturnType;
|
|
12
|
+
export {};
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import{useMemo}from"react";import{buildContentItems}from"../services";export const useContentItems=({options:t,parser:e})=>{const{contentItems:o,flatItems:s}=useMemo((()=>buildContentItems(e,t)),[t,e]);return{flatItems:s,contentItems:o}};
|
|
2
|
+
//# sourceMappingURL=useContentItems.js.map
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
var __awaiter=this&&this.__awaiter||function(e,n,t,i){return new(t||(t=Promise))((function(o,c){function a(e){try{s(i.next(e))}catch(e){c(e)}}function r(e){try{s(i.throw(e))}catch(e){c(e)}}function s(e){var n;e.done?o(e.value):(n=e.value,n instanceof t?n:new t((function(e){e(n)}))).then(a,r)}s((i=i.apply(e,n||[])).next())}))};import{useState,useEffect}from"react";import parseToken from"../services/check";export function useLicense(e){const[n,t]=useState("development"===process.env.NODE_ENV?{valid:!0,allowed:!0}:{});return useEffect((()=>{!function(){__awaiter(this,void 0,void 0,(function*(){const n=yield parseToken(e);t(n)}))}()}),[e]),{licenseInfo:n,isValid:isValidLicense(n)}}function isValidLicense(e){return e.valid&&e.allowed&&!e.expired||!!e.local}
|
|
2
|
+
//# sourceMappingURL=useLicense.js.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as React from 'react';
|
|
2
|
+
import type { RouterType } from '../types';
|
|
3
|
+
interface RouterProps {
|
|
4
|
+
basename?: string;
|
|
5
|
+
location?: string;
|
|
6
|
+
}
|
|
7
|
+
export declare const useRouter: (router: RouterType, basePath: string) => {
|
|
8
|
+
Router: React.ComponentType<{}>;
|
|
9
|
+
routerProps: RouterProps;
|
|
10
|
+
};
|
|
11
|
+
export {};
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import{BrowserRouter,HashRouter,MemoryRouter}from"react-router-dom";const RouterComponent={history:BrowserRouter,memory:MemoryRouter,hash:HashRouter};export const useRouter=(o,r)=>({Router:RouterComponent[o],routerProps:Object.assign({},"memory"!==o&&{basename:r})});
|
|
2
|
+
//# sourceMappingURL=useRouter.js.map
|
package/lib-esm/index.d.ts
CHANGED
|
@@ -5,6 +5,7 @@ export * from './events/index';
|
|
|
5
5
|
export * from './constants';
|
|
6
6
|
export { setSecurityDetails, setSecurityDetailsVariants, setParameterValue, isOperationName, JsonPointer, } from './utils';
|
|
7
7
|
export type { SecurityDetails, OpenAPIDefinition, OpenAPIOperation, OpenAPIParameterLocation, OpenAPISchema, } from './types';
|
|
8
|
-
export
|
|
8
|
+
export { OpenAPIParser } from './services';
|
|
9
|
+
export { buildContentItems, normalizeOptions } from './services';
|
|
9
10
|
export type { OAuth2 } from './services/OAuth2';
|
|
10
11
|
export type { OpenApiResponseData } from './components/rightPanel/types';
|
package/lib-esm/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export*from"./components/index";export*from"./services/index";export*from"./models/index";export*from"./events/index";export*from"./constants";export{setSecurityDetails,setSecurityDetailsVariants,setParameterValue,isOperationName,JsonPointer}from"./utils";
|
|
1
|
+
export*from"./components/index";export*from"./services/index";export*from"./models/index";export*from"./events/index";export*from"./constants";export{setSecurityDetails,setSecurityDetailsVariants,setParameterValue,isOperationName,JsonPointer}from"./utils";export{OpenAPIParser}from"./services";export{buildContentItems,normalizeOptions}from"./services";
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { Options } from 'src/services/Options';
|
|
2
|
+
import type { OpenAPIParser } from 'src/services/OpenAPIParser';
|
|
3
|
+
import type { OpenAPICallback, Referenced } from '../types';
|
|
4
|
+
import type { CallbackModel, GroupModel } from './types';
|
|
5
|
+
export declare function getCallback(parser: OpenAPIParser, name: string, infoOrRef: Referenced<OpenAPICallback>, parentPointer: string, options: Options, href: string, parent?: GroupModel): CallbackModel;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import{isOperationName,JsonPointer}from"../utils";import{getOperation}from"./operation";import{joinWithSeparator}from"../services";export function getCallback(e,t,r,o,a,s,i){const{resolved:n}=e.deref(r),p=[];for(const r of Object.keys(n)){const c=n[r],m=Object.keys(c).filter(isOperationName);for(const n of m){const m=c[n],f=getOperation(e,Object.assign(Object.assign({},m),{pathName:r,pointer:JsonPointer.join(o,["callbacks",t,n]),httpVerb:n,pathParameters:c.parameters||[],pathServers:c.servers}),i,a,s,{isCallback:!0,id:joinWithSeparator(t,n)});p.push(f)}}return{name:t,operations:p}}
|
|
2
|
+
//# sourceMappingURL=callback.js.map
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { OpenAPIExample, Referenced } from '../types';
|
|
2
|
+
import type { OpenAPIParser } from '../services';
|
|
3
|
+
import type { ExampleModel } from './types';
|
|
4
|
+
export declare function getExternalExampleValue(mimeType: string, externalValueUrl?: string): Promise<string | undefined>;
|
|
5
|
+
type GetExamplesInput = Pick<ExampleModel, 'mime' | 'encoding'> & {
|
|
6
|
+
parser: OpenAPIParser;
|
|
7
|
+
infoOrRef: Referenced<OpenAPIExample>;
|
|
8
|
+
};
|
|
9
|
+
export declare function getExamples({ parser, infoOrRef, mime, encoding }: GetExamplesInput): ExampleModel;
|
|
10
|
+
export {};
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import{resolve as urlResolve}from"url";import{isJsonLike}from"../utils";const ExternalExamplesCache={};export function getExternalExampleValue(e,r){return r?(r in ExternalExamplesCache||(ExternalExamplesCache[r]=fetch(r).then((r=>r.text().then((t=>{if(!r.ok)return Promise.reject(new Error(t));if(!isJsonLike(e))return t;try{return JSON.parse(t)}catch(e){return t}}))))),ExternalExamplesCache[r]):Promise.resolve(void 0)}export function getExamples({parser:e,infoOrRef:r,mime:t,encoding:n}){let l;const{resolved:a}=e.deref(r),o=a.value,i=a.value,s=a.summary,u=a.description;return a.externalValue&&(l=urlResolve(e.definitionUrl||"",a.externalValue)),{value:i,rawValue:o,externalValueUrl:l,summary:s,description:u,mime:t,encoding:n}}
|
|
2
|
+
//# sourceMappingURL=example.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { OpenAPIParser, Options } from '../services';
|
|
2
|
+
import type { OpenAPIParameter, Referenced } from '../types';
|
|
3
|
+
import type { FieldModel, Deps } from './types';
|
|
4
|
+
export declare function getField(parser: OpenAPIParser, infoOrRef: Referenced<OpenAPIParameter> & {
|
|
5
|
+
name?: string;
|
|
6
|
+
kind?: string;
|
|
7
|
+
}, pointer: string, options: Options, deps: Deps, refsStack?: string[], absolutePointer?: string): FieldModel;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import{extractExtensions,mapValues}from"../utils";import{getSchema}from"./schema";import{getExamples}from"./example";const DEFAULT_SERIALIZATION={path:{style:"simple",explode:!1},query:{style:"form",explode:!0},header:{style:"simple",explode:!1},cookie:{style:"form",explode:!0}};export function getField(e,o,l,t,i,n,s=l){var d,a,p,r,c,m,x;const{resolved:u}=e.deref(o),v=o.kind||"field",f=o.name||u.name,h=u.in,E=!!u.required;let g,F,y=u.schema,O="";if(!y&&u.in&&u.content){O=Object.keys(u.content)[0];const o=u.content[O];y=o&&(null==o?void 0:o.example)?Object.assign(Object.assign({},e.deref(o.schema,n,!0).resolved),{example:u.example||o.example}):o.schema}const A=(null==i?void 0:i.parentFieldFullPath)?i.parentFieldFullPath+"/"+f:f,I=getSchema({parser:e,schemaOrRef:y||{},pointer:l,options:t,baseRefsStack:n,absolutePointer:o.$ref||(null===(d=u.schema)||void 0===d?void 0:d.absolutePointer)||s,deps:Object.assign(Object.assign({},i),{parentFieldFullPath:A,in:h})}),b=void 0===u.description?I.description||"":u.description,L=u.example||I.example,P=u.examples||(null===(p=null===(a=u.content)||void 0===a?void 0:a[O])||void 0===p?void 0:p.examples),R=P?mapValues(P,((o,l)=>getExamples({parser:e,infoOrRef:o,mime:l,encoding:u.encoding}))):void 0;O?g=O:u.style?F=u.style:h&&(F=null!==(c=null===(r=DEFAULT_SERIALIZATION[h])||void 0===r?void 0:r.style)&&void 0!==c?c:"form");const S=void 0===u.explode&&h?null===(x=null===(m=DEFAULT_SERIALIZATION[h])||void 0===m?void 0:m.explode)||void 0===x||x:!!u.explode;return{deps:i||{},schema:I,name:f,required:E,description:b,example:L,examples:R,deprecated:void 0===u.deprecated?I.deprecated:u.deprecated,in:h,kind:v,extensions:t.showExtensions?extractExtensions(u,t.showExtensions):void 0,explode:S,style:F,const:(null==I?void 0:I.const)||(null==u?void 0:u.const)||"",serializationMime:g,fieldFullPath:A}}
|
|
2
|
+
//# sourceMappingURL=field.js.map
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { OpenAPITag } from '../types';
|
|
2
|
+
import type { MarkdownHeading, MenuItemGroupType, Options } from '../services';
|
|
3
|
+
import type { GroupModel } from './types';
|
|
4
|
+
export declare function getGroup(type: MenuItemGroupType, tagOrGroup: OpenAPITag | MarkdownHeading, { pagination, markdownHeadingsAnchorLevel, }: Pick<Options, 'pagination' | 'markdownHeadingsAnchorLevel'>, parent?: GroupModel): GroupModel;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import{safeSlugify}from"../utils";import{getHref}from"../services/menu/operation";import{saveTextBeforeHeading}from"../utils/saveTextBeforeHeading";export function getGroup(e,t,{pagination:i,markdownHeadingsAnchorLevel:a},r){const n=t.id||e+"/"+safeSlugify(t.name),o=t["x-displayName"]||t.name,s=t.level||1,m=t.isSchema,p=t.ast||void 0;return{id:n,type:e,parent:r,name:o,level:s,depth:0,isSchema:m,description:saveTextBeforeHeading(t.description||"",a),items:t.items,ast:p,externalDocs:t.externalDocs,href:getHref({id:n,parent:r,type:e},i)}}
|
|
2
|
+
//# sourceMappingURL=group.js.map
|
|
@@ -1,17 +1,16 @@
|
|
|
1
1
|
export * from './code-sample-options';
|
|
2
2
|
export * from './file-upload';
|
|
3
|
-
export
|
|
4
|
-
export
|
|
5
|
-
export
|
|
6
|
-
export
|
|
7
|
-
export
|
|
8
|
-
export
|
|
9
|
-
export
|
|
10
|
-
export
|
|
11
|
-
export
|
|
12
|
-
export
|
|
13
|
-
export
|
|
14
|
-
export
|
|
15
|
-
export * from './
|
|
16
|
-
export * from './Webhook';
|
|
3
|
+
export { getGroup } from './group';
|
|
4
|
+
export { getOperation, isPayloadSample } from './operation';
|
|
5
|
+
export type { Sample, XPayloadSample } from './operation';
|
|
6
|
+
export { getRequestBody } from './request';
|
|
7
|
+
export { getExamples, getExternalExampleValue } from './example';
|
|
8
|
+
export { getActiveMediaType, getMediaContent } from './mediaContent';
|
|
9
|
+
export type { MediaContentModel, OperationModel, GroupModel, SchemaModel } from './types';
|
|
10
|
+
export { getMediaType } from './mediaType';
|
|
11
|
+
export { getResponse } from './response';
|
|
12
|
+
export { getSchema } from './schema';
|
|
13
|
+
export { getField } from './field';
|
|
14
|
+
export { getCallback } from './callback';
|
|
15
|
+
export * from './security';
|
|
17
16
|
export * from './types';
|
package/lib-esm/models/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export*from"./code-sample-options";export*from"./file-upload";export
|
|
1
|
+
export*from"./code-sample-options";export*from"./file-upload";export{getGroup}from"./group";export{getOperation,isPayloadSample}from"./operation";export{getRequestBody}from"./request";export{getExamples,getExternalExampleValue}from"./example";export{getActiveMediaType,getMediaContent}from"./mediaContent";export{getMediaType}from"./mediaType";export{getResponse}from"./response";export{getSchema}from"./schema";export{getField}from"./field";export{getCallback}from"./callback";export*from"./security";export*from"./types";
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { MediaContentModel, MediaContentModelInput } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* MediaContent model ready to be sued by React components
|
|
4
|
+
* Contains multiple MediaTypes and keeps track of the currently active one
|
|
5
|
+
*/
|
|
6
|
+
export declare function getMediaContent({ parser, info, isRequestType, options, data: { operation, type, response, absolutePointer }, }: MediaContentModelInput): MediaContentModel;
|
|
7
|
+
export declare function getActiveMediaType(content: MediaContentModel, mime?: string): import("./types").MediaTypeModel;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import{getRecoil}from"recoil-nexus";import{mergeSimilarMediaTypes}from"../utils";import{getMediaType}from"./mediaType";import{activeMimeNameSelector}from"../recoil/app";export function getMediaContent({parser:e,info:t,isRequestType:i,options:o,data:{operation:r,type:a,response:p,absolutePointer:m=""}}){o.unstable_ignoreMimeParameters&&(t=mergeSimilarMediaTypes(t));const s=Object.keys(t).map((s=>getMediaType(e,s,i,t[s],o,{operation:r,type:a,response:p,absolutePointer:m}))),n=s.filter((e=>!!e.examples)).length>0;return{mediaTypes:s,isRequestType:i,hasSample:n,operation:r}}export function getActiveMediaType(e,t){const i=t||getRecoil(activeMimeNameSelector);return i&&e.mediaTypes.find((e=>e.name===i))||e.mediaTypes[0]}
|
|
2
|
+
//# sourceMappingURL=mediaContent.js.map
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { OpenAPIMediaType } from '../types';
|
|
2
|
+
import type { OpenAPIParser } from '../services';
|
|
3
|
+
import type { Options } from 'src/services/Options/types';
|
|
4
|
+
import type { MediaTypeModel, ResponseModel, OperationModel } from './types';
|
|
5
|
+
/**
|
|
6
|
+
* @param parser
|
|
7
|
+
* @param name
|
|
8
|
+
* @param isRequestType needed to know if skip RO/RW fields in objects
|
|
9
|
+
* @param info
|
|
10
|
+
* @param options
|
|
11
|
+
* @param operation
|
|
12
|
+
* @param type
|
|
13
|
+
* @param response
|
|
14
|
+
*/
|
|
15
|
+
export declare function getMediaType(parser: OpenAPIParser, name: string, isRequestType: boolean, info: OpenAPIMediaType, options: Options, { operation, type, response, absolutePointer, }: {
|
|
16
|
+
operation: OperationModel;
|
|
17
|
+
type?: 'request' | 'response';
|
|
18
|
+
response?: ResponseModel;
|
|
19
|
+
absolutePointer?: string;
|
|
20
|
+
}): MediaTypeModel;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import*as Sampler from"openapi-sampler";import{getSchema}from"./schema";import{isFormUrlEncoded,isJsonLike,JsonPointer,mapValues}from"../utils";import{getExamples}from"./example";function generateExamples({parser:e,info:{encoding:a,schema:o},schema:n,mime:i,isRequestType:s,onlyRequiredInSamples:r,generatedPayloadSamplesMaxDepth:m}){const p={skipReadOnly:s,skipWriteOnly:!s,skipNonRequired:s&&r,maxSampleDepth:m};let t={};if(n&&n.oneOf)for(const o of n.oneOf){const s=Sampler.sample(o.rawSchema,p,e.definition);n.discriminatorProp&&"object"==typeof s&&s&&(s[n.discriminatorProp]=o.title),t[o.title]=getExamples({parser:e,infoOrRef:{value:s},mime:i,encoding:a})}else n&&(t={default:getExamples({parser:e,infoOrRef:{value:Sampler.sample(o,p,e.definition)},mime:i,encoding:a})});return t}export function getMediaType(e,a,o,n,i,{operation:s,type:r,response:m,absolutePointer:p=""}){let t;const l=n.schema&&getSchema({parser:e,schemaOrRef:n.schema,pointer:"",absolutePointer:JsonPointer.join(p,["content",a,"schema"]),options:i,deps:{operation:s,type:r,response:m}}),{onlyRequiredInSamples:d,generatedPayloadSamplesMaxDepth:c}=i,{encoding:f,examples:u,example:g}=n;return void 0!==u?t=mapValues(u,(o=>getExamples({parser:e,infoOrRef:o,mime:a,encoding:f}))):void 0!==g?t={default:getExamples({parser:e,infoOrRef:{value:e.deref(g).resolved},mime:a,encoding:f})}:(isJsonLike(a)||isFormUrlEncoded(a))&&(t=generateExamples({parser:e,info:n,schema:l,mime:a,isRequestType:o,onlyRequiredInSamples:d,generatedPayloadSamplesMaxDepth:c})),{examples:t,schema:l,name:a,isRequestType:o,onlyRequiredInSamples:d,operation:s}}
|
|
2
|
+
//# sourceMappingURL=mediaType.js.map
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { ExtendedOpenAPIOperation, Unstable_ExternalCodeSample, OpenAPIParser, Options } from '../services';
|
|
2
|
+
import type { OpenAPIXCodeSample } from '../types';
|
|
3
|
+
import type { MediaContentModel, OperationModel, GroupModel } from './types';
|
|
4
|
+
export interface Sample {
|
|
5
|
+
lang: string;
|
|
6
|
+
label?: string;
|
|
7
|
+
}
|
|
8
|
+
export interface XPayloadSample extends Sample {
|
|
9
|
+
lang: 'payload';
|
|
10
|
+
requestBodyContent: MediaContentModel;
|
|
11
|
+
source: string;
|
|
12
|
+
}
|
|
13
|
+
export interface Callback {
|
|
14
|
+
isCallback: boolean;
|
|
15
|
+
id?: string;
|
|
16
|
+
}
|
|
17
|
+
export declare function isPayloadSample(sample: XPayloadSample | OpenAPIXCodeSample | Unstable_ExternalCodeSample): sample is XPayloadSample;
|
|
18
|
+
export declare function getOperation(parser: OpenAPIParser, operationDefinition: ExtendedOpenAPIOperation, parent: GroupModel | undefined, options: Options, href: string, callback?: Callback): OperationModel;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import{extractExtensions,getOperationId,getOperationName,getStatusCodeType,isStatusCode,JsonPointer,mergeParams,normalizeServers,sortByField,sortByRequired}from"../utils";import{getInitialServerWithVariables}from"../components/rightPanel/utils";import{getCallback}from"./callback";import{getField}from"./field";import{getRequestBody}from"./request";import{getSecurityRequirement}from"./security";import{getCodeSample}from"../services";import{getResponse}from"./response";export function isPayloadSample(e){return"payload"===e.lang&&"requestBodyContent"in e}let isCodeSamplesWarningPrinted=!1;export function getOperation(e,t,r,a,o,i){var s,n,l,p;const d=t.isWebhook,m={operationDefinition:t,parent:r,pointer:JsonPointer.join((null==t?void 0:t.pointer)||"",[(null==t?void 0:t.httpVerb)||""]),description:t.description,externalDocs:t.externalDocs,deprecated:!!t.deprecated,httpVerb:t.httpVerb,operationId:t.operationId,path:t.pathName,isWebhook:d,isCallback:Boolean(null==i?void 0:i.isCallback),isEvent:(null==i?void 0:i.isCallback)||d,name:getOperationName(t),defaultExampleName:t.defaultSampleName,type:"operation",callbackId:null==i?void 0:i.id,href:o,get callbacks(){return Object.keys(t.callbacks||[]).map((i=>{var s;return getCallback(e,i,null===(s=t.callbacks)||void 0===s?void 0:s[i],m.pointer,a,o,r)}))},get responses(){let r=!1;return Object.keys(t.responses||[]).filter((e=>"default"===e||("success"===getStatusCodeType(e)&&(r=!0),isStatusCode(e)))).map((o=>getResponse({parser:e,code:o,defaultAsError:r,infoOrRef:t.responses[o],options:a,isEvent:m.isEvent,operation:m})))},get parameters(){let r=mergeParams(e,t.pathParameters,t.parameters,{pathPointer:t.pointer,operationPointer:m.pointer}).map((({paramOrRef:t,pointer:r})=>getField(e,t,r,a,{operation:m,type:"request"})));return a.sortPropsAlphabetically&&(r=sortByField(r,"name")),a.requiredPropsFirst&&(r=sortByRequired(r)),r}};(null==i?void 0:i.isCallback)?(m.security=(t.security||[]).map((t=>getSecurityRequirement({requirement:t,parser:e}))),m.servers=normalizeServers("",t.servers||t.pathServers||[])):(m.id=getOperationId(t,r),m.security=(t.security||e.definition.security||[]).map((t=>getSecurityRequirement({requirement:t,parser:e}))),m.servers=normalizeServers(e.definitionUrl,mergeInMockServer(t.servers||t.pathServers||e.definition.servers||[],a.mockServer))),a.showExtensions&&(m.extensions=extractExtensions(t,a.showExtensions)),m.activeServer=getInitialServerWithVariables(m.servers),m.requestBody=t.requestBody&&getRequestBody({parser:e,infoOrRef:t.requestBody,options:a,operation:m,isEvent:m.isEvent});const c=null===(n=null===(s=m.requestBody)||void 0===s?void 0:s.content)||void 0===n?void 0:n.mediaTypes,[u]=c||[],[g]=Object.keys((null==u?void 0:u.examples)||[]);m.activeExampleName=!1===t.defaultSampleName?void 0:t.defaultSampleName||g;const v=null===(l=m.requestBody)||void 0===l?void 0:l.content;m.payload=(null==v?void 0:v.hasSample)?{lang:"payload",label:"Payload",source:"",requestBodyContent:v}:void 0,m.definitionSamples=t["x-codeSamples"]||t["x-code-samples"]||[],t["x-code-samples"]&&!isCodeSamplesWarningPrinted&&(isCodeSamplesWarningPrinted=!0,console.warn('"x-code-samples" is deprecated. Use "x-codeSamples" instead')),m.hasSamples=(null==v?void 0:v.hasSample)||m.definitionSamples.length>0;const{payloadSampleIdx:S,hideRequestPayloadSample:y}=a;let f=[];if(!d){const t=a.generateCodeSamples||{},r=new Set(m.definitionSamples.map((({lang:e})=>e.toLowerCase())));f=generateCodeSamples((null===(p=t.languages)||void 0===p?void 0:p.filter((({lang:e})=>!r.has(e.toLowerCase()))))||[],t,e.definition,a.generatedPayloadSamplesMaxDepth)}const h=m.definitionSamples.concat(f),b=Math.min(h.length,S);return m.payload&&!y&&h.splice(b,0,m.payload),m.allCodeSamples=h,m.hideTryItPanel=!0===t["x-hideTryItPanel"],m}function generateCodeSamples(e,{skipOptionalParameters:t,withOAuth2Call:r},a,o){return e.map((({lang:e,label:i,options:s})=>({lang:e,label:i,get:i=>getCodeSample(Object.assign(Object.assign({},i),{lang:e,options:Object.assign(Object.assign({},s),{skipOptionalParameters:t,withOAuth2Call:r,spec:a,generatedPayloadSamplesMaxDepth:o})}))})))}function mergeInMockServer(e,t){if(!t)return e;const r={url:t.url,description:t.description};switch(t.position){case"first":return[r,...e];case"last":return[...e,r];case"replace":return[r];default:return e}}
|
|
2
|
+
//# sourceMappingURL=operation.js.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { OpenAPIRequestBody, Referenced } from '../types';
|
|
2
|
+
import type { OpenAPIParser, Options } from '../services';
|
|
3
|
+
import type { RequestBodyModel, OperationModel } from './types';
|
|
4
|
+
type GetRequestBodyInput = {
|
|
5
|
+
parser: OpenAPIParser;
|
|
6
|
+
infoOrRef: Referenced<OpenAPIRequestBody>;
|
|
7
|
+
options: Options;
|
|
8
|
+
isEvent?: boolean;
|
|
9
|
+
operation: OperationModel;
|
|
10
|
+
};
|
|
11
|
+
export declare function getRequestBody({ parser, infoOrRef, options, isEvent, operation, }: GetRequestBodyInput): RequestBodyModel;
|
|
12
|
+
export {};
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import{getContentWithLegacyExamples,JsonPointer}from"../utils";import{getMediaContent}from"./mediaContent";export function getRequestBody({parser:e,infoOrRef:t,options:o,isEvent:n,operation:i}){const{resolved:r}=e.deref(t),s=r.description||"",p=!!r.required;let a;const d=!n,u=getContentWithLegacyExamples(r);return void 0!==u&&(a=getMediaContent({parser:e,info:u,isRequestType:d,options:o,data:{operation:i,type:"request",absolutePointer:t.$ref||JsonPointer.join(i.pointer,["requestBody"])}})),{description:s,required:p,content:a}}
|
|
2
|
+
//# sourceMappingURL=request.js.map
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { OpenAPIResponse, Referenced } from '../types';
|
|
2
|
+
import type { OpenAPIParser } from '../services';
|
|
3
|
+
import type { Options } from 'src/services/Options';
|
|
4
|
+
import type { ResponseModel, OperationModel } from './types';
|
|
5
|
+
type ResponseProps = {
|
|
6
|
+
parser: OpenAPIParser;
|
|
7
|
+
code: string;
|
|
8
|
+
defaultAsError: boolean;
|
|
9
|
+
infoOrRef: Referenced<OpenAPIResponse>;
|
|
10
|
+
options: Options;
|
|
11
|
+
operation: OperationModel;
|
|
12
|
+
isEvent?: boolean;
|
|
13
|
+
};
|
|
14
|
+
export declare function getResponse({ parser, code, defaultAsError, infoOrRef, options, isEvent, operation, }: ResponseProps): ResponseModel;
|
|
15
|
+
export {};
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import{getStatusCodeType,getContentWithLegacyExamples,JsonPointer}from"../utils";import{getField}from"./field";import{getMediaContent}from"./mediaContent";export function getResponse({parser:e,code:o,defaultAsError:t,infoOrRef:n,options:s,isEvent:r,operation:i}){var p;const a=!!r,d="all"===s.expandResponses||(null===(p=s.expandResponses)||void 0===p?void 0:p[o])||!1,{resolved:m}=e.deref(n),c={code:o,expanded:d};void 0!==m["x-summary"]?(c.summary=m["x-summary"],c.description=m.description||""):(c.summary=m.description||"",c.description=""),c.type=getStatusCodeType(o,t);const l=m.headers,u=n.$ref||JsonPointer.join((null==i?void 0:i.pointer)||"",["responses",o]);void 0!==l&&(c.headers=Object.keys(l).map((o=>{const t=l[o];return getField(e,Object.assign(Object.assign({},t),{name:o}),JsonPointer.join(u,["headers",o]),s,{operation:i,type:"response",response:c})})));const g=getContentWithLegacyExamples(m);return void 0!==g&&(c.content=getMediaContent({parser:e,info:g,isRequestType:a,options:s,data:{operation:i,type:"response",response:c,absolutePointer:u}})),c}
|
|
2
|
+
//# sourceMappingURL=response.js.map
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { OpenAPISchema, Referenced } from '../types';
|
|
2
|
+
import type { OpenAPIParser } from '../services';
|
|
3
|
+
import type { Deps, SchemaModel } from './types';
|
|
4
|
+
import type { Options } from 'src/services/Options';
|
|
5
|
+
export declare function getSchema({ parser, schemaOrRef, pointer, options, isChild, baseRefsStack, deps, absolutePointer, }: {
|
|
6
|
+
parser: OpenAPIParser;
|
|
7
|
+
schemaOrRef: Referenced<OpenAPISchema>;
|
|
8
|
+
pointer: string;
|
|
9
|
+
options: Options;
|
|
10
|
+
isChild?: boolean;
|
|
11
|
+
baseRefsStack?: string[];
|
|
12
|
+
deps: Deps;
|
|
13
|
+
absolutePointer?: string;
|
|
14
|
+
}): SchemaModel;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
var __rest=this&&this.__rest||function(e,t){var i={};for(var n in e)Object.prototype.hasOwnProperty.call(e,n)&&t.indexOf(n)<0&&(i[n]=e[n]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var r=0;for(n=Object.getOwnPropertySymbols(e);r<n.length;r++)t.indexOf(n[r])<0&&Object.prototype.propertyIsEnumerable.call(e,n[r])&&(i[n[r]]=e[n[r]])}return i};import{pushRef}from"../services/OpenAPIParser";import{detectType,extractExtensions,humanizeConstraints,isNamedDefinition,isObject,isPrimitiveType,JsonPointer,pluralizeType,sortByField,sortByRequired}from"../utils";import{l}from"../services";import{getField}from"./field";export function getSchema({parser:e,schemaOrRef:t,pointer:i,options:n,isChild:r=!1,baseRefsStack:s=[],deps:o,absolutePointer:a}){var p,d,c,f,m,y,u,O;const{resolved:h,refsStack:b}=e.deref(t,s,!0),v=t.$ref||i||"",P=pushRef(b,v),g=e.mergeAllOf(h,v,P,t.$ref||a),x=g.type||detectType(g),j={parser:e,options:n,deps:o,schemaOrRef:t,isChild:r,typePrefix:"",pointer:v,absolutePointer:a,refsStack:P,rawSchema:h,type:x,isCircular:!!g["x-circular-ref"],title:g.title||isNamedDefinition(v)&&JsonPointer.baseName(v)||"",description:g.description||"",format:g.format,enum:g.enum||[],example:g.example,deprecated:!!g.deprecated,pattern:g.pattern,externalDocs:g.externalDocs,displayFormat:g.format,isPrimitive:isPrimitiveType(g,x),constraints:humanizeConstraints(g),default:g.default,readOnly:!!g.readOnly,writeOnly:!!g.writeOnly,const:g.const||"",contentEncoding:g.contentEncoding,contentMediaType:g.contentMediaType,minItems:g.minItems,maxItems:g.maxItems,nullable:g.nullable||g["x-nullable"],schema:g,displayType:"",items:void 0,extensions:void 0,oneOfType:"",discriminatorProp:void 0,oneOf:void 0,"x-enumDescriptions":g["x-enumDescriptions"],get fields(){if(hasType(j,"object")||hasType(j,"array")&&(Array.isArray(g.items)||Array.isArray(g.prefixItems)))return buildFields(e,g,v,n,P,o)}};if((g.nullable||g["x-nullable"])&&(Array.isArray(j.type)&&!j.type.some((e=>null===e||"null"===e))?j.type=[...j.type,"null"]:Array.isArray(j.type)||null===j.type&&"null"===j.type||(j.type=[j.type,"null"])),j.displayType=Array.isArray(j.type)?j.type.map((e=>null===e?"null":e)).join(" or "):j.type,j.isCircular)return j;if(g.if&&g.then||g.if&&g.else){const{oneOf:t,oneOfType:i}=initConditionalOperators({schema:g,parser:e,pointer:v,options:n,deps:o,refsStack:P});return j.oneOf=t,j.oneOfType=i,j}if(!r&&void 0!==getDiscriminator(g)){const{oneOf:t,discriminatorProp:i}=initDiscriminator({schema:g,parser:e,deps:o,mergedSchema:g,options:n,pointer:v,refsStack:P});return j.oneOf=t,j.discriminatorProp=i,j}if(r&&Array.isArray(g.oneOf)&&g.oneOf.find((e=>e.$ref===v))&&delete g.oneOf,void 0!==g.oneOf){const{oneOf:t,displayType:i}=initOneOf({schemaOneOf:g.oneOf,parser:e,deps:o,options:n,pointer:v,refsStack:P,schema:g});return j.oneOfType="One of",t&&(j.oneOf=t),j.displayType=i,void 0!==g.anyOf&&console.warn(`oneOf and anyOf are not supported on the same level. Skipping anyOf at ${v}`),j}if(void 0!==g.anyOf){const{oneOf:t,displayType:i}=initOneOf({schemaOneOf:g.anyOf,parser:e,deps:o,options:n,pointer:v,refsStack:P,schema:g});return t&&(j.oneOf=t),j.displayType=i,j.oneOfType="Any of",j}if(hasType(j,"array")&&(g.items&&(j.items=getSchema({parser:e,schemaOrRef:g.items,pointer:v+"/items",options:n,baseRefsStack:P,deps:o,absolutePointer:JsonPointer.join(g.absolutePointer||"",["items"])})),j.displayType=g.prefixItems||Array.isArray(g.items)?"items":pluralizeType((null===(p=j.items)||void 0===p?void 0:p.displayType)||j.displayType),j.displayFormat=(null===(d=j.items)||void 0===d?void 0:d.format)||"",j.typePrefix=(null===(c=j.items)||void 0===c?void 0:c.typePrefix)||""+l("arrayOf"),j.title=j.title||(null===(f=j.items)||void 0===f?void 0:f.title)||"",j.isPrimitive=void 0!==(null===(m=j.items)||void 0===m?void 0:m.isPrimitive)?null===(y=j.items)||void 0===y?void 0:y.isPrimitive:j.isPrimitive,void 0===j.example&&void 0!==(null===(u=j.items)||void 0===u?void 0:u.example)&&(j.example=[j.items.example]),(null===(O=j.items)||void 0===O?void 0:O.isPrimitive)&&(j.enum=j.items.enum,j["x-enumDescriptions"]=j.items["x-enumDescriptions"]),Array.isArray(j.type))){const e=j.type.filter((e=>"array"!==e));e.length&&(j.displayType+=` or ${e.join(" or ")}`)}return j.enum.length&&n.sortEnumValuesAlphabetically&&j.enum.sort(),n.showExtensions&&(j.extensions=extractExtensions(g,n.showExtensions)),j}function initDiscriminator({schema:e,parser:t,pointer:i,options:n,refsStack:r,deps:s,mergedSchema:o}){const a=getDiscriminator(e),l=null==a?void 0:a.propertyName,p=t.findDerived([...o["x-parentRefs"]||[],i]);if(e.oneOf)for(const t of e.oneOf){if(void 0===t.$ref)continue;const e=JsonPointer.baseName(t.$ref);p[t.$ref]=e}const d=(null==a?void 0:a.mapping)||{};let c=(null==a?void 0:a["x-explicitMappingOnly"])||!1;0===Object.keys(d).length&&(c=!1);const f={};for(const e in d){const t=d[e];Array.isArray(f[t])?f[t].push(e):f[t]=[e]}const m=c?Object.assign({},f):Object.assign(Object.assign({},p),f);let y=[];for(const e of Object.keys(m)){const t=m[e];if(Array.isArray(t))for(const i of t)y.push({$ref:e,name:i});else y.push({$ref:e,name:t})}const u=Object.keys(d);0!==u.length&&(y=y.sort(((e,t)=>{const i=u.indexOf(e.name),n=u.indexOf(t.name);return i<0&&n<0?e.name.localeCompare(t.name):i<0?1:n<0?-1:i-n})));return{oneOf:y.map((({$ref:e,name:i},a)=>{const l=getSchema({parser:t,schemaOrRef:{$ref:e},pointer:e,options:n,isChild:!0,baseRefsStack:r.slice(0,-1),deps:Object.assign(Object.assign({},s),{parentFieldFullPath:s.parentFieldFullPath?s.parentFieldFullPath+"/"+a:a.toString()}),absolutePointer:o.absolutePointer});return l.title=i,l})),discriminatorProp:l}}function initOneOf({schemaOneOf:e,parser:t,refsStack:i,pointer:n,schema:r,options:s,deps:o}){const a=e.map(((e,a)=>{const{resolved:l,refsStack:p}=t.deref(e,i,!0),d=t.mergeAllOf(l,n+"/oneOf/"+a,p),c=isNamedDefinition(e.$ref)&&!d.title?JsonPointer.baseName(e.$ref):`${d.title||""}${d.const&&JSON.stringify(d.const)||""}`;return getSchema({parser:t,schemaOrRef:Object.assign(Object.assign({},d),{title:c,allOf:[Object.assign(Object.assign({},r),{oneOf:void 0,anyOf:void 0})],discriminator:l.allOf?void 0:d.discriminator}),pointer:e.$ref||n+"/oneOf/"+a,options:s,baseRefsStack:p,deps:Object.assign(Object.assign({},o),{parentFieldFullPath:o.parentFieldFullPath?o.parentFieldFullPath+"/"+a:a.toString()})})}));let l;if(s.simpleOneOfTypeLabel){l=collectUniqueOneOfTypesDeep(r).join(" or ")}else l=a.map((e=>{let t=e.typePrefix+(e.title?`${e.title} (${e.displayType})`:e.displayType);return t.indexOf(" or ")>-1&&(t=`(${t})`),t})).join(" or ");return{oneOf:a,displayType:l}}function initConditionalOperators({schema:e,parser:t,pointer:i,options:n,refsStack:r,deps:s}){const{if:o,else:a={},then:l={}}=e,p=__rest(e,["if","else","then"]);return{oneOf:[{allOf:[p,l,o],title:o&&o["x-displayName"]||(null==o?void 0:o.title)||"case 1"},{allOf:[p,a],title:a&&a["x-displayName"]||(null==a?void 0:a.title)||"case 2"}].map(((e,o)=>getSchema({parser:t,schemaOrRef:Object.assign({},e),pointer:i+"/oneOf/"+o,options:n,baseRefsStack:r,deps:Object.assign(Object.assign({},s),{parentFieldFullPath:s.parentFieldFullPath?s.parentFieldFullPath+"/"+o:o.toString()})}))),oneOfType:"One of"}}function normalizeField(e,t,i){return e||(console.warn(`Field "${t}" is invalid, skipping.\n Field must be an object but got ${typeof e} at "${i}"`),{})}function buildFields(e,t,i,n,r,s){const o=t.properties||t.prefixItems||t.items||{},a=t.patternProperties||{},l=t.additionalProperties||t.unevaluatedProperties,p=t.prefixItems?t.items:t.additionalItems,d=t.default||{};let c=Object.keys(o).map((a=>{var l;const p=normalizeField(o[a],a,i),c=void 0!==t.required&&t.required.indexOf(a)>-1;return getField(e,{name:t.properties?a:`[${a}]`,required:c,schema:Object.assign(Object.assign({},p),{example:(null===(l=t.example)||void 0===l?void 0:l[a])||p.example,default:void 0===p.default&&d?d[a]:p.default})},i+"/properties/"+a,n,s,r,JsonPointer.join(t.absolutePointer||"",["properties",a]))}));return n.sortPropsAlphabetically&&(c=sortByField(c,"name")),n.requiredPropsFirst&&(c=sortByRequired(c,n.sortPropsAlphabetically?void 0:t.required)),c.push(...Object.keys(a).map((t=>{const o=normalizeField(a[t],t,i);return getField(e,{name:t,required:!1,schema:o,kind:"patternProperties"},`${i}/patternProperties/${t}`,n,s,r)}))),(isObject(l)||!0===l)&&c.push(getField(e,{name:(isObject(l)&&l["x-additionalPropertiesName"]||"property name").concat("*"),required:!1,schema:!0===l?{}:l,kind:"additionalProperties"},i+"/additionalProperties",n,s,r,JsonPointer.join(t.absolutePointer||"",["additionalProperties"]))),c.push(...buildAdditionalItems({parser:e,schema:p,fieldsCount:c.length,$ref:i,options:n,refsStack:r,deps:s})),c}function buildAdditionalItems({parser:e,schema:t=!1,fieldsCount:i,$ref:n,options:r,refsStack:s,deps:o}){return"boolean"==typeof t?t?[getField(e,{name:`[${i}...]`,schema:{},kind:"additionalItems"},`${n}/additionalItems`,r,o,s)]:[]:Array.isArray(t)?[...t.map(((t,a)=>getField(e,{name:`[${i+a}]`,schema:t,kind:"additionalItems"},`${n}/additionalItems/${a}`,r,o,s)))]:isObject(t)?[getField(e,{name:`[${i}...]`,schema:t,kind:"additionalItems"},`${n}/additionalItems`,r,o,s)]:[]}function getDiscriminator(e){return e.discriminator||e["x-discriminator"]}function collectUniqueOneOfTypesDeep(e){const t=new Set;return function e(i){for(const n of i.oneOf||[])n.oneOf?e(n):n.type&&t.add(n.type)}(e),Array.from(t.values())}function hasType(e,t){return e.type===t||Array.isArray(e.type)&&e.type.includes(t)}
|
|
2
|
+
//# sourceMappingURL=schema.js.map
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { OpenAPISecurityRequirement, OpenAPISecurityScheme, Referenced } from '../types';
|
|
2
|
+
import type { OpenAPIParser } from '../services';
|
|
3
|
+
import type { SecurityRequirement, SecurityScheme } from './types';
|
|
4
|
+
type GetSecurityRequirementsInput = {
|
|
5
|
+
requirement: OpenAPISecurityRequirement;
|
|
6
|
+
parser: OpenAPIParser;
|
|
7
|
+
};
|
|
8
|
+
export declare function getSecurityRequirement({ requirement, parser, }: GetSecurityRequirementsInput): SecurityRequirement;
|
|
9
|
+
export declare function getSecurityScheme(parser: Partial<OpenAPIParser>, id: string, scheme: Referenced<OpenAPISecurityScheme>): SecurityScheme;
|
|
10
|
+
export declare function getSecuritySchemes({ parser, }: {
|
|
11
|
+
parser: Partial<OpenAPIParser>;
|
|
12
|
+
}): Array<SecurityScheme>;
|
|
13
|
+
export {};
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
export function getSecurityRequirement({requirement:e,parser:t}){const n=t.definition.components&&t.definition.components.securitySchemes||{};return{schemes:Object.keys(e||{}).map((r=>{const i=t.deref(n[r]).resolved,o=e[r]||[];if(i)return Object.assign(Object.assign({},i),{id:r,sectionId:r,scopes:o});console.warn(`Non existing security scheme referenced: ${r}. Skipping`)})).filter(Boolean)}}export function getSecurityScheme(e,t,n){if(!(null==e?void 0:e.deref))return{};const{resolved:r}=e.deref(n),i=t,o=r.type,c=r.description||"";let s,a,p,d={};switch(r.type){case"apiKey":s={name:r.name,in:r.in};break;case"http":a={scheme:r.scheme,bearerFormat:r.bearerFormat};break;case"openIdConnect":p={connectUrl:r.openIdConnectUrl};break;case"oauth2":d=r.flows}return{id:t,sectionId:i,type:o,description:c,apiKey:s,http:a,flows:d,openId:p}}export function getSecuritySchemes({parser:e}){var t,n;if(!e)return[];const r=(null===(n=null===(t=e.definition)||void 0===t?void 0:t.components)||void 0===n?void 0:n.securitySchemes)||{};return Object.keys(r).map((t=>getSecurityScheme(e,t,r[t])))}
|
|
2
|
+
//# sourceMappingURL=security.js.map
|
|
@@ -1,3 +1,233 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type {
|
|
3
|
-
|
|
1
|
+
import type { Node } from '@markdoc/markdoc';
|
|
2
|
+
import type { OpenAPISecurityScheme, OpenAPIEncoding, OpenAPIMediaType, OpenAPIParameterLocation, OpenAPIParameterStyle, OpenAPIExternalDocumentation, Server, OpenAPIServer, OpenAPIXCodeSample, OpenAPISchema, Referenced } from '../types';
|
|
3
|
+
import type { OpenAPIParser } from '../services/OpenAPIParser';
|
|
4
|
+
import type { Options } from '../services/Options';
|
|
5
|
+
import type { ExtendedOpenAPIOperation, MenuItemGroupType, MenuItemType, MergedOpenAPISchema, Unstable_ExternalCodeSample } from '../services/types';
|
|
6
|
+
export type ContentItemModel = GroupModel | OperationMenuItem;
|
|
7
|
+
export interface ExtendedOpenAPISecurityScheme extends OpenAPISecurityScheme {
|
|
8
|
+
id: string;
|
|
9
|
+
sectionId: string;
|
|
10
|
+
scopes: string[];
|
|
11
|
+
'x-defaultClientId'?: string;
|
|
12
|
+
}
|
|
13
|
+
export interface SecurityRequirement {
|
|
14
|
+
schemes: ExtendedOpenAPISecurityScheme[];
|
|
15
|
+
}
|
|
16
|
+
export interface SecurityScheme {
|
|
17
|
+
id: string;
|
|
18
|
+
sectionId: string;
|
|
19
|
+
type: OpenAPISecurityScheme['type'];
|
|
20
|
+
description: string | GenericObject;
|
|
21
|
+
apiKey?: {
|
|
22
|
+
name: string;
|
|
23
|
+
in: OpenAPISecurityScheme['in'];
|
|
24
|
+
};
|
|
25
|
+
http?: {
|
|
26
|
+
scheme: string;
|
|
27
|
+
bearerFormat?: string;
|
|
28
|
+
};
|
|
29
|
+
openId?: {
|
|
30
|
+
connectUrl: string;
|
|
31
|
+
};
|
|
32
|
+
flows: OpenAPISecurityScheme['flows'];
|
|
33
|
+
}
|
|
34
|
+
export type RequestBodyModel = {
|
|
35
|
+
description: string | GenericObject;
|
|
36
|
+
required: boolean;
|
|
37
|
+
content: MediaContentModel | undefined;
|
|
38
|
+
};
|
|
39
|
+
export type ExampleModel = {
|
|
40
|
+
value: any;
|
|
41
|
+
rawValue: any;
|
|
42
|
+
externalValueUrl?: string;
|
|
43
|
+
summary?: string;
|
|
44
|
+
description?: string | GenericObject;
|
|
45
|
+
mime: string;
|
|
46
|
+
encoding?: {
|
|
47
|
+
[field: string]: OpenAPIEncoding;
|
|
48
|
+
};
|
|
49
|
+
};
|
|
50
|
+
export type MediaTypeModel = {
|
|
51
|
+
examples?: {
|
|
52
|
+
[name: string]: ExampleModel;
|
|
53
|
+
};
|
|
54
|
+
schema?: SchemaModel;
|
|
55
|
+
name: string;
|
|
56
|
+
isRequestType: boolean;
|
|
57
|
+
onlyRequiredInSamples: boolean;
|
|
58
|
+
operation: OperationModel;
|
|
59
|
+
};
|
|
60
|
+
export type MediaContentModel = {
|
|
61
|
+
mediaTypes: MediaTypeModel[];
|
|
62
|
+
isRequestType: boolean;
|
|
63
|
+
hasSample: boolean;
|
|
64
|
+
operation: OperationModel;
|
|
65
|
+
};
|
|
66
|
+
export type MediaContentModelInput = {
|
|
67
|
+
parser: OpenAPIParser;
|
|
68
|
+
info: Record<string, OpenAPIMediaType>;
|
|
69
|
+
isRequestType: boolean;
|
|
70
|
+
options: Options;
|
|
71
|
+
data: {
|
|
72
|
+
operation: OperationModel;
|
|
73
|
+
type?: 'request' | 'response';
|
|
74
|
+
response?: ResponseModel;
|
|
75
|
+
absolutePointer?: string;
|
|
76
|
+
};
|
|
77
|
+
};
|
|
78
|
+
export type ResponseModel = {
|
|
79
|
+
expanded: boolean;
|
|
80
|
+
content?: MediaContentModel;
|
|
81
|
+
code: string;
|
|
82
|
+
summary: string | GenericObject;
|
|
83
|
+
description: string | GenericObject;
|
|
84
|
+
type: string;
|
|
85
|
+
headers: FieldModel[];
|
|
86
|
+
};
|
|
87
|
+
export type FieldModel = {
|
|
88
|
+
schema: SchemaModel;
|
|
89
|
+
name: string;
|
|
90
|
+
required: boolean;
|
|
91
|
+
description: string | GenericObject;
|
|
92
|
+
example?: string;
|
|
93
|
+
examples?: Record<string, ExampleModel>;
|
|
94
|
+
deprecated: boolean;
|
|
95
|
+
in?: OpenAPIParameterLocation;
|
|
96
|
+
kind: string;
|
|
97
|
+
extensions?: GenericObject;
|
|
98
|
+
explode: boolean;
|
|
99
|
+
style?: OpenAPIParameterStyle;
|
|
100
|
+
const?: any;
|
|
101
|
+
serializationMime?: string;
|
|
102
|
+
fieldFullPath?: string;
|
|
103
|
+
deps: Deps;
|
|
104
|
+
absolutePointer?: string;
|
|
105
|
+
};
|
|
106
|
+
export type CallbackModel = {
|
|
107
|
+
name: string;
|
|
108
|
+
operations: OperationModel[];
|
|
109
|
+
};
|
|
110
|
+
export type OperationModel = {
|
|
111
|
+
id: string;
|
|
112
|
+
absoluteIdx?: number;
|
|
113
|
+
name: string;
|
|
114
|
+
description?: string | GenericObject;
|
|
115
|
+
ast?: Node[];
|
|
116
|
+
href: string;
|
|
117
|
+
type: MenuItemType;
|
|
118
|
+
parent?: GroupModel;
|
|
119
|
+
externalDocs?: OpenAPIExternalDocumentation;
|
|
120
|
+
items: ContentItemModel[];
|
|
121
|
+
depth: number;
|
|
122
|
+
activeExampleName?: string;
|
|
123
|
+
activeServer: Server;
|
|
124
|
+
defaultExampleName?: string | false;
|
|
125
|
+
defaultMimeType?: string;
|
|
126
|
+
pointer: string;
|
|
127
|
+
operationId?: string;
|
|
128
|
+
httpVerb: string;
|
|
129
|
+
deprecated: boolean;
|
|
130
|
+
path: string;
|
|
131
|
+
servers: OpenAPIServer[];
|
|
132
|
+
security: SecurityRequirement[];
|
|
133
|
+
extensions: GenericObject;
|
|
134
|
+
isCallback: boolean;
|
|
135
|
+
isWebhook: boolean;
|
|
136
|
+
isEvent: boolean;
|
|
137
|
+
callbackId: string;
|
|
138
|
+
requestBody?: RequestBodyModel;
|
|
139
|
+
payload?: {
|
|
140
|
+
lang: string;
|
|
141
|
+
label: string;
|
|
142
|
+
source: string;
|
|
143
|
+
requestBodyContent: MediaContentModel;
|
|
144
|
+
};
|
|
145
|
+
definitionSamples?: OpenAPIXCodeSample[] | Unstable_ExternalCodeSample[];
|
|
146
|
+
hasSamples: boolean;
|
|
147
|
+
allCodeSamples: OpenAPIXCodeSample[];
|
|
148
|
+
parameters: FieldModel[];
|
|
149
|
+
responses: ResponseModel[];
|
|
150
|
+
callbacks: CallbackModel[];
|
|
151
|
+
hideTryItPanel: boolean;
|
|
152
|
+
};
|
|
153
|
+
export type GroupModel = {
|
|
154
|
+
id: string;
|
|
155
|
+
href: string;
|
|
156
|
+
name: string;
|
|
157
|
+
description?: string | GenericObject;
|
|
158
|
+
isSchema?: boolean;
|
|
159
|
+
type: MenuItemGroupType;
|
|
160
|
+
items: ContentItemModel[];
|
|
161
|
+
ast?: Node[];
|
|
162
|
+
parent?: GroupModel;
|
|
163
|
+
externalDocs?: OpenAPIExternalDocumentation;
|
|
164
|
+
depth: number;
|
|
165
|
+
level: number;
|
|
166
|
+
};
|
|
167
|
+
export type OperationMenuItem = {
|
|
168
|
+
id: string;
|
|
169
|
+
href: string;
|
|
170
|
+
name: string;
|
|
171
|
+
operationDefinition: ExtendedOpenAPIOperation;
|
|
172
|
+
depth: number;
|
|
173
|
+
items: ContentItemModel[];
|
|
174
|
+
parent?: GroupModel;
|
|
175
|
+
deprecated?: boolean;
|
|
176
|
+
type: 'operation';
|
|
177
|
+
httpVerb: string;
|
|
178
|
+
path: string;
|
|
179
|
+
isWebhook: boolean;
|
|
180
|
+
operationId?: string;
|
|
181
|
+
};
|
|
182
|
+
export type SchemaModel = {
|
|
183
|
+
parser: OpenAPIParser;
|
|
184
|
+
options: Options;
|
|
185
|
+
deps: Deps;
|
|
186
|
+
schemaOrRef: Referenced<OpenAPISchema>;
|
|
187
|
+
isChild: boolean;
|
|
188
|
+
refsStack: string[];
|
|
189
|
+
pointer: string;
|
|
190
|
+
absolutePointer?: string;
|
|
191
|
+
type: string | string[];
|
|
192
|
+
displayType: string;
|
|
193
|
+
typePrefix: string;
|
|
194
|
+
title: string;
|
|
195
|
+
description: string | GenericObject;
|
|
196
|
+
externalDocs?: OpenAPIExternalDocumentation;
|
|
197
|
+
isPrimitive: boolean;
|
|
198
|
+
isCircular: boolean;
|
|
199
|
+
format?: string;
|
|
200
|
+
displayFormat?: string;
|
|
201
|
+
nullable: boolean;
|
|
202
|
+
deprecated: boolean;
|
|
203
|
+
pattern?: string;
|
|
204
|
+
example?: any;
|
|
205
|
+
enum: any[];
|
|
206
|
+
default?: any;
|
|
207
|
+
readOnly: boolean;
|
|
208
|
+
writeOnly: boolean;
|
|
209
|
+
constraints: string[];
|
|
210
|
+
fields?: FieldModel[];
|
|
211
|
+
items?: SchemaModel;
|
|
212
|
+
oneOf?: SchemaModel[];
|
|
213
|
+
oneOfType: string;
|
|
214
|
+
discriminatorProp?: string;
|
|
215
|
+
rawSchema: OpenAPISchema;
|
|
216
|
+
schema: MergedOpenAPISchema;
|
|
217
|
+
extensions?: GenericObject;
|
|
218
|
+
'x-enumDescriptions'?: {
|
|
219
|
+
[name: string]: string;
|
|
220
|
+
};
|
|
221
|
+
const: any;
|
|
222
|
+
contentEncoding?: string;
|
|
223
|
+
contentMediaType?: string;
|
|
224
|
+
minItems?: number;
|
|
225
|
+
maxItems?: number;
|
|
226
|
+
};
|
|
227
|
+
export type Deps = {
|
|
228
|
+
parentFieldFullPath?: string;
|
|
229
|
+
operation: OperationModel;
|
|
230
|
+
type?: 'request' | 'response';
|
|
231
|
+
response?: ResponseModel;
|
|
232
|
+
in?: string;
|
|
233
|
+
};
|