spec updates (#25)

* wokring on specup

* update spec

* fix

.github/workflows/ci.yml

@@ -46,6 +46,15 @@ jobs:
       - name: Install Mage
         run: go install github.com/magefile/mage
 
+      - name: Check if swagger is up to date
+        if: ${{ github.ref != 'refs/heads/main' }}
+        run: |
+          mage -v spec
+          if (git diff --shortstat | grep '[0-9]'); then \
+          echo "Swagger spec is out of date. Please run mage spec"; \
+          exit 1;
+          fi
+
       - name: Build
         run: mage build
 

.github/workflows/render-spec.yml

@@ -0,0 +1,29 @@
+name: render-spec
+on:
+  push:
+    branches:
+      - main
+jobs:
+  build-and-deploy-spec:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./spec
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+
+      - name: Install and Build 🔧
+        run: |
+          npm install
+          npm run build
+
+      - name: Deploy
+        uses: peaceiris/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build
+          allow_empty_commit: true
+          force_orphan: true

.gitignore

@@ -143,4 +143,8 @@ dist
 
 .DS_STORE
 .idea
-*.db
+*.db
+
+# spec stuff
+spec/build
+spec/node_modules

impl/docs/overrides.swaggo

@@ -0,0 +1,2 @@
+replace    cryptosuite.LDKeyType string
+replace    cryptosuite.SignatureType string

impl/docs/swagger.yaml

@@ -52,7 +52,7 @@ paths:
             type: string
       summary: GetRecord a PKARR record from the DHT
       tags:
-      - Relay
+      - PKARR
     put:
       consumes:
       - application/octet-stream
@@ -84,7 +84,7 @@ paths:
             type: string
       summary: PutRecord a PKARR record into the DHT
       tags:
-      - Relay
+      - PKARR
   /health:
     get:
       consumes:

impl/magefile.go

@@ -118,8 +118,7 @@ func Spec() error {
 		return err
 	}
 
-	// We need to enable dependencies because many of our external API objects have ssi-sdk objects.
-	return sh.Run(swagCommand, "init", "-g", "cmd/main.go", "--pd", "--parseInternal", "-ot", "go,yaml")
+	return sh.Run(swagCommand, "init", "-g", "cmd/main.go", "--overridesFile", "docs/overrides.swaggo", "--pd", "--parseInternal", "-ot", "go,yaml")
 }
 
 func ColorizeTestOutput(w io.Writer) io.Writer {

impl/pkg/storage/storage.go

@@ -115,8 +115,7 @@ func (s *Storage) ReadAll(namespace string) (map[string][]byte, error) {
 	err := s.db.View(func(tx *bolt.Tx) error {
 		bucket := tx.Bucket([]byte(namespace))
 		if bucket == nil {
-			errMsg := fmt.Sprintf("namespace<%s> does not exist", namespace)
-			logrus.Error(errMsg)
+			logrus.Warnf("namespace<%s> does not exist", namespace)
 			return nil
 		}
 		cursor := bucket.Cursor()
@@ -133,9 +132,8 @@ func (s *Storage) ReadAllKeys(namespace string) ([]string, error) {
 	err := s.db.View(func(tx *bolt.Tx) error {
 		bucket := tx.Bucket([]byte(namespace))
 		if bucket == nil {
-			errMsg := fmt.Sprintf("namespace<%s> does not exist", namespace)
-			logrus.Error(errMsg)
-			return errors.New(errMsg)
+			logrus.Warnf("namespace<%s> does not exist", namespace)
+			return nil
 		}
 		cursor := bucket.Cursor()
 		for k, _ := cursor.First(); k != nil; k, _ = cursor.Next() {