chore: add tags argument

Author: mrlubos

.github/workflows/ci.yaml

@@ -30,6 +30,7 @@ jobs:
           # dry-run: true
           hey-api-token: ${{ secrets.HEY_API_TOKEN }}
           path-to-openapi: ./openapi.json
+          tags: dev
 
       - name: Upload YAML OpenAPI spec
         id: upload-yaml-openapi-spec
@@ -39,3 +40,4 @@ jobs:
           # dry-run: true
           hey-api-token: ${{ secrets.HEY_API_TOKEN }}
           path-to-openapi: ./openapi.yaml
+          tags: dev

action.yml

@@ -16,6 +16,9 @@ inputs:
   path-to-openapi:
     description: Input path to your OpenAPI specification file
     required: true
+  tags:
+    description: Custom specification tags
+    required: false
 name: Upload OpenAPI spec by Hey API 👋
 runs:
   main: dist/index.js

dist/index.js

@@ -20,14 +20,18 @@ export async function run(): Promise<void> {
     const pathToOpenApi: string = core.getInput('path-to-openapi', {
       required: true
     })
+    const tags: string = core.getInput('tags', {
+      required: false
+    })
 
     core.debug(`Path to OpenAPI: ${pathToOpenApi}`)
     core.debug(`Upload started: ${new Date().toTimeString()}`)
     await upload({
       baseUrl,
       dryRun,
       heyApiToken,
-      pathToOpenApi
+      pathToOpenApi,
+      tags
     })
     core.debug(`Upload completed: ${new Date().toTimeString()}`)
   } catch (error) {

dist/index.js.map

@@ -8,9 +8,16 @@ export async function upload({
   baseUrl = 'https://platform-production-25fb.up.railway.app',
   dryRun,
   heyApiToken,
-  pathToOpenApi
+  pathToOpenApi,
+  tags
 }: {
+  /**
+   * Custom service url.
+   */
   baseUrl?: string
+  /**
+   * Return mock response?
+   */
   dryRun?: boolean
   /**
    * Hey API token.
@@ -20,6 +27,10 @@ export async function upload({
    * Path to the OpenAPI specification file.
    */
   pathToOpenApi: string
+  /**
+   * Custom specification tags.
+   */
+  tags?: string
 }): Promise<void> {
   if (!pathToOpenApi) {
     throw new Error('invalid OpenAPI path')
@@ -102,6 +113,10 @@ export async function upload({
     path.basename(pathToOpenApi)
   )
 
+  if (tags) {
+    formData.append('tags', tags)
+  }
+
   if (process.env.GITHUB_WORKFLOW) {
     formData.append('workflow', process.env.GITHUB_WORKFLOW)
   }