Fix CI OpenAPI verification

Author: gildesmarais

.github/workflows/ci.yml

@@ -26,7 +26,6 @@ jobs:
 
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version-file: ".tool-versions"
           bundler-cache: true
 
       - name: Run RuboCop
@@ -53,7 +52,6 @@ jobs:
 
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version-file: ".tool-versions"
           bundler-cache: true
 
       - name: Setup Node.js for OpenAPI lint tooling
@@ -122,7 +120,6 @@ jobs:
 
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version-file: ".tool-versions"
           bundler-cache: true
 
       - name: Setup Node.js for Docker smoke test

docs/api/v1/openapi.yaml

@@ -20,6 +20,7 @@ paths:
     get:
       description: API metadata
       operationId: getApiMetadata
+      parameters: []
       responses:
         '200':
           content:
@@ -66,7 +67,7 @@ paths:
                 - success
                 - data
                 type: object
-          description: returns instance feed-creation capability
+          description: returns API information with trailing slash
       security: []
       summary: API metadata
       tags:
@@ -110,6 +111,8 @@ paths:
                             type: string
                           id:
                             type: string
+                          json_public_url:
+                            type: string
                           name:
                             type: string
                           public_url:
@@ -127,6 +130,7 @@ paths:
                         - strategy
                         - feed_token
                         - public_url
+                        - json_public_url
                         - created_at
                         - updated_at
                         type: object
@@ -317,7 +321,8 @@ paths:
                 - success
                 - data
                 type: object
-          description: returns health status when token is valid
+          description: returns health status when the configured environment token
+            is valid
         '401':
           content:
             application/json:

frontend/package.json

@@ -12,7 +12,7 @@
     "format:check": "prettier --check .",
     "typecheck": "tsc -p tsconfig.typecheck.json --noEmit",
     "openapi:generate": "openapi-ts -i ../docs/api/v1/openapi.yaml -o src/api/generated -c @hey-api/client-fetch",
-    "openapi:verify": "npm run openapi:generate && git diff --exit-code -- src/api/generated",
+    "openapi:verify": "openapi-ts -i ../docs/api/v1/openapi.yaml -o src/api/generated -c @hey-api/client-fetch && git diff --exit-code -- src/api/generated",
     "test": "vitest",
     "test:run": "vitest run",
     "test:unit": "vitest run --reporter=verbose --config vitest.unit.config.ts",

frontend/src/api/generated/types.gen.ts

@@ -13,7 +13,7 @@ export type GetApiMetadataData = {
 
 export type GetApiMetadataResponses = {
     /**
-     * returns instance feed-creation capability
+     * returns API information with trailing slash
      */
     200: {
         data: {
@@ -172,7 +172,7 @@ export type GetHealthStatusError = GetHealthStatusErrors[keyof GetHealthStatusEr
 
 export type GetHealthStatusResponses = {
     /**
-     * returns health status when token is valid
+     * returns health status when the configured environment token is valid
      */
     200: {
         data: {

spec/spec_helper.rb

@@ -13,7 +13,7 @@
 
     track_files '**/*.rb'
 
-    minimum_coverage 80
+    minimum_coverage 80 unless ENV['OPENAPI']
     maximum_coverage_drop 5
   end
 end