@stoplight/elements-core 9.0.12-beta-0.3 → 9.0.12-beta-0.4
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/package.json +14 -74
- package/.storybook/main.js +0 -6
- package/.storybook/manager.js +0 -1
- package/.storybook/preview.jsx +0 -50
- package/dist/LICENSE +0 -190
- package/dist/README.md +0 -1
- package/dist/package.json +0 -64
- package/jest.config.js +0 -10
- package/src/__fixtures__/articles/basic.md +0 -10
- package/src/__fixtures__/articles/kitchen-sink.md +0 -318
- package/src/__fixtures__/articles/long-page-heading.md +0 -955
- package/src/__fixtures__/articles/multiple-try-its.md +0 -54
- package/src/__fixtures__/articles/schema-with-refs.ts +0 -82
- package/src/__fixtures__/http-request.json +0 -11
- package/src/__fixtures__/models/model-with-no-examples.json +0 -15
- package/src/__fixtures__/models/model-with-one-example.json +0 -23
- package/src/__fixtures__/models/model-with-three-examples.json +0 -35
- package/src/__fixtures__/operations/application-octet-stream-post.ts +0 -39
- package/src/__fixtures__/operations/base64-file-upload.ts +0 -43
- package/src/__fixtures__/operations/big-response.ts +0 -4690
- package/src/__fixtures__/operations/bundled-parameter.ts +0 -128
- package/src/__fixtures__/operations/empty-response.ts +0 -15
- package/src/__fixtures__/operations/examples-request-body.ts +0 -135
- package/src/__fixtures__/operations/head-todos.ts +0 -49
- package/src/__fixtures__/operations/invalid-response-example.ts +0 -45
- package/src/__fixtures__/operations/multipart-formdata-post.ts +0 -61
- package/src/__fixtures__/operations/operation-minimal.ts +0 -11
- package/src/__fixtures__/operations/operation-parameters.ts +0 -337
- package/src/__fixtures__/operations/operation-with-examples.ts +0 -113
- package/src/__fixtures__/operations/operation-without-servers.ts +0 -16
- package/src/__fixtures__/operations/patch-todos.ts +0 -49
- package/src/__fixtures__/operations/put-todos.ts +0 -862
- package/src/__fixtures__/operations/referenced-body.ts +0 -62
- package/src/__fixtures__/operations/request-body-empty-schema.ts +0 -35
- package/src/__fixtures__/operations/request-body.ts +0 -62
- package/src/__fixtures__/operations/securedOperation.ts +0 -118
- package/src/__fixtures__/operations/security-basic.ts +0 -24
- package/src/__fixtures__/operations/security-bearer.ts +0 -25
- package/src/__fixtures__/operations/simple-get.ts +0 -17
- package/src/__fixtures__/operations/simple.ts +0 -103
- package/src/__fixtures__/operations/string-numeric-enums.ts +0 -32
- package/src/__fixtures__/operations/urlencoded-post-oneof.ts +0 -81
- package/src/__fixtures__/operations/urlencoded-post.ts +0 -54
- package/src/__fixtures__/operations/vendor-extensions.ts +0 -337
- package/src/__fixtures__/operations/with-url-variables.ts +0 -47
- package/src/__fixtures__/operations/x-code-samples.ts +0 -348
- package/src/__fixtures__/schemas/circular.ts +0 -1906
- package/src/__fixtures__/schemas/contact.json +0 -293
- package/src/__fixtures__/schemas/media-entry.json +0 -69
- package/src/__fixtures__/schemas/simple.json +0 -27
- package/src/__fixtures__/schemas/todo-full.v1.json +0 -35
- package/src/__fixtures__/schemas/todo-partial.v1.json +0 -14
- package/src/__fixtures__/schemas/user.v1.json +0 -17
- package/src/__fixtures__/security-schemes/index.ts +0 -38
- package/src/__fixtures__/services/petstore.ts +0 -167
- package/src/__fixtures__/services/with-unnamed-servers.ts +0 -38
- package/src/__fixtures__/services/with-url-variables.ts +0 -83
- package/src/__fixtures__/services/without-origin.ts +0 -20
- package/src/__fixtures__/table-of-contents/nested.ts +0 -44
- package/src/__fixtures__/table-of-contents/studio-template.ts +0 -100
- package/src/__fixtures__/table-of-contents/studio.ts +0 -559
- package/src/components/Docs/Article/Article.spec.tsx +0 -38
- package/src/components/Docs/Article/Article.stories.tsx +0 -17
- package/src/components/Docs/Article/index.tsx +0 -38
- package/src/components/Docs/Docs.stories.tsx +0 -33
- package/src/components/Docs/Docs.tsx +0 -272
- package/src/components/Docs/HttpOperation/Badges.tsx +0 -49
- package/src/components/Docs/HttpOperation/Body.tsx +0 -115
- package/src/components/Docs/HttpOperation/Callbacks.tsx +0 -89
- package/src/components/Docs/HttpOperation/HttpOperation.spec.tsx +0 -787
- package/src/components/Docs/HttpOperation/HttpOperation.stories.ts +0 -14
- package/src/components/Docs/HttpOperation/HttpOperation.tsx +0 -260
- package/src/components/Docs/HttpOperation/LazySchemaTreePreviewer.tsx +0 -651
- package/src/components/Docs/HttpOperation/Parameters.spec.tsx +0 -101
- package/src/components/Docs/HttpOperation/Parameters.tsx +0 -118
- package/src/components/Docs/HttpOperation/Request.tsx +0 -152
- package/src/components/Docs/HttpOperation/Responses.tsx +0 -301
- package/src/components/Docs/HttpOperation/index.ts +0 -1
- package/src/components/Docs/HttpService/AdditionalInfo.stories.ts +0 -48
- package/src/components/Docs/HttpService/AdditionalInfo.tsx +0 -61
- package/src/components/Docs/HttpService/ExportButton.tsx +0 -35
- package/src/components/Docs/HttpService/HttpService.spec.tsx +0 -429
- package/src/components/Docs/HttpService/HttpService.stories.ts +0 -14
- package/src/components/Docs/HttpService/HttpService.tsx +0 -99
- package/src/components/Docs/HttpService/SecuritySchemes.tsx +0 -82
- package/src/components/Docs/HttpService/ServerInfo.tsx +0 -196
- package/src/components/Docs/HttpService/index.ts +0 -1
- package/src/components/Docs/Model/Model.spec.tsx +0 -241
- package/src/components/Docs/Model/Model.stories.tsx +0 -16
- package/src/components/Docs/Model/Model.tsx +0 -192
- package/src/components/Docs/Model/index.ts +0 -1
- package/src/components/Docs/NodeVendorExtensions.tsx +0 -55
- package/src/components/Docs/Sections.tsx +0 -54
- package/src/components/Docs/Security/PanelContent.tsx +0 -38
- package/src/components/Docs/Security/index.ts +0 -1
- package/src/components/Docs/Skeleton.tsx +0 -12
- package/src/components/Docs/TwoColumnLayout.tsx +0 -27
- package/src/components/Docs/index.ts +0 -1
- package/src/components/Docs/story-helper.ts +0 -46
- package/src/components/Docs/story-renderer-helper.tsx +0 -56
- package/src/components/Layout/MobileTopNav.tsx +0 -78
- package/src/components/Layout/ResponsiveSidebarLayout.tsx +0 -175
- package/src/components/Layout/SidebarLayout.tsx +0 -107
- package/src/components/LinkHeading.tsx +0 -21
- package/src/components/LoadMore.tsx +0 -20
- package/src/components/Loading/Loading.tsx +0 -9
- package/src/components/Logo.tsx +0 -25
- package/src/components/MarkdownViewer/CustomComponents/CodeComponent.spec.ts +0 -90
- package/src/components/MarkdownViewer/CustomComponents/CodeComponent.tsx +0 -164
- package/src/components/MarkdownViewer/CustomComponents/Provider.tsx +0 -20
- package/src/components/MarkdownViewer/CustomComponents/ReactRouterLink.tsx +0 -27
- package/src/components/MarkdownViewer/CustomComponents/ResolvedImage.tsx +0 -86
- package/src/components/MarkdownViewer/CustomComponents/ScrollToHashElement.tsx +0 -96
- package/src/components/MarkdownViewer/MarkdownViewer.spec.tsx +0 -170
- package/src/components/MarkdownViewer/index.tsx +0 -10
- package/src/components/NonIdealState.tsx +0 -20
- package/src/components/PoweredByLink.tsx +0 -30
- package/src/components/RequestSamples/RequestSamples.stories.tsx +0 -67
- package/src/components/RequestSamples/RequestSamples.tsx +0 -246
- package/src/components/RequestSamples/__tests__/RequestSamples.test.tsx +0 -131
- package/src/components/RequestSamples/__tests__/__snapshots__/convertRequestToSample.spec.ts.snap +0 -746
- package/src/components/RequestSamples/__tests__/convertRequestToSample.spec.ts +0 -118
- package/src/components/RequestSamples/convertRequestToSample.ts +0 -56
- package/src/components/RequestSamples/extractCodeSamples.ts +0 -50
- package/src/components/RequestSamples/index.ts +0 -2
- package/src/components/RequestSamples/requestSampleConfigs.ts +0 -182
- package/src/components/ResponseExamples/ResponseExamples.spec.tsx +0 -121
- package/src/components/ResponseExamples/ResponseExamples.stories.tsx +0 -21
- package/src/components/ResponseExamples/ResponseExamples.tsx +0 -79
- package/src/components/TableOfContents/TableOfContents.spec.tsx +0 -301
- package/src/components/TableOfContents/TableOfContents.stories.tsx +0 -121
- package/src/components/TableOfContents/TableOfContents.tsx +0 -406
- package/src/components/TableOfContents/constants.ts +0 -45
- package/src/components/TableOfContents/index.ts +0 -2
- package/src/components/TableOfContents/types.ts +0 -51
- package/src/components/TableOfContents/utils.ts +0 -84
- package/src/components/TryIt/Auth/APIKeyAuth.tsx +0 -19
- package/src/components/TryIt/Auth/Auth.tsx +0 -169
- package/src/components/TryIt/Auth/AuthTokenInput.tsx +0 -37
- package/src/components/TryIt/Auth/BasicAuth.tsx +0 -62
- package/src/components/TryIt/Auth/BearerAuth.tsx +0 -19
- package/src/components/TryIt/Auth/DigestAuth.tsx +0 -35
- package/src/components/TryIt/Auth/OAuth2Auth.tsx +0 -19
- package/src/components/TryIt/Auth/authentication-utils.ts +0 -113
- package/src/components/TryIt/Body/BinaryBody.tsx +0 -52
- package/src/components/TryIt/Body/FormDataBody.tsx +0 -145
- package/src/components/TryIt/Body/RequestBody.tsx +0 -71
- package/src/components/TryIt/Body/__tests__/BinaryBody.test.tsx +0 -29
- package/src/components/TryIt/Body/__tests__/FormDataBody.test.tsx +0 -94
- package/src/components/TryIt/Body/request-body-utils.ts +0 -127
- package/src/components/TryIt/Body/useTextRequestBodyState.ts +0 -27
- package/src/components/TryIt/Mocking/MockingButton.tsx +0 -98
- package/src/components/TryIt/Mocking/mocking-utils.ts +0 -56
- package/src/components/TryIt/Mocking/useMockingOptions.ts +0 -6
- package/src/components/TryIt/Parameters/FileUploadParameterEditors.tsx +0 -62
- package/src/components/TryIt/Parameters/OperationParameters.tsx +0 -39
- package/src/components/TryIt/Parameters/ParameterEditor.tsx +0 -118
- package/src/components/TryIt/Parameters/__tests__/parameter-utils.spec.ts +0 -60
- package/src/components/TryIt/Parameters/parameter-utils.spec.ts +0 -118
- package/src/components/TryIt/Parameters/parameter-utils.ts +0 -179
- package/src/components/TryIt/Parameters/useOperationParameters.ts +0 -60
- package/src/components/TryIt/Response/ReponseCodeViewer.tsx +0 -28
- package/src/components/TryIt/Response/Response.spec.tsx +0 -174
- package/src/components/TryIt/Response/Response.tsx +0 -172
- package/src/components/TryIt/Response/hooks/useLineCount.ts +0 -7
- package/src/components/TryIt/Servers/ServerVariables.tsx +0 -33
- package/src/components/TryIt/Servers/ServersDropdown.tsx +0 -53
- package/src/components/TryIt/Servers/VariableEditor.tsx +0 -51
- package/src/components/TryIt/Servers/useServerVariables.ts +0 -19
- package/src/components/TryIt/TryIt.spec.tsx +0 -1511
- package/src/components/TryIt/TryIt.stories.tsx +0 -77
- package/src/components/TryIt/TryIt.tsx +0 -384
- package/src/components/TryIt/TryItWithRequestSamples.spec.tsx +0 -143
- package/src/components/TryIt/TryItWithRequestSamples.stories.tsx +0 -32
- package/src/components/TryIt/TryItWithRequestSamples.tsx +0 -42
- package/src/components/TryIt/build-request.spec.ts +0 -213
- package/src/components/TryIt/build-request.ts +0 -357
- package/src/components/TryIt/chosenServer.ts +0 -5
- package/src/components/TryIt/index.ts +0 -3
- package/src/components/__tests__/LinkHeading.spec.tsx +0 -125
- package/src/constants.ts +0 -176
- package/src/containers/MockingProvider.tsx +0 -23
- package/src/context/InlineRefResolver.spec.tsx +0 -183
- package/src/context/InlineRefResolver.tsx +0 -94
- package/src/context/Options.tsx +0 -27
- package/src/context/Persistence.tsx +0 -24
- package/src/context/RouterType.tsx +0 -9
- package/src/core.css +0 -97
- package/src/hoc/utils.ts +0 -5
- package/src/hoc/withMosaicProvider.spec.tsx +0 -48
- package/src/hoc/withMosaicProvider.tsx +0 -28
- package/src/hoc/withQueryClientProvider.spec.tsx +0 -38
- package/src/hoc/withQueryClientProvider.tsx +0 -35
- package/src/hoc/withRouter.tsx +0 -71
- package/src/hooks/useBundleRefsIntoDocument.ts +0 -60
- package/src/hooks/useFirstRender.ts +0 -8
- package/src/hooks/useIsCompact.ts +0 -26
- package/src/hooks/useParsedData.ts +0 -99
- package/src/hooks/useParsedValue.ts +0 -19
- package/src/hooks/useResponsiveLayout.tsx +0 -51
- package/src/hooks/useRouter.tsx +0 -31
- package/src/hooks/useUniqueId.ts +0 -4
- package/src/index.ts +0 -48
- package/src/styled.tsx +0 -22
- package/src/styles.css +0 -4
- package/src/types.ts +0 -170
- package/src/utils/__tests__/securitySchemes.spec.ts +0 -137
- package/src/utils/exampleGeneration/exampleGeneration.spec.tsx +0 -18
- package/src/utils/exampleGeneration/exampleGeneration.ts +0 -110
- package/src/utils/fileToBase64.ts +0 -11
- package/src/utils/guards.ts +0 -48
- package/src/utils/headers.ts +0 -316
- package/src/utils/http-spec/IServer.ts +0 -100
- package/src/utils/http-spec/__tests__/IServer.spec.ts +0 -51
- package/src/utils/http-spec/examples.ts +0 -5
- package/src/utils/http.ts +0 -9
- package/src/utils/jotai/persistAtom.ts +0 -31
- package/src/utils/node.ts +0 -19
- package/src/utils/oas/__tests__/security.spec.ts +0 -18
- package/src/utils/oas/security.ts +0 -76
- package/src/utils/ref-resolving/ReferenceResolver.ts +0 -29
- package/src/utils/ref-resolving/resolvedObject.test.ts +0 -415
- package/src/utils/ref-resolving/resolvedObject.ts +0 -109
- package/src/utils/securitySchemes.ts +0 -117
- package/src/utils/string.ts +0 -15
- package/src/utils/tests/chooseOption.ts +0 -7
- package/src/web-components/createElementClass.ts +0 -154
- package/tsconfig.build.json +0 -14
- package/tsconfig.json +0 -7
- /package/{dist/__fixtures__ → __fixtures__}/articles/schema-with-refs.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/application-octet-stream-post.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/base64-file-upload.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/big-response.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/examples-request-body.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/head-todos.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/multipart-formdata-post.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/operation-minimal.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/operation-parameters.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/operation-with-examples.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/operation-without-servers.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/patch-todos.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/put-todos.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/referenced-body.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/request-body-empty-schema.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/request-body.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/securedOperation.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/security-basic.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/security-bearer.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/simple-get.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/string-numeric-enums.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/urlencoded-post-oneof.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/urlencoded-post.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/operations/with-url-variables.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/security-schemes/index.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/services/petstore.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/services/with-unnamed-servers.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/services/with-url-variables.d.ts +0 -0
- /package/{dist/__fixtures__ → __fixtures__}/services/without-origin.d.ts +0 -0
- /package/{dist/components → components}/Docs/Article/Article.spec.d.ts +0 -0
- /package/{dist/components → components}/Docs/Article/Article.stories.d.ts +0 -0
- /package/{dist/components → components}/Docs/Article/index.d.ts +0 -0
- /package/{dist/components → components}/Docs/Docs.d.ts +0 -0
- /package/{dist/components → components}/Docs/Docs.stories.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpOperation/Badges.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpOperation/Body.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpOperation/Callbacks.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpOperation/HttpOperation.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpOperation/HttpOperation.spec.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpOperation/HttpOperation.stories.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpOperation/LazySchemaTreePreviewer.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpOperation/Parameters.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpOperation/Parameters.spec.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpOperation/Request.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpOperation/Responses.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpOperation/index.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpService/AdditionalInfo.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpService/AdditionalInfo.stories.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpService/ExportButton.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpService/HttpService.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpService/HttpService.spec.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpService/HttpService.stories.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpService/SecuritySchemes.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpService/ServerInfo.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpService/index.d.ts +0 -0
- /package/{dist/components → components}/Docs/Model/Model.d.ts +0 -0
- /package/{dist/components → components}/Docs/Model/Model.spec.d.ts +0 -0
- /package/{dist/components → components}/Docs/Model/Model.stories.d.ts +0 -0
- /package/{dist/components → components}/Docs/Model/index.d.ts +0 -0
- /package/{dist/components → components}/Docs/NodeVendorExtensions.d.ts +0 -0
- /package/{dist/components → components}/Docs/Sections.d.ts +0 -0
- /package/{dist/components → components}/Docs/Security/PanelContent.d.ts +0 -0
- /package/{dist/components → components}/Docs/Security/index.d.ts +0 -0
- /package/{dist/components → components}/Docs/Skeleton.d.ts +0 -0
- /package/{dist/components → components}/Docs/TwoColumnLayout.d.ts +0 -0
- /package/{dist/components → components}/Docs/index.d.ts +0 -0
- /package/{dist/components → components}/Docs/story-helper.d.ts +0 -0
- /package/{dist/components → components}/Docs/story-renderer-helper.d.ts +0 -0
- /package/{dist/components → components}/Layout/MobileTopNav.d.ts +0 -0
- /package/{dist/components → components}/Layout/ResponsiveSidebarLayout.d.ts +0 -0
- /package/{dist/components → components}/Layout/SidebarLayout.d.ts +0 -0
- /package/{dist/components → components}/LinkHeading.d.ts +0 -0
- /package/{dist/components → components}/LoadMore.d.ts +0 -0
- /package/{dist/components → components}/Loading/Loading.d.ts +0 -0
- /package/{dist/components → components}/Logo.d.ts +0 -0
- /package/{dist/components → components}/MarkdownViewer/CustomComponents/CodeComponent.d.ts +0 -0
- /package/{dist/components → components}/MarkdownViewer/CustomComponents/CodeComponent.spec.d.ts +0 -0
- /package/{dist/components → components}/MarkdownViewer/CustomComponents/Provider.d.ts +0 -0
- /package/{dist/components → components}/MarkdownViewer/CustomComponents/ReactRouterLink.d.ts +0 -0
- /package/{dist/components → components}/MarkdownViewer/CustomComponents/ResolvedImage.d.ts +0 -0
- /package/{dist/components → components}/MarkdownViewer/CustomComponents/ScrollToHashElement.d.ts +0 -0
- /package/{dist/components → components}/MarkdownViewer/MarkdownViewer.spec.d.ts +0 -0
- /package/{dist/components → components}/MarkdownViewer/index.d.ts +0 -0
- /package/{dist/components → components}/NonIdealState.d.ts +0 -0
- /package/{dist/components → components}/PoweredByLink.d.ts +0 -0
- /package/{dist/components → components}/RequestSamples/RequestSamples.d.ts +0 -0
- /package/{dist/components → components}/RequestSamples/RequestSamples.stories.d.ts +0 -0
- /package/{dist/components → components}/RequestSamples/convertRequestToSample.d.ts +0 -0
- /package/{dist/components → components}/RequestSamples/extractCodeSamples.d.ts +0 -0
- /package/{dist/components → components}/RequestSamples/index.d.ts +0 -0
- /package/{dist/components → components}/RequestSamples/requestSampleConfigs.d.ts +0 -0
- /package/{dist/components → components}/ResponseExamples/ResponseExamples.d.ts +0 -0
- /package/{dist/components → components}/ResponseExamples/ResponseExamples.spec.d.ts +0 -0
- /package/{dist/components → components}/ResponseExamples/ResponseExamples.stories.d.ts +0 -0
- /package/{dist/components → components}/TableOfContents/TableOfContents.d.ts +0 -0
- /package/{dist/components → components}/TableOfContents/TableOfContents.spec.d.ts +0 -0
- /package/{dist/components → components}/TableOfContents/TableOfContents.stories.d.ts +0 -0
- /package/{dist/components → components}/TableOfContents/constants.d.ts +0 -0
- /package/{dist/components → components}/TableOfContents/index.d.ts +0 -0
- /package/{dist/components → components}/TableOfContents/types.d.ts +0 -0
- /package/{dist/components → components}/TableOfContents/utils.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Auth/APIKeyAuth.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Auth/Auth.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Auth/AuthTokenInput.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Auth/BasicAuth.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Auth/BearerAuth.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Auth/DigestAuth.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Auth/OAuth2Auth.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Auth/authentication-utils.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Body/BinaryBody.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Body/FormDataBody.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Body/RequestBody.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Body/request-body-utils.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Body/useTextRequestBodyState.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Mocking/MockingButton.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Mocking/mocking-utils.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Mocking/useMockingOptions.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Parameters/FileUploadParameterEditors.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Parameters/OperationParameters.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Parameters/ParameterEditor.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Parameters/parameter-utils.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Parameters/parameter-utils.spec.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Parameters/useOperationParameters.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Response/ReponseCodeViewer.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Response/Response.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Response/Response.spec.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Response/hooks/useLineCount.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Servers/ServerVariables.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Servers/ServersDropdown.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Servers/VariableEditor.d.ts +0 -0
- /package/{dist/components → components}/TryIt/Servers/useServerVariables.d.ts +0 -0
- /package/{dist/components → components}/TryIt/TryIt.d.ts +0 -0
- /package/{dist/components → components}/TryIt/TryIt.spec.d.ts +0 -0
- /package/{dist/components → components}/TryIt/TryIt.stories.d.ts +0 -0
- /package/{dist/components → components}/TryIt/TryItWithRequestSamples.d.ts +0 -0
- /package/{dist/components → components}/TryIt/TryItWithRequestSamples.spec.d.ts +0 -0
- /package/{dist/components → components}/TryIt/TryItWithRequestSamples.stories.d.ts +0 -0
- /package/{dist/components → components}/TryIt/build-request.d.ts +0 -0
- /package/{dist/components → components}/TryIt/build-request.spec.d.ts +0 -0
- /package/{dist/components → components}/TryIt/chosenServer.d.ts +0 -0
- /package/{dist/components → components}/TryIt/index.d.ts +0 -0
- /package/{dist/constants.d.ts → constants.d.ts} +0 -0
- /package/{dist/containers → containers}/MockingProvider.d.ts +0 -0
- /package/{dist/context → context}/InlineRefResolver.d.ts +0 -0
- /package/{dist/context → context}/InlineRefResolver.spec.d.ts +0 -0
- /package/{dist/context → context}/Options.d.ts +0 -0
- /package/{dist/context → context}/Persistence.d.ts +0 -0
- /package/{dist/context → context}/RouterType.d.ts +0 -0
- /package/{dist/core.css → core.css} +0 -0
- /package/{dist/hoc → hoc}/utils.d.ts +0 -0
- /package/{dist/hoc → hoc}/withMosaicProvider.d.ts +0 -0
- /package/{dist/hoc → hoc}/withMosaicProvider.spec.d.ts +0 -0
- /package/{dist/hoc → hoc}/withQueryClientProvider.d.ts +0 -0
- /package/{dist/hoc → hoc}/withQueryClientProvider.spec.d.ts +0 -0
- /package/{dist/hoc → hoc}/withRouter.d.ts +0 -0
- /package/{dist/hooks → hooks}/useBundleRefsIntoDocument.d.ts +0 -0
- /package/{dist/hooks → hooks}/useFirstRender.d.ts +0 -0
- /package/{dist/hooks → hooks}/useIsCompact.d.ts +0 -0
- /package/{dist/hooks → hooks}/useParsedData.d.ts +0 -0
- /package/{dist/hooks → hooks}/useParsedValue.d.ts +0 -0
- /package/{dist/hooks → hooks}/useResponsiveLayout.d.ts +0 -0
- /package/{dist/hooks → hooks}/useRouter.d.ts +0 -0
- /package/{dist/hooks → hooks}/useUniqueId.d.ts +0 -0
- /package/{dist/index.d.ts → index.d.ts} +0 -0
- /package/{dist/index.esm.js → index.esm.js} +0 -0
- /package/{dist/index.js → index.js} +0 -0
- /package/{dist/index.mjs → index.mjs} +0 -0
- /package/{dist/styled.d.ts → styled.d.ts} +0 -0
- /package/{dist/styles.min.css → styles.min.css} +0 -0
- /package/{dist/types.d.ts → types.d.ts} +0 -0
- /package/{dist/utils → utils}/exampleGeneration/exampleGeneration.d.ts +0 -0
- /package/{dist/utils → utils}/exampleGeneration/exampleGeneration.spec.d.ts +0 -0
- /package/{dist/utils → utils}/fileToBase64.d.ts +0 -0
- /package/{dist/utils → utils}/guards.d.ts +0 -0
- /package/{dist/utils → utils}/headers.d.ts +0 -0
- /package/{dist/utils → utils}/http-spec/IServer.d.ts +0 -0
- /package/{dist/utils → utils}/http-spec/examples.d.ts +0 -0
- /package/{dist/utils → utils}/http.d.ts +0 -0
- /package/{dist/utils → utils}/jotai/persistAtom.d.ts +0 -0
- /package/{dist/utils → utils}/node.d.ts +0 -0
- /package/{dist/utils → utils}/oas/security.d.ts +0 -0
- /package/{dist/utils → utils}/ref-resolving/ReferenceResolver.d.ts +0 -0
- /package/{dist/utils → utils}/ref-resolving/resolvedObject.d.ts +0 -0
- /package/{dist/utils → utils}/ref-resolving/resolvedObject.test.d.ts +0 -0
- /package/{dist/utils → utils}/securitySchemes.d.ts +0 -0
- /package/{dist/utils → utils}/string.d.ts +0 -0
- /package/{dist/utils → utils}/tests/chooseOption.d.ts +0 -0
- /package/{dist/web-components → web-components}/createElementClass.d.ts +0 -0
|
@@ -1,318 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Stoplight Flavored Markdown
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
# Stoplight Flavored Markdown (smd)
|
|
6
|
-
|
|
7
|
-
### The Two Laws
|
|
8
|
-
|
|
9
|
-
1. smd is human readable. A human with a simple text editor can easily read and comprehend smd.
|
|
10
|
-
2. smd degrades gracefully. An smd document rendered on `github.com` should be readable and clean.
|
|
11
|
-
|
|
12
|
-
### The Approach
|
|
13
|
-
|
|
14
|
-
1. Stoplight flavored markdown extends github flavor markdown with inline comment annotations.
|
|
15
|
-
2. The value inside of the annotations is a yaml object, and the annotation affects the following markdown block.
|
|
16
|
-
|
|
17
|
-
By leveraging comments to store annotations, Stoplight flavored markdown degrades gracefully to any other markdown renderer (Github, for example).
|
|
18
|
-
|
|
19
|
-
> [MDX](https://github.com/mdx-js/mdx) is an interesting project that might allow our users to add more interactivity to their docs, at the cost of complexity (this is a more advanced use case). We would have to figure out a way to introduce this WITHOUT impacting those users that do not need the feature.
|
|
20
|
-
|
|
21
|
-
## Tabs
|
|
22
|
-
|
|
23
|
-
A smd tab container is a `tab` annotation, followed by the tab content, and closed by a final `tab-end` annotation.
|
|
24
|
-
|
|
25
|
-
Tab containers cannot be nested.
|
|
26
|
-
|
|
27
|
-
<!--
|
|
28
|
-
type: tab
|
|
29
|
-
title: My First Tab
|
|
30
|
-
-->
|
|
31
|
-
|
|
32
|
-
The contents of tab 1.
|
|
33
|
-
|
|
34
|
-
<!--
|
|
35
|
-
type: tab
|
|
36
|
-
title: My Second Tab
|
|
37
|
-
-->
|
|
38
|
-
|
|
39
|
-
The contents of tab 2.
|
|
40
|
-
|
|
41
|
-
<!-- type: tab-end -->
|
|
42
|
-
|
|
43
|
-
#### Markdown Sample
|
|
44
|
-
|
|
45
|
-
```md
|
|
46
|
-
<!--
|
|
47
|
-
type: tab
|
|
48
|
-
title: My First Tab
|
|
49
|
-
-->
|
|
50
|
-
|
|
51
|
-
The contents of tab 1.
|
|
52
|
-
|
|
53
|
-
<!--
|
|
54
|
-
type: tab
|
|
55
|
-
title: My Second Tab
|
|
56
|
-
-->
|
|
57
|
-
|
|
58
|
-
The contents of tab 2.
|
|
59
|
-
|
|
60
|
-
<!-- type: tab-end -->
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
## Callouts
|
|
64
|
-
|
|
65
|
-
A callout is a md block quote with an optional annotation that indicates intent.
|
|
66
|
-
|
|
67
|
-
<!-- theme: danger -->
|
|
68
|
-
|
|
69
|
-
> ### Danger Will Robinson!
|
|
70
|
-
>
|
|
71
|
-
> Here is my danger callout!
|
|
72
|
-
|
|
73
|
-
<!-- theme: warning -->
|
|
74
|
-
|
|
75
|
-
> ### Watch Out!
|
|
76
|
-
>
|
|
77
|
-
> Here is my warning callout!
|
|
78
|
-
|
|
79
|
-
<!-- theme: success -->
|
|
80
|
-
|
|
81
|
-
> ### Mission Accomplished!
|
|
82
|
-
>
|
|
83
|
-
> Here is my success callout!
|
|
84
|
-
|
|
85
|
-
<!-- theme: info -->
|
|
86
|
-
|
|
87
|
-
> ### A thing to know
|
|
88
|
-
>
|
|
89
|
-
> Here is my info callout
|
|
90
|
-
|
|
91
|
-
#### Markdown Sample
|
|
92
|
-
|
|
93
|
-
```md
|
|
94
|
-
<!-- theme: danger -->
|
|
95
|
-
|
|
96
|
-
> ### Danger Will Robinson!
|
|
97
|
-
>
|
|
98
|
-
> Here is my danger callout!
|
|
99
|
-
|
|
100
|
-
<!-- theme: warning -->
|
|
101
|
-
|
|
102
|
-
> ### Watch Out!
|
|
103
|
-
>
|
|
104
|
-
> Here is my warning callout!
|
|
105
|
-
|
|
106
|
-
<!-- theme: success -->
|
|
107
|
-
|
|
108
|
-
> ### Mission Accomplished!
|
|
109
|
-
>
|
|
110
|
-
> Here is my success callout!
|
|
111
|
-
|
|
112
|
-
<!-- theme: info -->
|
|
113
|
-
|
|
114
|
-
> ### A thing to know
|
|
115
|
-
>
|
|
116
|
-
> Here is my info callout
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
## Code Blocks
|
|
120
|
-
|
|
121
|
-
A smd code block is md code fence with an optional annotation to tweak the presentation of the code block.
|
|
122
|
-
|
|
123
|
-
<!--
|
|
124
|
-
title: "Fibonacci In Javascript"
|
|
125
|
-
lineNumbers: false
|
|
126
|
-
highlightLines: [[1,2], [4,5]]
|
|
127
|
-
-->
|
|
128
|
-
|
|
129
|
-
```javascript
|
|
130
|
-
function fibonacci(num) {
|
|
131
|
-
var a = 1,
|
|
132
|
-
b = 0,
|
|
133
|
-
temp;
|
|
134
|
-
|
|
135
|
-
while (num >= 0) {
|
|
136
|
-
temp = a;
|
|
137
|
-
a = a + b;
|
|
138
|
-
b = temp;
|
|
139
|
-
num--;
|
|
140
|
-
}
|
|
141
|
-
|
|
142
|
-
return b;
|
|
143
|
-
}
|
|
144
|
-
```
|
|
145
|
-
|
|
146
|
-
## JSON Schema
|
|
147
|
-
|
|
148
|
-
A smd json schema block is a smd code block with the `json_schema` language tag. The contents of the code fence should
|
|
149
|
-
be the json schema object to be rendered.
|
|
150
|
-
|
|
151
|
-
<!-- type: json_schema -->
|
|
152
|
-
|
|
153
|
-
```json
|
|
154
|
-
{
|
|
155
|
-
"title": "Todo Full",
|
|
156
|
-
"allOf": [
|
|
157
|
-
{
|
|
158
|
-
"title": "Todo Partial",
|
|
159
|
-
"type": "object",
|
|
160
|
-
"properties": {
|
|
161
|
-
"name": {
|
|
162
|
-
"type": "string"
|
|
163
|
-
},
|
|
164
|
-
"completed": {
|
|
165
|
-
"type": [
|
|
166
|
-
"boolean",
|
|
167
|
-
"null"
|
|
168
|
-
]
|
|
169
|
-
}
|
|
170
|
-
},
|
|
171
|
-
"required": [
|
|
172
|
-
"name",
|
|
173
|
-
"completed"
|
|
174
|
-
],
|
|
175
|
-
"x-tags": [
|
|
176
|
-
"Todos"
|
|
177
|
-
]
|
|
178
|
-
},
|
|
179
|
-
{
|
|
180
|
-
"type": "object",
|
|
181
|
-
"properties": {
|
|
182
|
-
"id": {
|
|
183
|
-
"type": "integer",
|
|
184
|
-
"minimum": 0,
|
|
185
|
-
"maximum": 1000000
|
|
186
|
-
},
|
|
187
|
-
"completed_at": {
|
|
188
|
-
"type": [
|
|
189
|
-
"string",
|
|
190
|
-
"null"
|
|
191
|
-
],
|
|
192
|
-
"format": "date-time"
|
|
193
|
-
},
|
|
194
|
-
"created_at": {
|
|
195
|
-
"type": "string",
|
|
196
|
-
"format": "date-time"
|
|
197
|
-
},
|
|
198
|
-
"updated_at": {
|
|
199
|
-
"type": "string",
|
|
200
|
-
"format": "date-time"
|
|
201
|
-
},
|
|
202
|
-
"user": {
|
|
203
|
-
"title": "User",
|
|
204
|
-
"type": "object",
|
|
205
|
-
"properties": {
|
|
206
|
-
"name": {
|
|
207
|
-
"type": "string",
|
|
208
|
-
"description": "The user's full name."
|
|
209
|
-
},
|
|
210
|
-
"age": {
|
|
211
|
-
"type": "number",
|
|
212
|
-
"minimum": 0,
|
|
213
|
-
"maximum": 150
|
|
214
|
-
},
|
|
215
|
-
"type": {
|
|
216
|
-
"type": "string",
|
|
217
|
-
"enum": ["STANDARD", "ADMIN"],
|
|
218
|
-
"x-enum-descriptions": {
|
|
219
|
-
"STANDARD": "A standard user",
|
|
220
|
-
"ADMIN": "A user with administrative powers"
|
|
221
|
-
}
|
|
222
|
-
}
|
|
223
|
-
},
|
|
224
|
-
"required": [
|
|
225
|
-
"name",
|
|
226
|
-
"age"
|
|
227
|
-
],
|
|
228
|
-
"x-tags": [
|
|
229
|
-
"Todos"
|
|
230
|
-
]
|
|
231
|
-
}
|
|
232
|
-
},
|
|
233
|
-
"required": [
|
|
234
|
-
"id",
|
|
235
|
-
"user"
|
|
236
|
-
]
|
|
237
|
-
}
|
|
238
|
-
],
|
|
239
|
-
"x-tags": [
|
|
240
|
-
"Todos"
|
|
241
|
-
]
|
|
242
|
-
}
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
## HTTP Try It Out
|
|
246
|
-
|
|
247
|
-
A smd http try it out block is a smd code block with the `http` language tag. The contents of the code fence should
|
|
248
|
-
be the http object to be rendered.
|
|
249
|
-
|
|
250
|
-
### Raw Http Request
|
|
251
|
-
|
|
252
|
-
<!-- type: http -->
|
|
253
|
-
|
|
254
|
-
```json
|
|
255
|
-
{
|
|
256
|
-
"method": "get",
|
|
257
|
-
"url": "/gifs/search",
|
|
258
|
-
"baseUrl": "http://api.giphy.com/v1",
|
|
259
|
-
"headers": {},
|
|
260
|
-
"query": {
|
|
261
|
-
"api_key": ["dc6zaTOxFJmzC"],
|
|
262
|
-
"limit": ["1"],
|
|
263
|
-
"q": ["cats"]
|
|
264
|
-
}
|
|
265
|
-
}
|
|
266
|
-
```
|
|
267
|
-
|
|
268
|
-
````md
|
|
269
|
-
<!-- type: http -->
|
|
270
|
-
|
|
271
|
-
```json
|
|
272
|
-
{
|
|
273
|
-
"method": "get",
|
|
274
|
-
"url": "/gifs/search",
|
|
275
|
-
"baseUrl": "http://api.giphy.com/v1",
|
|
276
|
-
"headers": {},
|
|
277
|
-
"query": {
|
|
278
|
-
"api_key": ["dc6zaTOxFJmzC"],
|
|
279
|
-
"limit": ["1"],
|
|
280
|
-
"q": ["cats"]
|
|
281
|
-
}
|
|
282
|
-
}
|
|
283
|
-
```
|
|
284
|
-
````
|
|
285
|
-
|
|
286
|
-
### From a remote Http Operation
|
|
287
|
-
|
|
288
|
-
<!-- type: http -->
|
|
289
|
-
|
|
290
|
-
```json
|
|
291
|
-
{
|
|
292
|
-
"$ref": "https://stoplight.io/api/v1/projects/demo/external-api/nodes/zoom.yaml/paths/~1meetings~1%7BmeetingId%7D/get?deref=optimizedBundle"
|
|
293
|
-
}
|
|
294
|
-
```
|
|
295
|
-
|
|
296
|
-
````md
|
|
297
|
-
<!-- type: http -->
|
|
298
|
-
|
|
299
|
-
```json
|
|
300
|
-
{
|
|
301
|
-
"$ref": "https://stoplight.io/api/v1/projects/demo/external-api/nodes/zoom.yaml/paths/~1meetings~1%7BmeetingId%7D/get?deref=optimizedBundle"
|
|
302
|
-
}
|
|
303
|
-
```
|
|
304
|
-
````
|
|
305
|
-
|
|
306
|
-
## Raw HTML
|
|
307
|
-
|
|
308
|
-
```
|
|
309
|
-
<div>Hello world!</div>
|
|
310
|
-
```
|
|
311
|
-
|
|
312
|
-
<div>Hello world!</div>
|
|
313
|
-
|
|
314
|
-
## Inline Links
|
|
315
|
-
|
|
316
|
-
[foo], [foo][], [bar][foo].
|
|
317
|
-
|
|
318
|
-
[foo]: http://example.com 'Example Domain'
|