feat: lint OpenAPI as GHA

instill-ai · Dec 19, 2023 · 1838883 · 1838883
1 parent 3e161d1
commit 1838883
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/.github/workflows/buf-check.yaml → .github/workflows/lint.yaml b/.github/workflows/buf-check.yaml → .github/workflows/lint.yaml
@@ -1,15 +1,20 @@
-name: Check buf
+name: Lint
 
 on:
   pull_request:
 
 jobs:
-  check-buf:
+  Lint definitions:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: bufbuild/buf-setup-action@v1
       - uses: bufbuild/buf-lint-action@v1
-      - uses: bufbuild/buf-breaking-action@v1
+      - name: "Lint: proto"
+        uses: bufbuild/buf-breaking-action@v1
         with:
           against: "https://github.com/instill-ai/protobufs.git#branch=main,ref=HEAD~1"
+      - name: "Lint: openapi"
+        uses: mhiew/redoc-lint-github-action@v3
+        with:
+          args: "openapiv2/openapiv2.swagger.yaml"
diff --git a/common/openapi/v1beta/options.proto b/common/openapi/v1beta/options.proto
@@ -8,6 +8,7 @@ import "protoc-gen-openapiv2/options/annotations.proto";
 option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
   info: {
     title: "Instill AI API";
+    description: "Interface definitions for the Instill AI endpoints exposed over HTTP";
     version: "0.4-beta";
     contact: {
       name: "Instill AI";

diff --git a/openapiv2/openapiv2.swagger.yaml b/openapiv2/openapiv2.swagger.yaml
@@ -1,6 +1,7 @@
 swagger: "2.0"
 info:
   title: Instill AI API
+  description: Interface definitions for the Instill AI endpoints exposed over HTTP
   version: 0.4-beta
   contact:
     name: Instill AI