merge metadata openapi documents (#415)

* merge metadata openapi documents * merge into metadata.gen.yaml * update metadata with examples * [AUTOMATED] Update: docs/pages/api/**/*.gen.yaml * generate *.gen.yaml before build and dev * remove extra merge examples in github workflows * generate analytics docs while building * delete docs build workflow * fix analytics example structure * updated security additions prior to build * update security-scheme locally --------- Co-authored-by: LukasJenicek <[email protected]> Co-authored-by: James Lawton <[email protected]>
0xsequence · Nov 1, 2024 · 3576ae4 · 3576ae4
1 parent efd55f0
commit 3576ae4
Show file tree

Hide file tree

Showing 16 changed files with 1,620 additions and 6,278 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -19,10 +19,24 @@ jobs:
       run: |
         npm install -g [email protected]
         pnpm install
-    
-    - name: Update API Examples
+
+
+    - name: setup-go
+      uses: actions/setup-go@v5
+      with:
+        go-version: "1.22.5"
+
+    - name: Update openapi docs
       run: |
-        pnpm update-examples
+        # Read the changed files from the previous step
+        go mod init github.com/0xsequence/docs 
+        go get github.com/mikefarah/yq/v4@latest 
+        go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/api/api.gen.yaml
+        go run github.com/mikefarah/yq/v4 -e -i '.security=[{"BearerAuth":[]}]' docs/pages/api/analytics/analytics.gen.yaml
+        go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/marketplace/marketplace.gen.yaml
+        go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}, {"BearerAuth":[]}]' docs/pages/api/metadata/metadata.gen.yaml
+        go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}, {"BearerAuth":[]}]' docs/pages/api/indexer/indexer.gen.yaml
+        go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/relayer/relayer.gen.yaml
     
     - name: Build
       run: pnpm run build

diff --git a/.github/workflows/scheme.yml b/.github/workflows/scheme.yml
diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,10 @@ docs/pages/solutions/.DS_Store
 .cursorrules
 .env*
 docs/data
+
+docs/pages/api/analytics/analytics.gen.yaml
+docs/pages/api/api/api.gen.yaml
+docs/pages/api/indexer/indexer.gen.yaml
+docs/pages/api/marketplace/marketplace.gen.yaml
+docs/pages/api/metadata/metadata.gen.yaml
+docs/pages/api/relayer/relayer.gen.yaml