chore: add yaml spec

Author: mrlubos

.github/workflows/ci.yaml

@@ -22,9 +22,18 @@ jobs:
         with:
           node-version: 20
 
-      - name: Upload OpenAPI spec
-        id: upload-openapi-spec
+      - name: Upload JSON OpenAPI spec
+        id: upload-json-openapi-spec
         uses: ./
         with:
+          dry-run: true
           hey-api-token: ${{ secrets.HEY_API_TOKEN }}
           path-to-openapi: ./openapi.json
+
+      - name: Upload YAML OpenAPI spec
+        id: upload-yaml-openapi-spec
+        uses: ./
+        with:
+          dry-run: true
+          hey-api-token: ${{ secrets.HEY_API_TOKEN }}
+          path-to-openapi: ./openapi.yaml

action.yaml

@@ -7,6 +7,9 @@ branding:
   color: red
 
 inputs:
+  dry-run:
+    description: Run action in dry run mode
+    required: false
   hey-api-token:
     description: Hey API service token
     required: true

dist/index.js

@@ -0,0 +1,119 @@
+openapi: '3.0.0'
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+servers:
+  - url: http://petstore.swagger.io/v1
+paths:
+  /pets:
+    get:
+      summary: List all pets
+      operationId: listPets
+      tags:
+        - pets
+      parameters:
+        - name: limit
+          in: query
+          description: How many items to return at one time (max 100)
+          required: false
+          schema:
+            type: integer
+            maximum: 100
+            format: int32
+      responses:
+        '200':
+          description: A paged array of pets
+          headers:
+            x-next:
+              description: A link to the next page of responses
+              schema:
+                type: string
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pets'
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+        - pets
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Pet'
+        required: true
+      responses:
+        '201':
+          description: Null response
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+  /pets/{petId}:
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+        - pets
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          description: The id of the pet to retrieve
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Expected response to a valid request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pet'
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+components:
+  schemas:
+    Pet:
+      type: object
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+    Pets:
+      type: array
+      maxItems: 100
+      items:
+        $ref: '#/components/schemas/Pet'
+    Error:
+      type: object
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string

dist/index.js.map

@@ -7,6 +7,10 @@ import { upload } from './upload'
  */
 export async function run(): Promise<void> {
   try {
+    const dryRun: boolean =
+      core.getInput('dry-run', {
+        required: false
+      }) === 'true'
     const heyApiToken: string = core.getInput('hey-api-token', {
       required: true
     })
@@ -17,9 +21,11 @@ export async function run(): Promise<void> {
     core.debug(`Path to OpenAPI: ${pathToOpenApi}`)
 
     core.debug(`Upload started: ${new Date().toTimeString()}`)
-    await upload(pathToOpenApi, heyApiToken)
+    await upload(pathToOpenApi, heyApiToken, dryRun)
     core.debug(`Upload completed: ${new Date().toTimeString()}`)
   } catch (error) {
-    if (error instanceof Error) core.setFailed(error.message)
+    if (error instanceof Error) {
+      core.setFailed(error.message)
+    }
   }
 }

openapi.yaml

@@ -8,24 +8,36 @@ import { readFileSync } from 'node:fs'
  */
 export async function upload(
   pathToOpenApi: string,
-  heyApiToken: string
+  heyApiToken: string,
+  dryRun?: boolean
 ): Promise<void> {
   return new Promise(async resolve => {
-    // TODO: throw if path is invalid
     if (!pathToOpenApi) {
-      throw new Error('OpenAPI path is invalid')
+      throw new Error('invalid OpenAPI path')
     }
 
-    const data = readFileSync(pathToOpenApi)
+    let data: Buffer
+    try {
+      data = readFileSync(pathToOpenApi)
+    } catch (error) {
+      throw new Error('invalid OpenAPI path')
+    }
+
+    let formData = [
+      [encodeURIComponent('openapi'), encodeURIComponent(data.toString())]
+    ]
+
+    if (dryRun) {
+      formData = [
+        ...formData,
+        [encodeURIComponent('dry-run'), encodeURIComponent(dryRun)]
+      ]
+    }
 
-    const body = [
-      encodeURIComponent('openapi'),
-      encodeURIComponent(data.toString())
-    ].join('=')
+    const body = formData.flatMap(arr => arr.join('=')).join('&')
 
     const response = await fetch(
-      // 'https://platform-production-25fb.up.railway.app/api/openapi',
-      'https://platform-platform-pr-10.up.railway.app/api/openapi',
+      'https://platform-production-25fb.up.railway.app/api/openapi',
       {
         body,
         headers: {
@@ -37,7 +49,8 @@ export async function upload(
     )
 
     if (response.status >= 300) {
-      throw new Error(JSON.stringify(response.json()))
+      const error = await response.json()
+      throw new Error(JSON.stringify(error))
     }
 
     resolve()