Rename new OpenAPI view to remove v2

hashicorp · Nov 21, 2024 · d318a79 · d318a79
1 parent 6c30dcb
commit d318a79
Show file tree

Hide file tree

Showing 75 changed files with 193 additions and 196 deletions.
diff --git a/src/pages/boundary/api-docs/[[...page]].tsx b/src/pages/boundary/api-docs/[[...page]].tsx
@@ -4,11 +4,11 @@
  */
 
 // View
-import OpenApiDocsViewV2 from 'views/open-api-docs-view-v2'
+import OpenApiDocsView from 'views/open-api-docs-view'
 import {
 	generateStaticPaths,
 	generateStaticPropsVersioned,
-} from 'views/open-api-docs-view-v2/server'
+} from 'views/open-api-docs-view/server'
 // Utils
 import { isDeployPreview } from 'lib/env-checks'
 // Types
@@ -18,10 +18,10 @@ import type {
 	GetStaticPropsContext,
 } from 'next'
 import type {
-	OpenApiDocsV2Params,
-	OpenApiDocsViewV2Props,
-	OpenApiDocsViewV2Config,
-} from 'views/open-api-docs-view-v2/types'
+	OpenApiDocsParams,
+	OpenApiDocsViewProps,
+	OpenApiDocsViewConfig,
+} from 'views/open-api-docs-view/types'
 import type { ApiDocsVersionData } from 'lib/api-docs/types'
 
 /**
@@ -73,7 +73,7 @@ function getVersionData(): ApiDocsVersionData[] {
  * Configure this OpenAPI spec page, specifying the source,
  * and additional configuration that doesn't fit in the schema itself.
  */
