Link readme

neynarxyz · Oct 19, 2023 · 7579990 · 7579990
1 parent 6f919d0
commit 7579990
Show file tree

Hide file tree

Showing 6 changed files with 1,837 additions and 3 deletions.
diff --git a/.github/workflows/rdme-openapi.yml b/.github/workflows/rdme-openapi.yml
@@ -0,0 +1,23 @@
+name: ReadMe GitHub Action 🦉
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  rdme-openapi:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo 📚
+        uses: actions/checkout@v3
+
+      - name: Run `openapi` command for v1 spec 🚀
+        uses: readmeio/rdme@v8
+        with:
+          rdme: openapi src/v1/spec.yaml --key=${{ secrets.README_API_KEY }} --id=65313d8d196216005b2ed13e
+
+      - name: Run `openapi` command for v2 spec 🚀
+        uses: readmeio/rdme@v8
+        with:
+          rdme: openapi src/v2/spec.yaml --key=${{ secrets.README_API_KEY }} --id=653140896cad5a001321c86f
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
-swagger-tmp
+swagger-tmp
+node_modules
diff --git a/package.json b/package.json
@@ -0,0 +1,7 @@
+{
+  "name": "OAS",
+  "version": "1.0.0",
+  "description": "The OpenAPI specification for the Neynar APIs",
+  "author": "Neynar",
+  "license": "ISC"
+}
diff --git a/src/v1/spec.yaml b/src/v1/spec.yaml
@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  title: v1 Farcaster
+  title: v1 Farcaster.
   version: "1.0"
 servers:
   - url: https://api.neynar.com/v1

diff --git a/src/v2/spec.yaml b/src/v2/spec.yaml
@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  title: v2 Farcaster
+  title: v2 Farcaster.
   version: "1.0"
 servers:
   - url: https://api.neynar.com/v2