@stoplight/elements-core 9.0.12-beta-0.1 → 9.0.13
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/components → components}/Docs/Docs.d.ts +1 -14
- package/{dist/components → components}/Docs/HttpOperation/Body.d.ts +1 -9
- package/{dist/components → components}/Docs/HttpOperation/HttpOperation.d.ts +2 -6
- package/{dist/components → components}/Docs/HttpOperation/Request.d.ts +0 -6
- package/{dist/components → components}/Docs/HttpOperation/Responses.d.ts +1 -12
- package/{dist/components → components}/TableOfContents/types.d.ts +7 -0
- package/{dist/index.esm.js → index.esm.js} +86 -525
- package/{dist/index.js → index.js} +86 -525
- package/{dist/index.mjs → index.mjs} +86 -525
- 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/components/Docs/HttpOperation/LazySchemaTreePreviewer.d.ts +0 -34
- 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.stories.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpOperation/Badges.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpOperation/Callbacks.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/Parameters.d.ts +0 -0
- /package/{dist/components → components}/Docs/HttpOperation/Parameters.spec.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/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/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,955 +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
|
-
"$ref": "../../reference/common/models/error.v1.yaml"
|
|
156
|
-
}
|
|
157
|
-
```
|
|
158
|
-
|
|
159
|
-
## HTTP Try It Out
|
|
160
|
-
|
|
161
|
-
A smd http try it out block is a smd code block with the `http` language tag. The contents of the code fence should
|
|
162
|
-
be the http object to be rendered.
|
|
163
|
-
|
|
164
|
-
### Raw Http Request
|
|
165
|
-
|
|
166
|
-
<!-- type: http -->
|
|
167
|
-
|
|
168
|
-
```json
|
|
169
|
-
{
|
|
170
|
-
"method": "get",
|
|
171
|
-
"url": "/gifs/search",
|
|
172
|
-
"baseUrl": "http://api.giphy.com/v1",
|
|
173
|
-
"headers": {},
|
|
174
|
-
"query": {
|
|
175
|
-
"api_key": ["dc6zaTOxFJmzC"],
|
|
176
|
-
"limit": ["1"],
|
|
177
|
-
"q": ["cats"]
|
|
178
|
-
}
|
|
179
|
-
}
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
````md
|
|
183
|
-
<!-- type: http -->
|
|
184
|
-
|
|
185
|
-
```json
|
|
186
|
-
{
|
|
187
|
-
"method": "get",
|
|
188
|
-
"url": "/gifs/search",
|
|
189
|
-
"baseUrl": "http://api.giphy.com/v1",
|
|
190
|
-
"headers": {},
|
|
191
|
-
"query": {
|
|
192
|
-
"api_key": ["dc6zaTOxFJmzC"],
|
|
193
|
-
"limit": ["1"],
|
|
194
|
-
"q": ["cats"]
|
|
195
|
-
}
|
|
196
|
-
}
|
|
197
|
-
```
|
|
198
|
-
````
|
|
199
|
-
|
|
200
|
-
### Request from Http Operation
|
|
201
|
-
|
|
202
|
-
<!-- type: http -->
|
|
203
|
-
|
|
204
|
-
```json
|
|
205
|
-
{
|
|
206
|
-
"$ref": "../../reference/todos/openapi.v1.json/paths/~1todos/get"
|
|
207
|
-
}
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
````md
|
|
211
|
-
<!-- type: http -->
|
|
212
|
-
|
|
213
|
-
```json
|
|
214
|
-
{
|
|
215
|
-
"$ref": "../../reference/todos/openapi.v1.json/paths/~1todos/get"
|
|
216
|
-
}
|
|
217
|
-
```
|
|
218
|
-
````
|
|
219
|
-
|
|
220
|
-
### From a remote Http Operation
|
|
221
|
-
|
|
222
|
-
<!-- type: http -->
|
|
223
|
-
|
|
224
|
-
```json
|
|
225
|
-
{
|
|
226
|
-
"$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/giphy/giphy.yaml/paths/~1gifs~1search/get"
|
|
227
|
-
}
|
|
228
|
-
```
|
|
229
|
-
|
|
230
|
-
````md
|
|
231
|
-
<!-- type: http -->
|
|
232
|
-
|
|
233
|
-
```json
|
|
234
|
-
{
|
|
235
|
-
"$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/giphy/giphy.yaml/paths/~1gifs~1search/get"
|
|
236
|
-
}
|
|
237
|
-
```
|
|
238
|
-
````
|
|
239
|
-
|
|
240
|
-
## Raw HTML
|
|
241
|
-
|
|
242
|
-
```
|
|
243
|
-
<div>Hello world!</div>
|
|
244
|
-
```
|
|
245
|
-
|
|
246
|
-
<div>Hello world!</div>
|
|
247
|
-
|
|
248
|
-
## Inline Links
|
|
249
|
-
|
|
250
|
-
[foo], [foo][], [bar][foo].
|
|
251
|
-
|
|
252
|
-
[foo]: http://example.com 'Example Domain'
|
|
253
|
-
|
|
254
|
-
## The following will be repeated to mimic a long list of page headers
|
|
255
|
-
|
|
256
|
-
Here is a lot of information!
|
|
257
|
-
|
|
258
|
-
## Tabs
|
|
259
|
-
|
|
260
|
-
A smd tab container is a `tab` annotation, followed by the tab content, and closed by a final `tab-end` annotation.
|
|
261
|
-
|
|
262
|
-
Tab containers cannot be nested.
|
|
263
|
-
|
|
264
|
-
<!--
|
|
265
|
-
type: tab
|
|
266
|
-
title: My First Tab
|
|
267
|
-
-->
|
|
268
|
-
|
|
269
|
-
The contents of tab 1.
|
|
270
|
-
|
|
271
|
-
<!--
|
|
272
|
-
type: tab
|
|
273
|
-
title: My Second Tab
|
|
274
|
-
-->
|
|
275
|
-
|
|
276
|
-
The contents of tab 2.
|
|
277
|
-
|
|
278
|
-
<!-- type: tab-end -->
|
|
279
|
-
|
|
280
|
-
#### Markdown Sample
|
|
281
|
-
|
|
282
|
-
```md
|
|
283
|
-
<!--
|
|
284
|
-
type: tab
|
|
285
|
-
title: My First Tab
|
|
286
|
-
-->
|
|
287
|
-
|
|
288
|
-
The contents of tab 1.
|
|
289
|
-
|
|
290
|
-
<!--
|
|
291
|
-
type: tab
|
|
292
|
-
title: My Second Tab
|
|
293
|
-
-->
|
|
294
|
-
|
|
295
|
-
The contents of tab 2.
|
|
296
|
-
|
|
297
|
-
<!-- type: tab-end -->
|
|
298
|
-
```
|
|
299
|
-
|
|
300
|
-
## Callouts
|
|
301
|
-
|
|
302
|
-
A callout is a md block quote with an optional annotation that indicates intent.
|
|
303
|
-
|
|
304
|
-
<!-- theme: danger -->
|
|
305
|
-
|
|
306
|
-
> ### Danger Will Robinson!
|
|
307
|
-
>
|
|
308
|
-
> Here is my danger callout!
|
|
309
|
-
|
|
310
|
-
<!-- theme: warning -->
|
|
311
|
-
|
|
312
|
-
> ### Watch Out!
|
|
313
|
-
>
|
|
314
|
-
> Here is my warning callout!
|
|
315
|
-
|
|
316
|
-
<!-- theme: success -->
|
|
317
|
-
|
|
318
|
-
> ### Mission Accomplished!
|
|
319
|
-
>
|
|
320
|
-
> Here is my success callout!
|
|
321
|
-
|
|
322
|
-
<!-- theme: info -->
|
|
323
|
-
|
|
324
|
-
> ### A thing to know
|
|
325
|
-
>
|
|
326
|
-
> Here is my info callout
|
|
327
|
-
|
|
328
|
-
#### Markdown Sample
|
|
329
|
-
|
|
330
|
-
```md
|
|
331
|
-
<!-- theme: danger -->
|
|
332
|
-
|
|
333
|
-
> ### Danger Will Robinson!
|
|
334
|
-
>
|
|
335
|
-
> Here is my danger callout!
|
|
336
|
-
|
|
337
|
-
<!-- theme: warning -->
|
|
338
|
-
|
|
339
|
-
> ### Watch Out!
|
|
340
|
-
>
|
|
341
|
-
> Here is my warning callout!
|
|
342
|
-
|
|
343
|
-
<!-- theme: success -->
|
|
344
|
-
|
|
345
|
-
> ### Mission Accomplished!
|
|
346
|
-
>
|
|
347
|
-
> Here is my success callout!
|
|
348
|
-
|
|
349
|
-
<!-- theme: info -->
|
|
350
|
-
|
|
351
|
-
> ### A thing to know
|
|
352
|
-
>
|
|
353
|
-
> Here is my info callout
|
|
354
|
-
```
|
|
355
|
-
|
|
356
|
-
## Code Blocks
|
|
357
|
-
|
|
358
|
-
A smd code block is md code fence with an optional annotation to tweak the presentation of the code block.
|
|
359
|
-
|
|
360
|
-
<!--
|
|
361
|
-
title: "Fibonacci In Javascript"
|
|
362
|
-
lineNumbers: false
|
|
363
|
-
highlightLines: [[1,2], [4,5]]
|
|
364
|
-
-->
|
|
365
|
-
|
|
366
|
-
```javascript
|
|
367
|
-
function fibonacci(num) {
|
|
368
|
-
var a = 1,
|
|
369
|
-
b = 0,
|
|
370
|
-
temp;
|
|
371
|
-
|
|
372
|
-
while (num >= 0) {
|
|
373
|
-
temp = a;
|
|
374
|
-
a = a + b;
|
|
375
|
-
b = temp;
|
|
376
|
-
num--;
|
|
377
|
-
}
|
|
378
|
-
|
|
379
|
-
return b;
|
|
380
|
-
}
|
|
381
|
-
```
|
|
382
|
-
|
|
383
|
-
## JSON Schema
|
|
384
|
-
|
|
385
|
-
A smd json schema block is a smd code block with the `json_schema` language tag. The contents of the code fence should
|
|
386
|
-
be the json schema object to be rendered.
|
|
387
|
-
|
|
388
|
-
<!-- type: json_schema -->
|
|
389
|
-
|
|
390
|
-
```json
|
|
391
|
-
{
|
|
392
|
-
"$ref": "../../reference/common/models/error.v1.yaml"
|
|
393
|
-
}
|
|
394
|
-
```
|
|
395
|
-
|
|
396
|
-
## HTTP Try It Out
|
|
397
|
-
|
|
398
|
-
A smd http try it out block is a smd code block with the `http` language tag. The contents of the code fence should
|
|
399
|
-
be the http object to be rendered.
|
|
400
|
-
|
|
401
|
-
### Raw Http Request
|
|
402
|
-
|
|
403
|
-
<!-- type: http -->
|
|
404
|
-
|
|
405
|
-
```json
|
|
406
|
-
{
|
|
407
|
-
"method": "get",
|
|
408
|
-
"url": "/gifs/search",
|
|
409
|
-
"baseUrl": "http://api.giphy.com/v1",
|
|
410
|
-
"headers": {},
|
|
411
|
-
"query": {
|
|
412
|
-
"api_key": ["dc6zaTOxFJmzC"],
|
|
413
|
-
"limit": ["1"],
|
|
414
|
-
"q": ["cats"]
|
|
415
|
-
}
|
|
416
|
-
}
|
|
417
|
-
```
|
|
418
|
-
|
|
419
|
-
````md
|
|
420
|
-
<!-- type: http -->
|
|
421
|
-
|
|
422
|
-
```json
|
|
423
|
-
{
|
|
424
|
-
"method": "get",
|
|
425
|
-
"url": "/gifs/search",
|
|
426
|
-
"baseUrl": "http://api.giphy.com/v1",
|
|
427
|
-
"headers": {},
|
|
428
|
-
"query": {
|
|
429
|
-
"api_key": ["dc6zaTOxFJmzC"],
|
|
430
|
-
"limit": ["1"],
|
|
431
|
-
"q": ["cats"]
|
|
432
|
-
}
|
|
433
|
-
}
|
|
434
|
-
```
|
|
435
|
-
````
|
|
436
|
-
|
|
437
|
-
### Request from Http Operation
|
|
438
|
-
|
|
439
|
-
<!-- type: http -->
|
|
440
|
-
|
|
441
|
-
```json
|
|
442
|
-
{
|
|
443
|
-
"$ref": "../../reference/todos/openapi.v1.json/paths/~1todos/get"
|
|
444
|
-
}
|
|
445
|
-
```
|
|
446
|
-
|
|
447
|
-
````md
|
|
448
|
-
<!-- type: http -->
|
|
449
|
-
|
|
450
|
-
```json
|
|
451
|
-
{
|
|
452
|
-
"$ref": "../../reference/todos/openapi.v1.json/paths/~1todos/get"
|
|
453
|
-
}
|
|
454
|
-
```
|
|
455
|
-
````
|
|
456
|
-
|
|
457
|
-
### From a remote Http Operation
|
|
458
|
-
|
|
459
|
-
<!-- type: http -->
|
|
460
|
-
|
|
461
|
-
```json
|
|
462
|
-
{
|
|
463
|
-
"$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/giphy/giphy.yaml/paths/~1gifs~1search/get"
|
|
464
|
-
}
|
|
465
|
-
```
|
|
466
|
-
|
|
467
|
-
````md
|
|
468
|
-
<!-- type: http -->
|
|
469
|
-
|
|
470
|
-
```json
|
|
471
|
-
{
|
|
472
|
-
"$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/giphy/giphy.yaml/paths/~1gifs~1search/get"
|
|
473
|
-
}
|
|
474
|
-
```
|
|
475
|
-
````
|
|
476
|
-
|
|
477
|
-
## Raw HTML
|
|
478
|
-
|
|
479
|
-
```
|
|
480
|
-
<div>Hello world!</div>
|
|
481
|
-
```
|
|
482
|
-
|
|
483
|
-
<div>Hello world!</div>
|
|
484
|
-
|
|
485
|
-
## Inline Links
|
|
486
|
-
|
|
487
|
-
[foo], [foo][], [bar][foo].
|
|
488
|
-
|
|
489
|
-
[foo]: http://example.com 'Example Domain'
|
|
490
|
-
|
|
491
|
-
## Tabs
|
|
492
|
-
|
|
493
|
-
A smd tab container is a `tab` annotation, followed by the tab content, and closed by a final `tab-end` annotation.
|
|
494
|
-
|
|
495
|
-
Tab containers cannot be nested.
|
|
496
|
-
|
|
497
|
-
<!--
|
|
498
|
-
type: tab
|
|
499
|
-
title: My First Tab
|
|
500
|
-
-->
|
|
501
|
-
|
|
502
|
-
The contents of tab 1.
|
|
503
|
-
|
|
504
|
-
<!--
|
|
505
|
-
type: tab
|
|
506
|
-
title: My Second Tab
|
|
507
|
-
-->
|
|
508
|
-
|
|
509
|
-
The contents of tab 2.
|
|
510
|
-
|
|
511
|
-
<!-- type: tab-end -->
|
|
512
|
-
|
|
513
|
-
#### Markdown Sample
|
|
514
|
-
|
|
515
|
-
```md
|
|
516
|
-
<!--
|
|
517
|
-
type: tab
|
|
518
|
-
title: My First Tab
|
|
519
|
-
-->
|
|
520
|
-
|
|
521
|
-
The contents of tab 1.
|
|
522
|
-
|
|
523
|
-
<!--
|
|
524
|
-
type: tab
|
|
525
|
-
title: My Second Tab
|
|
526
|
-
-->
|
|
527
|
-
|
|
528
|
-
The contents of tab 2.
|
|
529
|
-
|
|
530
|
-
<!-- type: tab-end -->
|
|
531
|
-
```
|
|
532
|
-
|
|
533
|
-
## Callouts
|
|
534
|
-
|
|
535
|
-
A callout is a md block quote with an optional annotation that indicates intent.
|
|
536
|
-
|
|
537
|
-
<!-- theme: danger -->
|
|
538
|
-
|
|
539
|
-
> ### Danger Will Robinson!
|
|
540
|
-
>
|
|
541
|
-
> Here is my danger callout!
|
|
542
|
-
|
|
543
|
-
<!-- theme: warning -->
|
|
544
|
-
|
|
545
|
-
> ### Watch Out!
|
|
546
|
-
>
|
|
547
|
-
> Here is my warning callout!
|
|
548
|
-
|
|
549
|
-
<!-- theme: success -->
|
|
550
|
-
|
|
551
|
-
> ### Mission Accomplished!
|
|
552
|
-
>
|
|
553
|
-
> Here is my success callout!
|
|
554
|
-
|
|
555
|
-
<!-- theme: info -->
|
|
556
|
-
|
|
557
|
-
> ### A thing to know
|
|
558
|
-
>
|
|
559
|
-
> Here is my info callout
|
|
560
|
-
|
|
561
|
-
#### Markdown Sample
|
|
562
|
-
|
|
563
|
-
```md
|
|
564
|
-
<!-- theme: danger -->
|
|
565
|
-
|
|
566
|
-
> ### Danger Will Robinson!
|
|
567
|
-
>
|
|
568
|
-
> Here is my danger callout!
|
|
569
|
-
|
|
570
|
-
<!-- theme: warning -->
|
|
571
|
-
|
|
572
|
-
> ### Watch Out!
|
|
573
|
-
>
|
|
574
|
-
> Here is my warning callout!
|
|
575
|
-
|
|
576
|
-
<!-- theme: success -->
|
|
577
|
-
|
|
578
|
-
> ### Mission Accomplished!
|
|
579
|
-
>
|
|
580
|
-
> Here is my success callout!
|
|
581
|
-
|
|
582
|
-
<!-- theme: info -->
|
|
583
|
-
|
|
584
|
-
> ### A thing to know
|
|
585
|
-
>
|
|
586
|
-
> Here is my info callout
|
|
587
|
-
```
|
|
588
|
-
|
|
589
|
-
## Code Blocks
|
|
590
|
-
|
|
591
|
-
A smd code block is md code fence with an optional annotation to tweak the presentation of the code block.
|
|
592
|
-
|
|
593
|
-
<!--
|
|
594
|
-
title: "Fibonacci In Javascript"
|
|
595
|
-
lineNumbers: false
|
|
596
|
-
highlightLines: [[1,2], [4,5]]
|
|
597
|
-
-->
|
|
598
|
-
|
|
599
|
-
```javascript
|
|
600
|
-
function fibonacci(num) {
|
|
601
|
-
var a = 1,
|
|
602
|
-
b = 0,
|
|
603
|
-
temp;
|
|
604
|
-
|
|
605
|
-
while (num >= 0) {
|
|
606
|
-
temp = a;
|
|
607
|
-
a = a + b;
|
|
608
|
-
b = temp;
|
|
609
|
-
num--;
|
|
610
|
-
}
|
|
611
|
-
|
|
612
|
-
return b;
|
|
613
|
-
}
|
|
614
|
-
```
|
|
615
|
-
|
|
616
|
-
## JSON Schema
|
|
617
|
-
|
|
618
|
-
A smd json schema block is a smd code block with the `json_schema` language tag. The contents of the code fence should
|
|
619
|
-
be the json schema object to be rendered.
|
|
620
|
-
|
|
621
|
-
<!-- type: json_schema -->
|
|
622
|
-
|
|
623
|
-
```json
|
|
624
|
-
{
|
|
625
|
-
"$ref": "../../reference/common/models/error.v1.yaml"
|
|
626
|
-
}
|
|
627
|
-
```
|
|
628
|
-
|
|
629
|
-
## HTTP Try It Out
|
|
630
|
-
|
|
631
|
-
A smd http try it out block is a smd code block with the `http` language tag. The contents of the code fence should
|
|
632
|
-
be the http object to be rendered.
|
|
633
|
-
|
|
634
|
-
### Raw Http Request
|
|
635
|
-
|
|
636
|
-
<!-- type: http -->
|
|
637
|
-
|
|
638
|
-
```json
|
|
639
|
-
{
|
|
640
|
-
"method": "get",
|
|
641
|
-
"url": "/gifs/search",
|
|
642
|
-
"baseUrl": "http://api.giphy.com/v1",
|
|
643
|
-
"headers": {},
|
|
644
|
-
"query": {
|
|
645
|
-
"api_key": ["dc6zaTOxFJmzC"],
|
|
646
|
-
"limit": ["1"],
|
|
647
|
-
"q": ["cats"]
|
|
648
|
-
}
|
|
649
|
-
}
|
|
650
|
-
```
|
|
651
|
-
|
|
652
|
-
````md
|
|
653
|
-
<!-- type: http -->
|
|
654
|
-
|
|
655
|
-
```json
|
|
656
|
-
{
|
|
657
|
-
"method": "get",
|
|
658
|
-
"url": "/gifs/search",
|
|
659
|
-
"baseUrl": "http://api.giphy.com/v1",
|
|
660
|
-
"headers": {},
|
|
661
|
-
"query": {
|
|
662
|
-
"api_key": ["dc6zaTOxFJmzC"],
|
|
663
|
-
"limit": ["1"],
|
|
664
|
-
"q": ["cats"]
|
|
665
|
-
}
|
|
666
|
-
}
|
|
667
|
-
```
|
|
668
|
-
````
|
|
669
|
-
|
|
670
|
-
### Request from Http Operation
|
|
671
|
-
|
|
672
|
-
<!-- type: http -->
|
|
673
|
-
|
|
674
|
-
```json
|
|
675
|
-
{
|
|
676
|
-
"$ref": "../../reference/todos/openapi.v1.json/paths/~1todos/get"
|
|
677
|
-
}
|
|
678
|
-
```
|
|
679
|
-
|
|
680
|
-
````md
|
|
681
|
-
<!-- type: http -->
|
|
682
|
-
|
|
683
|
-
```json
|
|
684
|
-
{
|
|
685
|
-
"$ref": "../../reference/todos/openapi.v1.json/paths/~1todos/get"
|
|
686
|
-
}
|
|
687
|
-
```
|
|
688
|
-
````
|
|
689
|
-
|
|
690
|
-
### From a remote Http Operation
|
|
691
|
-
|
|
692
|
-
<!-- type: http -->
|
|
693
|
-
|
|
694
|
-
```json
|
|
695
|
-
{
|
|
696
|
-
"$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/giphy/giphy.yaml/paths/~1gifs~1search/get"
|
|
697
|
-
}
|
|
698
|
-
```
|
|
699
|
-
|
|
700
|
-
````md
|
|
701
|
-
<!-- type: http -->
|
|
702
|
-
|
|
703
|
-
```json
|
|
704
|
-
{
|
|
705
|
-
"$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/giphy/giphy.yaml/paths/~1gifs~1search/get"
|
|
706
|
-
}
|
|
707
|
-
```
|
|
708
|
-
````
|
|
709
|
-
|
|
710
|
-
## Raw HTML
|
|
711
|
-
|
|
712
|
-
```
|
|
713
|
-
<div>Hello world!</div>
|
|
714
|
-
```
|
|
715
|
-
|
|
716
|
-
<div>Hello world!</div>
|
|
717
|
-
|
|
718
|
-
## Inline Links
|
|
719
|
-
|
|
720
|
-
[foo], [foo][], [bar][foo].
|
|
721
|
-
|
|
722
|
-
[foo]: http://example.com 'Example Domain'
|
|
723
|
-
|
|
724
|
-
## Tabs
|
|
725
|
-
|
|
726
|
-
A smd tab container is a `tab` annotation, followed by the tab content, and closed by a final `tab-end` annotation.
|
|
727
|
-
|
|
728
|
-
Tab containers cannot be nested.
|
|
729
|
-
|
|
730
|
-
<!--
|
|
731
|
-
type: tab
|
|
732
|
-
title: My First Tab
|
|
733
|
-
-->
|
|
734
|
-
|
|
735
|
-
The contents of tab 1.
|
|
736
|
-
|
|
737
|
-
<!--
|
|
738
|
-
type: tab
|
|
739
|
-
title: My Second Tab
|
|
740
|
-
-->
|
|
741
|
-
|
|
742
|
-
The contents of tab 2.
|
|
743
|
-
|
|
744
|
-
<!-- type: tab-end -->
|
|
745
|
-
|
|
746
|
-
#### Markdown Sample
|
|
747
|
-
|
|
748
|
-
```md
|
|
749
|
-
<!--
|
|
750
|
-
type: tab
|
|
751
|
-
title: My First Tab
|
|
752
|
-
-->
|
|
753
|
-
|
|
754
|
-
The contents of tab 1.
|
|
755
|
-
|
|
756
|
-
<!--
|
|
757
|
-
type: tab
|
|
758
|
-
title: My Second Tab
|
|
759
|
-
-->
|
|
760
|
-
|
|
761
|
-
The contents of tab 2.
|
|
762
|
-
|
|
763
|
-
<!-- type: tab-end -->
|
|
764
|
-
```
|
|
765
|
-
|
|
766
|
-
## Callouts
|
|
767
|
-
|
|
768
|
-
A callout is a md block quote with an optional annotation that indicates intent.
|
|
769
|
-
|
|
770
|
-
<!-- theme: danger -->
|
|
771
|
-
|
|
772
|
-
> ### Danger Will Robinson!
|
|
773
|
-
>
|
|
774
|
-
> Here is my danger callout!
|
|
775
|
-
|
|
776
|
-
<!-- theme: warning -->
|
|
777
|
-
|
|
778
|
-
> ### Watch Out!
|
|
779
|
-
>
|
|
780
|
-
> Here is my warning callout!
|
|
781
|
-
|
|
782
|
-
<!-- theme: success -->
|
|
783
|
-
|
|
784
|
-
> ### Mission Accomplished!
|
|
785
|
-
>
|
|
786
|
-
> Here is my success callout!
|
|
787
|
-
|
|
788
|
-
<!-- theme: info -->
|
|
789
|
-
|
|
790
|
-
> ### A thing to know
|
|
791
|
-
>
|
|
792
|
-
> Here is my info callout
|
|
793
|
-
|
|
794
|
-
#### Markdown Sample
|
|
795
|
-
|
|
796
|
-
```md
|
|
797
|
-
<!-- theme: danger -->
|
|
798
|
-
|
|
799
|
-
> ### Danger Will Robinson!
|
|
800
|
-
>
|
|
801
|
-
> Here is my danger callout!
|
|
802
|
-
|
|
803
|
-
<!-- theme: warning -->
|
|
804
|
-
|
|
805
|
-
> ### Watch Out!
|
|
806
|
-
>
|
|
807
|
-
> Here is my warning callout!
|
|
808
|
-
|
|
809
|
-
<!-- theme: success -->
|
|
810
|
-
|
|
811
|
-
> ### Mission Accomplished!
|
|
812
|
-
>
|
|
813
|
-
> Here is my success callout!
|
|
814
|
-
|
|
815
|
-
<!-- theme: info -->
|
|
816
|
-
|
|
817
|
-
> ### A thing to know
|
|
818
|
-
>
|
|
819
|
-
> Here is my info callout
|
|
820
|
-
```
|
|
821
|
-
|
|
822
|
-
## Code Blocks
|
|
823
|
-
|
|
824
|
-
A smd code block is md code fence with an optional annotation to tweak the presentation of the code block.
|
|
825
|
-
|
|
826
|
-
<!--
|
|
827
|
-
title: "Fibonacci In Javascript"
|
|
828
|
-
lineNumbers: false
|
|
829
|
-
highlightLines: [[1,2], [4,5]]
|
|
830
|
-
-->
|
|
831
|
-
|
|
832
|
-
```javascript
|
|
833
|
-
function fibonacci(num) {
|
|
834
|
-
var a = 1,
|
|
835
|
-
b = 0,
|
|
836
|
-
temp;
|
|
837
|
-
|
|
838
|
-
while (num >= 0) {
|
|
839
|
-
temp = a;
|
|
840
|
-
a = a + b;
|
|
841
|
-
b = temp;
|
|
842
|
-
num--;
|
|
843
|
-
}
|
|
844
|
-
|
|
845
|
-
return b;
|
|
846
|
-
}
|
|
847
|
-
```
|
|
848
|
-
|
|
849
|
-
## JSON Schema
|
|
850
|
-
|
|
851
|
-
A smd json schema block is a smd code block with the `json_schema` language tag. The contents of the code fence should
|
|
852
|
-
be the json schema object to be rendered.
|
|
853
|
-
|
|
854
|
-
<!-- type: json_schema -->
|
|
855
|
-
|
|
856
|
-
```json
|
|
857
|
-
{
|
|
858
|
-
"$ref": "../../reference/common/models/error.v1.yaml"
|
|
859
|
-
}
|
|
860
|
-
```
|
|
861
|
-
|
|
862
|
-
## HTTP Try It Out
|
|
863
|
-
|
|
864
|
-
A smd http try it out block is a smd code block with the `http` language tag. The contents of the code fence should
|
|
865
|
-
be the http object to be rendered.
|
|
866
|
-
|
|
867
|
-
### Raw Http Request
|
|
868
|
-
|
|
869
|
-
<!-- type: http -->
|
|
870
|
-
|
|
871
|
-
```json
|
|
872
|
-
{
|
|
873
|
-
"method": "get",
|
|
874
|
-
"url": "/gifs/search",
|
|
875
|
-
"baseUrl": "http://api.giphy.com/v1",
|
|
876
|
-
"headers": {},
|
|
877
|
-
"query": {
|
|
878
|
-
"api_key": ["dc6zaTOxFJmzC"],
|
|
879
|
-
"limit": ["1"],
|
|
880
|
-
"q": ["cats"]
|
|
881
|
-
}
|
|
882
|
-
}
|
|
883
|
-
```
|
|
884
|
-
|
|
885
|
-
````md
|
|
886
|
-
<!-- type: http -->
|
|
887
|
-
|
|
888
|
-
```json
|
|
889
|
-
{
|
|
890
|
-
"method": "get",
|
|
891
|
-
"url": "/gifs/search",
|
|
892
|
-
"baseUrl": "http://api.giphy.com/v1",
|
|
893
|
-
"headers": {},
|
|
894
|
-
"query": {
|
|
895
|
-
"api_key": ["dc6zaTOxFJmzC"],
|
|
896
|
-
"limit": ["1"],
|
|
897
|
-
"q": ["cats"]
|
|
898
|
-
}
|
|
899
|
-
}
|
|
900
|
-
```
|
|
901
|
-
````
|
|
902
|
-
|
|
903
|
-
### Request from Http Operation
|
|
904
|
-
|
|
905
|
-
<!-- type: http -->
|
|
906
|
-
|
|
907
|
-
```json
|
|
908
|
-
{
|
|
909
|
-
"$ref": "../../reference/todos/openapi.v1.json/paths/~1todos/get"
|
|
910
|
-
}
|
|
911
|
-
```
|
|
912
|
-
|
|
913
|
-
````md
|
|
914
|
-
<!-- type: http -->
|
|
915
|
-
|
|
916
|
-
```json
|
|
917
|
-
{
|
|
918
|
-
"$ref": "../../reference/todos/openapi.v1.json/paths/~1todos/get"
|
|
919
|
-
}
|
|
920
|
-
```
|
|
921
|
-
````
|
|
922
|
-
|
|
923
|
-
### From a remote Http Operation
|
|
924
|
-
|
|
925
|
-
<!-- type: http -->
|
|
926
|
-
|
|
927
|
-
```json
|
|
928
|
-
{
|
|
929
|
-
"$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/giphy/giphy.yaml/paths/~1gifs~1search/get"
|
|
930
|
-
}
|
|
931
|
-
```
|
|
932
|
-
|
|
933
|
-
````md
|
|
934
|
-
<!-- type: http -->
|
|
935
|
-
|
|
936
|
-
```json
|
|
937
|
-
{
|
|
938
|
-
"$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/giphy/giphy.yaml/paths/~1gifs~1search/get"
|
|
939
|
-
}
|
|
940
|
-
```
|
|
941
|
-
````
|
|
942
|
-
|
|
943
|
-
## Raw HTML
|
|
944
|
-
|
|
945
|
-
```
|
|
946
|
-
<div>Hello world!</div>
|
|
947
|
-
```
|
|
948
|
-
|
|
949
|
-
<div>Hello world!</div>
|
|
950
|
-
|
|
951
|
-
## Inline Links
|
|
952
|
-
|
|
953
|
-
[foo], [foo][], [bar][foo].
|
|
954
|
-
|
|
955
|
-
[foo]: http://example.com 'Example Domain'
|