OpenAPI Preview Tool
- {`Please use the input form on this page to upload your spec. After submitting the form, the page should reload and display a preview.`}
+ {`Please use the input form on this page to upload your spec. After submitting the form, the page should reload and display a preview. For security reasons, after around an hour, your submitted file will be deleted the next time this page is loaded. You will need to re-submit your spec if you're working with this tool for longer than an hour.`}
+
+
+ {`This page may appear unexpectedly after navigation rather the expected preview content due to differences in how this preview tool works relative to production contexts. Reloading the page may resolve the issue. If reloading the page doesn't do anything, you may need to re-submit your spec file. If you're experiencing frequent issues requiring page reloads, reach out in #team-web-support in Slack.`}
diff --git a/src/views/open-api-docs-preview-v2/server.ts b/src/views/open-api-docs-preview-v2/server.ts
index 687bb1adad..28b3d02ee1 100644
--- a/src/views/open-api-docs-preview-v2/server.ts
+++ b/src/views/open-api-docs-preview-v2/server.ts
@@ -27,7 +27,7 @@ const IS_PRODUCTION = process.env.VERCEL_ENV === 'production'
* where NextJS decides to start on a different port (eg if 3000 is in use),
* but I couldn't find a way to detect that, and for now, this seems sufficient.
*/
-const IS_VERCEL_DEPLOY = process.env.VERCEL_ENV !== 'development'
+const IS_VERCEL_DEPLOY = typeof process.env.VERCEL_ENV === 'string'
const BASE_URL = IS_VERCEL_DEPLOY
? `https://${process.env.VERCEL_URL}`
: 'http://localhost:3000'
diff --git a/src/views/open-api-docs-preview-v2/utils/get-props-from-preview-data.ts b/src/views/open-api-docs-preview-v2/utils/get-props-from-preview-data.ts
index 40f7c6c8a3..2701fb4077 100644
--- a/src/views/open-api-docs-preview-v2/utils/get-props-from-preview-data.ts
+++ b/src/views/open-api-docs-preview-v2/utils/get-props-from-preview-data.ts
@@ -4,8 +4,14 @@
*/
import { getStaticProps } from 'views/open-api-docs-view-v2/server'
+// Utils
+import { getOperationGroupKeyFromPath } from 'views/open-api-docs-view-v2/utils/get-operation-group-key-from-path'
+import { schemaTransformShortenHcp } from 'views/open-api-docs-view-v2/schema-transforms/schema-transform-shorten-hcp'
// Types
-import type { OpenApiDocsViewV2Props } from 'views/open-api-docs-view-v2/types'
+import type {
+ OpenApiDocsViewV2Props,
+ OpenApiDocsViewV2Config,
+} from 'views/open-api-docs-view-v2/types'
import type { OpenApiPreviewV2InputValues } from '../components/open-api-preview-inputs'
/**
@@ -28,10 +34,44 @@ export default async function getPropsFromPreviewData(
if (!previewData) {
return null
}
- // Use the incoming preview data to generate static props for the view
- return await getStaticProps({
+ // Set up transformers for the spec. Typically we want to avoid these,
+ // and prefer to have content updates made at the content source... but
+ // some shims are used often enough that they feel worth including in the
+ // preview too. Namely, shortening to `HCP` in the spec title.
+ const schemaTransforms = [schemaTransformShortenHcp]
+ // Build page configuration based on the input values
+ const pageConfig: OpenApiDocsViewV2Config = {
basePath: '/open-api-docs-preview-v2',
operationSlug,
openApiJsonString: previewData.openApiJsonString,
- })
+ schemaTransforms,
+ // A generic set of resource links, as a preview of what typically
+ // gets added to an OpenAPI docs page.
+ resourceLinks: [
+ {
+ text: 'Tutorial Library',
+ href: '/tutorials/library',
+ },
+ {
+ text: 'Certifications',
+ href: '/certifications',
+ },
+ {
+ text: 'Community',
+ href: 'https://discuss.hashicorp.com/',
+ },
+ {
+ text: 'Support',
+ href: 'https://www.hashicorp.com/customer-success',
+ },
+ ],
+ }
+ // If the user has requested to group operations by path, we'll do so
+ // by providing a custom `getOperationGroupKey` function. If this is omitted,
+ // we go with the default behaviour of grouping operations based on `tag`.
+ if (previewData.groupOperationsByPath) {
+ pageConfig.getOperationGroupKey = getOperationGroupKeyFromPath
+ }
+ // Use the page config to generate static props for the view
+ return await getStaticProps(pageConfig)
}
diff --git a/src/views/open-api-docs-view-v2/components/sidebar-link-external/index.tsx b/src/views/open-api-docs-view-v2/components/sidebar-link-external/index.tsx
new file mode 100644
index 0000000000..c0f8df4396
--- /dev/null
+++ b/src/views/open-api-docs-view-v2/components/sidebar-link-external/index.tsx
@@ -0,0 +1,49 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+// Components
+import { IconExternalLink16 } from '@hashicorp/flight-icons/svg-react/external-link-16'
+import { SidebarLink, SidebarLinkText } from '../sidebar-link'
+// Types
+import type { PropsWithChildren } from 'react'
+// Styles
+import s from './style.module.css'
+
+/**
+ * Render a SidebarLink with an external link icon.
+ */
+export function SidebarLinkExternal({
+ href,
+ children,
+}: PropsWithChildren<{
+ href: string
+}>) {
+ return (
+