influxdata
diff --git a/‎.gitignore
Lines changed: 2 additions & 0 deletions b/‎.gitignore
Lines changed: 2 additions & 0 deletions
diff --git a/‎api-docs/cloud/v2/ref.yml
Lines changed: 9 additions & 16 deletions b/‎api-docs/cloud/v2/ref.yml
Lines changed: 9 additions & 16 deletions
diff --git a/‎api-docs/getswagger.sh
Lines changed: 53 additions & 37 deletions b/‎api-docs/getswagger.sh
Lines changed: 53 additions & 37 deletions
diff --git a/‎api-docs/package.json
Lines changed: 2 additions & 1 deletion b/‎api-docs/package.json
Lines changed: 2 additions & 1 deletion
diff --git a/‎api-docs/scripts/generate-openapi-articles.js
Lines changed: 79 additions & 0 deletions b/‎api-docs/scripts/generate-openapi-articles.js
Lines changed: 79 additions & 0 deletions
diff --git a/‎api-docs/scripts/openapi-paths-to-hugo-data/cli.js
Lines changed: 62 additions & 0 deletions b/‎api-docs/scripts/openapi-paths-to-hugo-data/cli.js
Lines changed: 62 additions & 0 deletions
@@ -10,6 +10,8 @@ node_modules
 .hugo_build.lock
 /content/influxdb/*/api/**/*.html
 /api-docs/redoc-static.html*
+/content/influxdb/*/api/**
+/static/openapi
 .vscode/*
 .idea
 **/config.toml
 
@@ -12,14 +12,7 @@ info:
     url: https://opensource.org/licenses/MIT
   summary: The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2.
 servers:
-  - url: https://{baseurl}
-    description: InfluxDB Cloud API URL
-    variables:
-      baseurl:
-        enum:
-          - us-east-1-1.aws.cloud2.influxdata.com
-        default: us-east-1-1.aws.cloud2.influxdata.com
-        description: InfluxDB Cloud URL
+  - url: /
 security:
   - TokenAuthentication: []
 tags:
@@ -14600,9 +14593,9 @@ components:
       properties:
         results:
           description: |
-              A resultset object that contains the `statement_id` and the `series` array.
+            A resultset object that contains the `statement_id` and the `series` array.
 
-              Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
+            Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
           items:
             properties:
               error:
@@ -14651,12 +14644,12 @@ components:
                 type: integer
             type: object
           oneOf:
-          - required:
-            - statement_id
-            - error
-          - required:
-            - statement_id
-            - series
+            - required:
+                - statement_id
+                - error
+            - required:
+                - statement_id
+                - series
           type: array
       type: object
     IntegerLiteral:
 
@@ -21,10 +21,13 @@
 #   sh ./getswagger.sh -c <product> -o <version> -B
 #
 # Examples:
-#   sh ./getswagger.sh cloud-serverless
+#   sh ./getswagger.sh cloud-serverless-v2
 #   sh ./getswagger.sh clustered -B