-const PAGE_CONFIG: OpenApiDocsViewV2Config = {
+const PAGE_CONFIG: OpenApiDocsViewConfig = {
 	basePath: BASE_PATH,
 	breadcrumbLinksPrefix: [
 		{
@@ -92,7 +92,7 @@ const PAGE_CONFIG: OpenApiDocsViewV2Config = {
 /**
  * Get static paths, using the configured `schemaSource`.
  */
-export const getStaticPaths: GetStaticPaths<OpenApiDocsV2Params> = async () => {
+export const getStaticPaths: GetStaticPaths<OpenApiDocsParams> = async () => {
 	return await generateStaticPaths({
 		schemaSource: PAGE_CONFIG.schemaSource,
 		schemaTransforms: PAGE_CONFIG.schemaTransforms,
@@ -103,10 +103,10 @@ export const getStaticPaths: GetStaticPaths<OpenApiDocsV2Params> = async () => {
  * Get static paths, using the configured `schemaSource`.
  */
 export const getStaticProps: GetStaticProps<
-	OpenApiDocsViewV2Props,
-	OpenApiDocsV2Params
-> = async ({ params }: GetStaticPropsContext<OpenApiDocsV2Params>) => {
+	OpenApiDocsViewProps,
+	OpenApiDocsParams
+> = async ({ params }: GetStaticPropsContext<OpenApiDocsParams>) => {
 	return await generateStaticPropsVersioned(PAGE_CONFIG, params?.page)
 }
 
-export default OpenApiDocsViewV2
+export default OpenApiDocsView
diff --git a/src/pages/hcp/api-docs/consul/[[...page]].tsx b/src/pages/hcp/api-docs/consul/[[...page]].tsx
@@ -4,33 +4,33 @@
  */
 
 // View
-import OpenApiDocsViewV2 from 'views/open-api-docs-view-v2'
+import OpenApiDocsView from 'views/open-api-docs-view'
 import {
 	generateStaticPaths,
 	generateStaticPropsVersioned,
-} from 'views/open-api-docs-view-v2/server'
+} from 'views/open-api-docs-view/server'
 // Schema transforms
-import { schemaTransformShortenHcp } from 'views/open-api-docs-view-v2/schema-transforms/schema-transform-shorten-hcp'
-import { schemaTransformComponent } from 'views/open-api-docs-view-v2/schema-transforms/schema-transform-component'
-import { shortenProtobufAnyDescription } from 'views/open-api-docs-view-v2/schema-transforms/shorten-protobuf-any-description'
+import { schemaTransformShortenHcp } from 'views/open-api-docs-view/schema-transforms/schema-transform-shorten-hcp'
+import { schemaTransformComponent } from 'views/open-api-docs-view/schema-transforms/schema-transform-component'
+import { shortenProtobufAnyDescription } from 'views/open-api-docs-view/schema-transforms/shorten-protobuf-any-description'
 // Types
 import type {
 	GetStaticPaths,
 	GetStaticProps,
 	GetStaticPropsContext,
 } from 'next'
 import type {
-	OpenApiDocsV2Params,
-	OpenApiDocsViewV2Props,
-	OpenApiDocsViewV2Config,
-} from 'views/open-api-docs-view-v2/types'
+	OpenApiDocsParams,
+	OpenApiDocsViewProps,
+	OpenApiDocsViewConfig,
+} from 'views/open-api-docs-view/types'
 import type { ApiDocsVersionData } from 'lib/api-docs/types'
 
 /**
  * Configure this OpenAPI spec page, specifying the source,
  * and additional configuration that doesn't fit in the schema itself.
  */
-const PAGE_CONFIG: OpenApiDocsViewV2Config = {
+const PAGE_CONFIG: OpenApiDocsViewConfig = {
 	backToLink: {
 		href: '/hcp',
 		text: 'HashiCorp Cloud Platform',
@@ -117,7 +117,7 @@ function filterVersionData(
 /**
  * Get static paths, using the configured `schemaSource`.
  */
-export const getStaticPaths: GetStaticPaths<OpenApiDocsV2Params> = async () => {
+export const getStaticPaths: GetStaticPaths<OpenApiDocsParams> = async () => {
 	return await generateStaticPaths({
 		schemaSource: PAGE_CONFIG.schemaSource,
 		schemaTransforms: PAGE_CONFIG.schemaTransforms,
@@ -129,13 +129,13 @@ export const getStaticPaths: GetStaticPaths<OpenApiDocsV2Params> = async () => {
  * Get static paths, using the configured `schemaSource`.
  */
 export const getStaticProps: GetStaticProps<
-	OpenApiDocsViewV2Props,
-	OpenApiDocsV2Params
-> = async ({ params }: GetStaticPropsContext<OpenApiDocsV2Params>) => {
+	OpenApiDocsViewProps,
+	OpenApiDocsParams
+> = async ({ params }: GetStaticPropsContext<OpenApiDocsParams>) => {
 	return await generateStaticPropsVersioned(
 		{ ...PAGE_CONFIG, transformVersionData: filterVersionData },
 		params?.page
 	)
 }
 
-export default OpenApiDocsViewV2
+export default OpenApiDocsView
diff --git a/src/pages/hcp/api-docs/identity/[[...page]].tsx b/src/pages/hcp/api-docs/identity/[[...page]].tsx
@@ -4,34 +4,34 @@
  */
 
 // View
-import OpenApiDocsViewV2 from 'views/open-api-docs-view-v2'
+import OpenApiDocsView from 'views/open-api-docs-view'
 import {
 	generateStaticPaths,
 	generateStaticPropsVersioned,
-} from 'views/open-api-docs-view-v2/server'
+} from 'views/open-api-docs-view/server'
 // Utils
-import { getOperationGroupKeyFromPath } from 'views/open-api-docs-view-v2/utils/get-operation-group-key-from-path'
+import { getOperationGroupKeyFromPath } from 'views/open-api-docs-view/utils/get-operation-group-key-from-path'
 // Schema transforms
-import { schemaTransformShortenHcp } from 'views/open-api-docs-view-v2/schema-transforms/schema-transform-shorten-hcp'
-import { schemaTransformComponent } from 'views/open-api-docs-view-v2/schema-transforms/schema-transform-component'
-import { shortenProtobufAnyDescription } from 'views/open-api-docs-view-v2/schema-transforms/shorten-protobuf-any-description'
+import { schemaTransformShortenHcp } from 'views/open-api-docs-view/schema-transforms/schema-transform-shorten-hcp'
+import { schemaTransformComponent } from 'views/open-api-docs-view/schema-transforms/schema-transform-component'
+import { shortenProtobufAnyDescription } from 'views/open-api-docs-view/schema-transforms/shorten-protobuf-any-description'
 // Types
 import type {
 	GetStaticPaths,
 	GetStaticProps,
 	GetStaticPropsContext,
 } from 'next'
 import type {
-	OpenApiDocsV2Params,
-	OpenApiDocsViewV2Props,
-	OpenApiDocsViewV2Config,
-} from 'views/open-api-docs-view-v2/types'
+	OpenApiDocsParams,
+	OpenApiDocsViewProps,
+	OpenApiDocsViewConfig,
+} from 'views/open-api-docs-view/types'
 
 /**
  * Configure this OpenAPI spec page, specifying the source,
  * and additional configuration that doesn't fit in the schema itself.
  */
-const PAGE_CONFIG: OpenApiDocsViewV2Config = {
+const PAGE_CONFIG: OpenApiDocsViewConfig = {
 	backToLink: {
 		href: '/hcp',
 		text: 'HashiCorp Cloud Platform',
@@ -99,7 +99,7 @@ const PAGE_CONFIG: OpenApiDocsViewV2Config = {
 /**
  * Get static paths, using the configured `schemaSource`.
  */
-export const getStaticPaths: GetStaticPaths<OpenApiDocsV2Params> = async () => {
+export const getStaticPaths: GetStaticPaths<OpenApiDocsParams> = async () => {
 	return await generateStaticPaths({
 		schemaSource: PAGE_CONFIG.schemaSource,
 		schemaTransforms: PAGE_CONFIG.schemaTransforms,
@@ -110,10 +110,10 @@ export const getStaticPaths: GetStaticPaths<OpenApiDocsV2Params> = async () => {
  * Get static paths, using the configured `schemaSource`.
  */
 export const getStaticProps: GetStaticProps<
-	OpenApiDocsViewV2Props,
-	OpenApiDocsV2Params
-> = async ({ params }: GetStaticPropsContext<OpenApiDocsV2Params>) => {
+	OpenApiDocsViewProps,
+	OpenApiDocsParams
+> = async ({ params }: GetStaticPropsContext<OpenApiDocsParams>) => {
 	return await generateStaticPropsVersioned(PAGE_CONFIG, params?.page)
 }
 
-export default OpenApiDocsViewV2
+export default OpenApiDocsView
diff --git a/src/pages/hcp/api-docs/packer/[[...page]].tsx b/src/pages/hcp/api-docs/packer/[[...page]].tsx
@@ -4,32 +4,32 @@
  */
 
 // View
-import OpenApiDocsViewV2 from 'views/open-api-docs-view-v2'
+import OpenApiDocsView from 'views/open-api-docs-view'
 import {
 	generateStaticPaths,
 	generateStaticPropsVersioned,
-} from 'views/open-api-docs-view-v2/server'
+} from 'views/open-api-docs-view/server'
 // Schema transforms
-import { schemaTransformShortenHcp } from 'views/open-api-docs-view-v2/schema-transforms/schema-transform-shorten-hcp'
-import { schemaTransformComponent } from 'views/open-api-docs-view-v2/schema-transforms/schema-transform-component'
-import { shortenProtobufAnyDescription } from 'views/open-api-docs-view-v2/schema-transforms/shorten-protobuf-any-description'
+import { schemaTransformShortenHcp } from 'views/open-api-docs-view/schema-transforms/schema-transform-shorten-hcp'
+import { schemaTransformComponent } from 'views/open-api-docs-view/schema-transforms/schema-transform-component'
+import { shortenProtobufAnyDescription } from 'views/open-api-docs-view/schema-transforms/shorten-protobuf-any-description'
 // Types
 import type {
 	GetStaticPaths,
 	GetStaticProps,
 	GetStaticPropsContext,
 } from 'next'
 import type {
-	OpenApiDocsV2Params,
-	OpenApiDocsViewV2Props,
-	OpenApiDocsViewV2Config,
-} from 'views/open-api-docs-view-v2/types'
+	OpenApiDocsParams,
+	OpenApiDocsViewProps,
+	OpenApiDocsViewConfig,
+} from 'views/open-api-docs-view/types'
 
 /**
  * Configure this OpenAPI spec page, specifying the source,
  * and additional configuration that doesn't fit in the schema itself.
  */
-const PAGE_CONFIG: OpenApiDocsViewV2Config = {
+const PAGE_CONFIG: OpenApiDocsViewConfig = {
 	backToLink: {
 		href: '/hcp',
 		text: 'HashiCorp Cloud Platform',
@@ -101,7 +101,7 @@ const PAGE_CONFIG: OpenApiDocsViewV2Config = {
 /**
  * Get static paths, using the configured `schemaSource`.
  */
-export const getStaticPaths: GetStaticPaths<OpenApiDocsV2Params> = async () => {
+export const getStaticPaths: GetStaticPaths<OpenApiDocsParams> = async () => {
 	return await generateStaticPaths({
 		schemaSource: PAGE_CONFIG.schemaSource,
 		schemaTransforms: PAGE_CONFIG.schemaTransforms,
@@ -112,10 +112,10 @@ export const getStaticPaths: GetStaticPaths<OpenApiDocsV2Params> = async () => {
  * Get static paths, using the configured `schemaSource`.
  */
 export const getStaticProps: GetStaticProps<
-	OpenApiDocsViewV2Props,
-	OpenApiDocsV2Params
-> = async ({ params }: GetStaticPropsContext<OpenApiDocsV2Params>) => {
+	OpenApiDocsViewProps,
+	OpenApiDocsParams
+> = async ({ params }: GetStaticPropsContext<OpenApiDocsParams>) => {
 	return await generateStaticPropsVersioned(PAGE_CONFIG, params?.page)
 }
 
-export default OpenApiDocsViewV2
+export default OpenApiDocsView
diff --git a/src/pages/hcp/api-docs/vagrant-box-registry/[[...page]].tsx b/src/pages/hcp/api-docs/vagrant-box-registry/[[...page]].tsx
@@ -4,34 +4,34 @@
  */
 
 // View
-import OpenApiDocsViewV2 from 'views/open-api-docs-view-v2'
+import OpenApiDocsView from 'views/open-api-docs-view'
 import {
 	generateStaticPaths,
 	generateStaticPropsVersioned,
-} from 'views/open-api-docs-view-v2/server'
+} from 'views/open-api-docs-view/server'
 // Utils
-import { getOperationGroupKeyFromPath } from 'views/open-api-docs-view-v2/utils/get-operation-group-key-from-path'
+import { getOperationGroupKeyFromPath } from 'views/open-api-docs-view/utils/get-operation-group-key-from-path'
 // Schema transforms
-import { schemaTransformShortenHcp } from 'views/open-api-docs-view-v2/schema-transforms/schema-transform-shorten-hcp'
-import { schemaTransformComponent } from 'views/open-api-docs-view-v2/schema-transforms/schema-transform-component'
-import { shortenProtobufAnyDescription } from 'views/open-api-docs-view-v2/schema-transforms/shorten-protobuf-any-description'
+import { schemaTransformShortenHcp } from 'views/open-api-docs-view/schema-transforms/schema-transform-shorten-hcp'
+import { schemaTransformComponent } from 'views/open-api-docs-view/schema-transforms/schema-transform-component'
+import { shortenProtobufAnyDescription } from 'views/open-api-docs-view/schema-transforms/shorten-protobuf-any-description'
 // Types
 import type {
 	GetStaticPaths,
 	GetStaticProps,
 	GetStaticPropsContext,
 } from 'next'
 import type {
-	OpenApiDocsV2Params,
-	OpenApiDocsViewV2Props,
-	OpenApiDocsViewV2Config,
-} from 'views/open-api-docs-view-v2/types'
+	OpenApiDocsParams,
+	OpenApiDocsViewProps,
+	OpenApiDocsViewConfig,
+} from 'views/open-api-docs-view/types'
 
 /**
  * Configure this OpenAPI spec page, specifying the source,
  * and additional configuration that doesn't fit in the schema itself.
  */
-const PAGE_CONFIG: OpenApiDocsViewV2Config = {
+const PAGE_CONFIG: OpenApiDocsViewConfig = {
 	backToLink: {
 		href: '/hcp',
 		text: 'HashiCorp Cloud Platform',
@@ -104,7 +104,7 @@ const PAGE_CONFIG: OpenApiDocsViewV2Config = {
 /**
  * Get static paths, using the configured `schemaSource`.
  */
-export const getStaticPaths: GetStaticPaths<OpenApiDocsV2Params> = async () => {
+export const getStaticPaths: GetStaticPaths<OpenApiDocsParams> = async () => {
 	return await generateStaticPaths({
 		schemaSource: PAGE_CONFIG.schemaSource,
 		schemaTransforms: PAGE_CONFIG.schemaTransforms,
@@ -115,10 +115,10 @@ export const getStaticPaths: GetStaticPaths<OpenApiDocsV2Params> = async () => {
  * Get static paths, using the configured `schemaSource`.
  */
 export const getStaticProps: GetStaticProps<
-	OpenApiDocsViewV2Props,
-	OpenApiDocsV2Params
-> = async ({ params }: GetStaticPropsContext<OpenApiDocsV2Params>) => {
+	OpenApiDocsViewProps,
+	OpenApiDocsParams
+> = async ({ params }: GetStaticPropsContext<OpenApiDocsParams>) => {
 	return await generateStaticPropsVersioned(PAGE_CONFIG, params?.page)
 }
 
-export default OpenApiDocsViewV2
+export default OpenApiDocsView