chore: clean up HCP Vault Secrets OpenAPI work post-launch (#2153)

* chore: lift up api-docs utils to lib

* refactor: clean up PageConfig for new template

* chore: clean up now-unused flag

config/base.json

@@ -37,7 +37,6 @@
 	},
 	"flags": {
 		"enable_datadog": true,
-		"enable_io_beta_cta": true,
-		"enable_hcp_vault_secrets_api_docs_revision": false
+		"enable_io_beta_cta": true
 	}
 }

config/development.json

@@ -8,8 +8,5 @@
 	},
 	"learn": {
 		"max_static_paths": 1
-	},
-	"flags": {
-		"enable_hcp_vault_secrets_api_docs_revision": true
 	}
 }

config/preview.json

@@ -2,8 +2,5 @@
 	"extends": "base",
 	"io_sites": {
 		"max_static_paths": 10
-	},
-	"flags": {
-		"enable_hcp_vault_secrets_api_docs_revision": true
 	}
 }

config/production.json

@@ -14,8 +14,5 @@
 			"idp_url": "https://auth.idp.hashicorp.com"
 		},
 		"product_slugs_with_integrations": ["vault", "waypoint", "nomad", "packer"]
-	},
-	"flags": {
-		"enable_hcp_vault_secrets_api_docs_revision": true
 	}
 }

src/views/api-docs-view/utils/fetch-cloud-api-version-data/fetch-json-files-from-github-dir.ts → src/lib/api-docs/fetch-cloud-api-version-data/fetch-json-files-from-github-dir.ts

@@ -4,8 +4,8 @@
  */
 
 import path from 'path'
-import { fetchFileTreeFromGithub } from './fetch-file-tree-from-github'
-import type { FileTreeEntry, GithubDir } from './fetch-file-tree-from-github'
+import { fetchGithubFileTree } from 'lib/fetch-github-file-tree'
+import type { FileTreeEntry, GithubDir } from 'lib/fetch-github-file-tree'
 
 /**
  * Given the details of a remote directory on GitHub,
@@ -20,7 +20,7 @@ import type { FileTreeEntry, GithubDir } from './fetch-file-tree-from-github'
 export async function getJsonFilesFromGithubDir(
 	githubDir: GithubDir
 ): Promise<FileTreeEntry[]> {
-	const gitTree = await fetchFileTreeFromGithub(githubDir, { recursive: true })
+	const gitTree = await fetchGithubFileTree(githubDir, { recursive: true })
 	// Filter the data.tree for .json files
 	const jsonFiles = gitTree.filter((entry: FileTreeEntry) => {
 		// .json files will be blobs, filter out non-blobs

src/views/api-docs-view/utils/fetch-cloud-api-version-data/index.ts → src/lib/api-docs/fetch-cloud-api-version-data/index.ts

@@ -5,10 +5,10 @@
 
 import path from 'path'
 import { getJsonFilesFromGithubDir } from './fetch-json-files-from-github-dir'
-// Types
-import type { FileTreeEntry, GithubDir } from './fetch-file-tree-from-github'
-import type { ApiDocsVersionData } from '../../types'
 import { sortDateVersionData } from '../sort-date-version-data'
+// Types
+import type { FileTreeEntry, GithubDir } from '../../fetch-github-file-tree'
+import type { ApiDocsVersionData } from '../types'
 
 /**
  * Extract a `versionId` from a cloud API docs spec file path.

src/views/api-docs-view/utils/find-latest-stable-version.ts → src/lib/api-docs/find-latest-stable-version.ts

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
-import { ApiDocsVersionData } from '../types'
+import { ApiDocsVersionData } from './types'
 import { sortDateVersionData } from './sort-date-version-data'
 
 /**

src/lib/api-docs/index.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+export { fetchCloudApiVersionData } from './fetch-cloud-api-version-data'
+export { findLatestStableVersion } from './find-latest-stable-version'
+export { sortDateVersionData } from './sort-date-version-data'

src/views/api-docs-view/utils/sort-date-version-data.ts → src/lib/api-docs/sort-date-version-data.ts

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
-import { ApiDocsVersionData } from '../types'
+import { ApiDocsVersionData } from './types'
 
 /**
  * Sort version data in descending order.

src/lib/api-docs/types.ts

@@ -0,0 +1,13 @@
+import { GithubFile } from 'lib/fetch-github-file'
+
+/**
+ * A type to describe versioned API docs source files.
+ */
+export interface ApiDocsVersionData {
+	// A unique id for this version, used to construct URL paths for example
+	versionId: string
+	// The release stage of this version of the API docs
+	releaseStage?: string // typically 'stable' | 'preview'
+	// The schema file we'll load and render into the page for this version
+	targetFile: GithubFile | string
+}

src/views/api-docs-view/utils/fetch-cloud-api-version-data/fetch-file-tree-from-github.ts → src/lib/fetch-github-file-tree.ts

@@ -4,7 +4,7 @@
  */
 
 import { Octokit } from '@octokit/core'
-import { buildQueryStringSuffix } from './build-query-string-suffix'
+import { buildQueryStringSuffix } from './api-docs/fetch-cloud-api-version-data/build-query-string-suffix'
 
 /**
  * Initialize octokit.
@@ -40,7 +40,7 @@ export interface FileTreeEntry {
  * If the remote directory cannot be successfully fetched, or the resulting
  * response does not contain a file tree, this function throws an error.
  */
-export async function fetchFileTreeFromGithub(
+export async function fetchGithubFileTree(
 	githubDir: GithubDir,
 	options: { recursive?: boolean } = {}
 ): Promise<FileTreeEntry[]> {

src/pages/hcp/api-docs/packer/[[...page]].tsx

@@ -3,6 +3,8 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
+// Global
+import { fetchCloudApiVersionData } from 'lib/api-docs'
 // View
 import ApiDocsView from 'views/api-docs-view'
 import {
@@ -11,7 +13,6 @@ import {
 	ApiDocsParams,
 } from 'views/api-docs-view/server'
 import { buildApiDocsBreadcrumbs } from 'views/api-docs-view/server/get-api-docs-static-props/utils'
-import { fetchCloudApiVersionData } from 'views/api-docs-view/utils'
 // Components
 import {
 	PathTruncationAside,