-#   sh ./getswagger.sh cloud
-#   sh ./getswagger.sh -c v2 -o v2.0 -b file:///Users/johnsmith/github/openapi
+#   sh ./getswagger.sh cloud-v2
+#   sh ./getswagger.sh -c oss-v2 -b file:///Users/johnsmith/github/openapi
+
+DOCS_ROOT=$(git rev-parse --show-toplevel)
+API_DOCS_ROOT=$DOCS_ROOT/api-docs
 
 versionDirs=($(ls -d */))
 latestOSS=${versionDirs[${#versionDirs[@]}-1]}
@@ -62,7 +65,7 @@ function showHelp {
 subcommand=$1
 
 case "$subcommand" in
-  cloud-dedicated-v2|cloud-dedicated-management|cloud-serverless-v2|clustered-v2|cloud-v2|v2|v1-compat|all)
+  cloud-dedicated-v2|cloud-dedicated-management|cloud-serverless-v2|clustered-v2|cloud-v2|oss-v2|v2|v1-compat|all)
     product=$1
     shift
 
@@ -117,7 +120,6 @@ function postProcess() {
   api="$3"
 
   openapiCLI=" @redocly/cli"
-  currentPath=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 
   # TODO: Move some of this into the plugin:
 
@@ -131,101 +133,112 @@ function postProcess() {
   npx --version
   INFLUXDB_PRODUCT=$(dirname "$configPath") \
   INFLUXDB_API_NAME=$(echo "$api" | sed 's/@.*//g;') \
-  API_DOCS_ROOT_PATH=$currentPath \
+  API_DOCS_ROOT_PATH=$API_DOCS_ROOT \
   npm_config_yes=true \
   npx $openapiCLI bundle $specPath \
     -o $specPath \
     --config=$configPath
 }
 
- function updateCloudV2 {
-  outFile="cloud/v2/ref.yml"
+function updateOSS {
+  outFile="$API_DOCS_ROOT/v2/ref.yml"
+  if [[ -z "$baseUrlOSS" ]];
+  then
+    echo "No URL was provided. I'll rebuild from the existing spec $outFile"
+  else
+    curl $UPDATE_OPTIONS ${baseUrlOSS}/contracts/ref/oss.yml -o $outFile
+  fi
+  postProcess $outFile "$API_DOCS_ROOT/v2/.config.yml" '@2'
+}
+
+function updateCloudV2 {
+  outFile="$API_DOCS_ROOT/cloud/v2/ref.yml"
   if [[ -z "$baseUrl" ]];
   then
-    echo "Using existing $outFile"
+    echo "No URL was provided. I'll rebuild from the existing spec $outFile"
   else
     curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile
   fi
-  postProcess $outFile 'cloud/.config.yml' v2@2
+  postProcess $outFile "$API_DOCS_ROOT/cloud/.config.yml" v2@2
 }
 
 function updateCloudDedicatedManagement {
-  outFile="cloud-dedicated/management/openapi.yml"
+  outFile="$API_DOCS_ROOT/cloud-dedicated/management/openapi.yml"
   if [[ -z "$baseUrl" ]];
   then
-    echo "Using existing $outFile"
+    echo "No URL was provided. I'll rebuild from the existing spec $outFile"
   else
     curl $UPDATE_OPTIONS https://raw.githubusercontent.com/influxdata/granite/ab7ee2aceacfae7f415d15ffbcf8c9d0f6f3e015/openapi.yaml -o $outFile
   fi
-  postProcess $outFile 'cloud-dedicated/.config.yml' management@0
+  postProcess $outFile "$API_DOCS_ROOT/cloud-dedicated/.config.yml" management@0
 }
 
 function updateCloudDedicatedV2 {
-  outFile="cloud-dedicated/v2/ref.yml"
+  outFile="$API_DOCS_ROOT/cloud-dedicated/v2/ref.yml"
   if [[ -z "$baseUrl" ]];
   then
-    echo "Using existing $outFile"
+    echo "No URL was provided. I'll rebuild from the existing spec $outFile"
   else
     curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile
   fi
- postProcess $outFile 'cloud-dedicated/.config.yml' v2@2
+ postProcess $outFile "$API_DOCS_ROOT/cloud-dedicated/.config.yml" v2@2
 }
 
 function updateClusteredV2 {
-  outFile="clustered/v2/ref.yml"
+  outFile="$API_DOCS_ROOT/clustered/v2/ref.yml"
   if [[ -z "$baseUrl" ]];
   then
-    echo "Using existing $outFile"
+    echo "No URL was provided. I'll rebuild from the existing spec $outFile"
   else
     curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile
   fi
- postProcess $outFile 'clustered/.config.yml' v2@2
+ postProcess $outFile "$API_DOCS_ROOT/clustered/.config.yml" v2@2
 }
 
 function updateCloudServerlessV2 {
-  outFile="cloud-serverless/v2/ref.yml"
+  outFile="$API_DOCS_ROOT/cloud-serverless/v2/ref.yml"
   if [[ -z "$baseUrl" ]];
   then
-    echo "Using existing $outFile"
+    echo "No URL was provided. I'll rebuild from the existing spec $outFile"
   else
     curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile
   fi
-  postProcess $outFile 'cloud-serverless/.config.yml' v2@2
+  postProcess $outFile "$API_DOCS_ROOT/cloud-serverless/.config.yml" v2@2
 }
 
 function updateOSSV2 {
-  outFile="v2/ref.yml"
+  outFile="$API_DOCS_ROOT/v2/ref.yml"
   if [[ -z "$baseUrlOSS" ]];
   then
-    echo "Using existing $outFile"
+    echo "No URL was provided. I'll rebuild from the existing spec $outFile"
   else
     curl $UPDATE_OPTIONS ${baseUrlOSS}/contracts/ref/oss.yml -o $outFile
   fi
-  postProcess $outFile 'v2/.config.yml' '@2'
+  postProcess $outFile "$API_DOCS_ROOT/v2/.config.yml" '@2'
 }
 
-function updateV1Compat {
-  outFile="cloud/v1-compatibility/swaggerV1Compat.yml"
+function updateV1Compat { 
+  outFile="$API_DOCS_ROOT/cloud/v1-compatibility/swaggerV1Compat.yml"
   if [[ -z "$baseUrl" ]];
   then
-    echo "Using existing $outFile"
+    echo "No URL was provided. I'll rebuild from the existing spec $outFile"
   else
   curl $UPDATE_OPTIONS ${baseUrl}/contracts/swaggerV1Compat.yml -o $outFile
   fi
-  postProcess $outFile 'cloud/.config.yml' 'v1-compatibility'
+  postProcess $outFile "$API_DOCS_ROOT/cloud/.config.yml" 'v1-compatibility'
 
-  outFile="v2/v1-compatibility/swaggerV1Compat.yml"
+  outFile="$API_DOCS_ROOT/v2/v1-compatibility/swaggerV1Compat.yml"
   cp cloud/v1-compatibility/swaggerV1Compat.yml $outFile
-  postProcess $outFile 'v2/.config.yml' 'v1-compatibility'
+  postProcess $outFile "$API_DOCS_ROOT/v2/.config.yml" 'v1-compatibility'
 
-  outFile="cloud-dedicated/v1-compatibility/swaggerV1Compat.yml"
-  postProcess $outFile 'cloud-dedicated/.config.yml' 'v1-compatibility'
+  outFile="$API_DOCS_ROOT/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml"
+  postProcess $outFile "$API_DOCS_ROOT/cloud-dedicated/.config.yml" 'v1-compatibility'
 
-  outFile="cloud-serverless/v1-compatibility/swaggerV1Compat.yml"
-  postProcess $outFile 'cloud-serverless/.config.yml' 'v1-compatibility'
+  outFile="$API_DOCS_ROOT/cloud-serverless/v1-compatibility/swaggerV1Compat.yml"
+  postProcess $outFile "$API_DOCS_ROOT/cloud-serverless/.config.yml" 'v1-compatibility'
 
-  outFile="clustered/v1-compatibility/swaggerV1Compat.yml"
-  postProcess $outFile 'clustered/.config.yml' 'v1-compatibility'
+  outFile="$API_DOCS_ROOT/clustered/v1-compatibility/swaggerV1Compat.yml"
+  postProcess $outFile "$API_DOCS_ROOT/clustered/.config.yml" 'v1-compatibility'
 }
 
 UPDATE_OPTIONS="--fail"
@@ -252,6 +265,9 @@ then
 elif [ "$product" = "clustered-v2" ];
 then
   updateClusteredV2
+elif [ "$product" = "oss-v2" ];
+then
+  updateOSSV2
 elif [ "$product" = "v2" ];
 then
   updateOSSV2
 
@@ -5,6 +5,7 @@
   "description": "InfluxDB API documentation",
   "license": "MIT",
   "dependencies": {
-    "js-yaml": "^4.1.0"
+    "js-yaml": "^4.1.0",
+    "hugo-data-to-pages": "file:../hugo-data-to-pages/hugo.js"
   }
 }
@@ -0,0 +1,79 @@
+const { execSync } = require('child_process');
+const path = require('path');
+const fs = require('fs');
+const openapiPathsToHugo = require('./openapi-paths-to-hugo-data/index.js');
+
+// Calculate the relative paths
+const DOCS_ROOT = '.';
+const API_DOCS_ROOT = 'api-docs';
+
+// Function to execute shell commands
+const execCommand = (command) => {
+  try {
+    console.log(`Executing: ${command}`);
+    execSync(command, { stdio: 'inherit' });
+  } catch (error) {
+    console.error(`Error executing command: ${command}`);
+    process.exit(1);
+  }
+};
+
+
+
+// Function to generate data from OpenAPI
+function generateDataFromOpenAPI(specFile, dataOutPath, articleOutPath) {
+  if (!fs.existsSync(dataOutPath)) {
+    fs.mkdirSync(dataOutPath, { recursive: true });
+  }
+
+  openapiPathsToHugo.generateHugoData({
+    dataOutPath,
+    articleOutPath,
+    specFile
+  });
+};
+
+// Example usage of generateDataFromOpenAPI function
+// generateDataFromOpenAPI('path/to/openapi-file.yml', 'path/to/paths-output-folder', 'path/to/metadata-output-folder');
+
+function generatePagesFromArticleData(articlesPath, contentPath) {
+  execCommand(
+    `HUGO_DATAPAGES_DATA_PATH=${articlesPath} \
+    HUGO_DATAPAGES_ELEMENT=articles \
+    HUGO_DATAPAGES_TYPE=api \
+    HUGO_DATAPAGES_CONTENT_PATH=${contentPath} \
+    node ${path.join(DOCS_ROOT, '/hugo-data-to-pages/hugo.js')} clean --force`
+  )
+  execCommand(
+    `HUGO_DATAPAGES_DATA_PATH=${articlesPath} \
+    HUGO_DATAPAGES_ELEMENT=articles \
+    HUGO_DATAPAGES_TYPE=api \
+    HUGO_DATAPAGES_CONTENT_PATH=${contentPath} \
+    node ${path.join(DOCS_ROOT, '/hugo-data-to-pages/hugo.js')} generate`
+  )
+}
+
+const api_reference_paths = {
+  'cloud-v2': {
+    spec_file: path.join(API_DOCS_ROOT, '/cloud/v2/ref.yml'),
+    pages_dir: path.join(DOCS_ROOT, '/content/influxdb/cloud/api/v2'),
+  },
+  'oss-v2': {
+    spec_file: path.join(API_DOCS_ROOT, '/v2/ref.yml'),
+    pages_dir: path.join(DOCS_ROOT, '/content/influxdb/v2/api/v2'),
+  }
+}
+
+Object.keys(api_reference_paths).forEach((key) => {
+  const api = api_reference_paths[key];
+  const staticPath = path.join(DOCS_ROOT, '/static/openapi');
+  const staticSpecPath = path.join(staticPath, `/influxdb-${key}.yml`);
+  const staticPathsPath = path.join(staticPath, `/influxdb-${key}/paths`);
+  const articlesPath = path.join(DOCS_ROOT, `/data/article-data/influxdb/${key}`);
+  // Execute the getswagger.sh script
+  execCommand(`${path.join(API_DOCS_ROOT, 'getswagger.sh')} ${key} -B`);
+  // Copy the generated OpenAPI spec to the static folder
+  fs.copyFileSync(api.spec_file, staticSpecPath);
+  generateDataFromOpenAPI(api.spec_file, staticPathsPath, articlesPath);
+  generatePagesFromArticleData(articlesPath, api.pages_dir);
+});
@@ -0,0 +1,62 @@
+const path = require('path');
+const argparse = require('argparse');
+const openapiPathsToHugo = require('./index.js');
+
+const cli = new argparse.ArgumentParser({
+  prog:  'openapi-docs',
+  add_help: true
+});
+
+cli.add_argument('--hugo', {
+  help:   'Generate Hugo data from OpenAPI paths',
+  dest:   'generateHugoData'
+});
+
+cli.add_argument('-d', '--data-output', {
+  help:   'Filepath where generated OpenAPI data output will be written.',
+  dest:   'dataOutPath'
+});
+
+cli.add_argument('-o', '--article-data-output', {
+  help:   'Filepath where generated article metadata output will be written.',
+  dest:   'articleOutPath'
+});
+
+cli.add_argument('-pre', '--path-prefix', {
+  help:   'A path to use as the prefix for the path property in each generated article.',
+  dest:   'pathPrefix'
+});
+
+cli.add_argument('file', {
+  help:   'File to read, utf-8 encoded without BOM',
+  nargs:  '?',
+  default: '-'
+});
+
+
+////////////////////////////////////////////////////////////////////////////////
+
+
+var options = cli.parse_args();
+
+
+/* Usage examples
+ * 
+ node ./openapi-paths-to-hugo-data/index.js \
+  ./data/influxdb/cloud/openapi.yaml \
+  -d ./data/influxdb/cloud/path-apis \
+  -o ./data/article-data/influxdb/cloud
+
+ node ./openapi-paths-to-hugo-data/index.js \
+   ./data/influxdb/oss/openapi.yaml \
+   -d ./data/influxdb/oss/path-apis \
+   -o ./data/article-data/influxdb/oss
+ *
+ */
+
+////////////////////////////////////////////////////////////////////////////////
+
+
+if (options.generateHugoData) {
+  openapiPathsToHugo.generateHugoData(options);
+}
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`"description": "InfluxDB API documentation",`
`6`	`6`	`"license": "MIT",`
`7`	`7`	`"dependencies": {`
`8`		`- "js-yaml": "^4.1.0"`
	`8`	`+ "js-yaml": "^4.1.0",`
	`9`	`+ "hugo-data-to-pages": "file:../hugo-data-to-pages/hugo.js"`
`9`	`10`	`}`
`10`	`11`	`}`