Merge pull request #8 from fabiante/feat/api-linting

.github/workflows/test.yml

@@ -7,16 +7,18 @@ on:
     branches: [ "master" ]
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
         go-version: '1.21'
-    - name: Lint
+    - name: Lint Code
       run: go vet -v ./...
+    - name: Lint API Spec
+      run: npx @redocly/cli lint api/openapi.yml
     - name: Test
       run: go test -v ./...
     - name: Build

api/openapi.yml

@@ -3,6 +3,8 @@ info:
   title: PersURL
   description: Application to manage and resolve [PURL](https://en.wikipedia.org/wiki/Persistent_uniform_resource_locator) links.
   version: v1
+  license:
+    name: MIT
 
 servers:
   - url: "http://localhost"
@@ -13,6 +15,8 @@ tags:
   - name: Admin
     description: Manage PURLs
 
+security: []
+
 paths:
   /r/{domain}/{name}:
     get:

redocly.yml

@@ -0,0 +1,8 @@
+extends:
+  - recommended
+
+rules:
+  # Service is designed to sometimes respond only with 3xx and 4xx responses.
+  operation-2xx-response: off
+  # It should be enough to state the license name. The git repository is the source of truth here.
+  info-license-url: off