Add github action step to generate MDX of specs

bluesky-social · Dec 15, 2023 · bd5d5ce · bd5d5ce
1 parent 53d56db
commit bd5d5ce
Show file tree

Hide file tree

Showing 48 changed files with 73 additions and 47 deletions.
diff --git a/.github/workflows/generate_schema.yaml b/.github/workflows/generate_schema.yaml
@@ -2,7 +2,7 @@ name: Generate OpenAPI Schemas from Atproto Lexicons
 on: push
 
 jobs:
-  convert:
+  generate_openapi_schema:
     runs-on: ubuntu-latest
 
     permissions:
@@ -31,3 +31,28 @@ jobs:
         with:
           commit_message: spec/api.json updated
           file_pattern: atproto-openapi-types/lexicons/ atproto-openapi-types/spec/api.json
+
+  convert_to_mdx:
+    runs-on: ubuntu-latest
+    needs: generate_openapi_schema
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Generate Docusaurus API Docs
+        run: npm run docusaurus gen-api-docs bskyApi
+
+      - name: Commit MDX updates
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: MDX documentation updated
+          file_pattern: docs/api
diff --git a/README.md b/README.md
@@ -29,6 +29,7 @@ We use the [`docusaurus-openapi-docs`](https://github.com/PaloAltoNetworks/docus
 Run `npx docusaurus-mdx-checker` to see MDX compatability.
 
 Run `npm run docusaurus gen-api-docs <id>` to generate MDX docs from an OpenAPI spec.
+In this case, `npm run docusaurus gen-api-docs bskyApi`.
 
 
 Run `deno task run` to generate a fresh OpenAPI spec to `atproto-openapi-types/spec/api.json`.

diff --git a/docs/api/app-bsky-actor-get-profile.api.mdx b/docs/api/app-bsky-actor-get-profile.api.mdx
@@ -753,7 +753,7 @@ Get detailed profile view of an actor.
                   value={"Example (from schema)"}
                 >
                   <ResponseSamples
-                    responseExample={"{\n  \"did\": \"string\",\n  \"handle\": \"string\",\n  \"displayName\": \"string\",\n  \"description\": \"string\",\n  \"avatar\": \"string\",\n  \"banner\": \"string\",\n  \"followersCount\": 0,\n  \"followsCount\": 0,\n  \"postsCount\": 0,\n  \"indexedAt\": \"2023-12-15T02:54:25.731Z\",\n  \"viewer\": {\n    \"muted\": true,\n    \"mutedByList\": {\n      \"uri\": \"string\",\n      \"cid\": \"string\",\n      \"name\": \"string\",\n      \"purpose\": \"string\",\n      \"avatar\": \"string\",\n      \"viewer\": {\n        \"muted\": true,\n        \"blocked\": \"string\"\n      },\n      \"indexedAt\": \"2023-12-15T02:54:25.731Z\"\n    },\n    \"blockedBy\": true,\n    \"blocking\": \"string\",\n    \"blockingByList\": {\n      \"uri\": \"string\",\n      \"cid\": \"string\",\n      \"name\": \"string\",\n      \"purpose\": \"string\",\n      \"avatar\": \"string\",\n      \"viewer\": {\n        \"muted\": true,\n        \"blocked\": \"string\"\n      },\n      \"indexedAt\": \"2023-12-15T02:54:25.731Z\"\n    },\n    \"following\": \"string\",\n    \"followedBy\": \"string\"\n  },\n  \"labels\": [\n    {\n      \"src\": \"string\",\n      \"uri\": \"string\",\n      \"cid\": \"string\",\n      \"val\": \"string\",\n      \"neg\": true,\n      \"cts\": \"2023-12-15T02:54:25.731Z\"\n    }\n  ]\n}"}
+                    responseExample={"{\n  \"did\": \"string\",\n  \"handle\": \"string\",\n  \"displayName\": \"string\",\n  \"description\": \"string\",\n  \"avatar\": \"string\",\n  \"banner\": \"string\",\n  \"followersCount\": 0,\n  \"followsCount\": 0,\n  \"postsCount\": 0,\n  \"indexedAt\": \"2023-12-15T21:27:42.699Z\",\n  \"viewer\": {\n    \"muted\": true,\n    \"mutedByList\": {\n      \"uri\": \"string\",\n      \"cid\": \"string\",\n      \"name\": \"string\",\n      \"purpose\": \"string\",\n      \"avatar\": \"string\",\n      \"viewer\": {\n        \"muted\": true,\n        \"blocked\": \"string\"\n      },\n      \"indexedAt\": \"2023-12-15T21:27:42.699Z\"\n    },\n    \"blockedBy\": true,\n    \"blocking\": \"string\",\n    \"blockingByList\": {\n      \"uri\": \"string\",\n      \"cid\": \"string\",\n      \"name\": \"string\",\n      \"purpose\": \"string\",\n      \"avatar\": \"string\",\n      \"viewer\": {\n        \"muted\": true,\n        \"blocked\": \"string\"\n      },\n      \"indexedAt\": \"2023-12-15T21:27:42.699Z\"\n    },\n    \"following\": \"string\",\n    \"followedBy\": \"string\"\n  },\n  \"labels\": [\n    {\n      \"src\": \"string\",\n      \"uri\": \"string\",\n      \"cid\": \"string\",\n      \"val\": \"string\",\n      \"neg\": true,\n      \"cts\": \"2023-12-15T21:27:42.699Z\"\n    }\n  ]\n}"}
                     language={"json"}
                   >
 

diff --git a/docs/api/app-bsky-actor-get-profiles.api.mdx b/docs/api/app-bsky-actor-get-profiles.api.mdx
@@ -803,7 +803,7 @@ Get detailed profile views of multiple actors.
                   value={"Example (from schema)"}
                 >
                   <ResponseSamples
-                    responseExample={"{\n  \"profiles\": [\n    {\n      \"did\": \"string\",\n      \"handle\": \"string\",\n      \"displayName\": \"string\",\n      \"description\": \"string\",\n      \"avatar\": \"string\",\n      \"banner\": \"string\",\n      \"followersCount\": 0,\n      \"followsCount\": 0,\n      \"postsCount\": 0,\n      \"indexedAt\": \"2023-12-15T02:54:25.733Z\",\n      \"viewer\": {\n        \"muted\": true,\n        \"mutedByList\": {\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"name\": \"string\",\n          \"purpose\": \"string\",\n          \"avatar\": \"string\",\n          \"viewer\": {\n            \"muted\": true,\n            \"blocked\": \"string\"\n          },\n          \"indexedAt\": \"2023-12-15T02:54:25.733Z\"\n        },\n        \"blockedBy\": true,\n        \"blocking\": \"string\",\n        \"blockingByList\": {\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"name\": \"string\",\n          \"purpose\": \"string\",\n          \"avatar\": \"string\",\n          \"viewer\": {\n            \"muted\": true,\n            \"blocked\": \"string\"\n          },\n          \"indexedAt\": \"2023-12-15T02:54:25.733Z\"\n        },\n        \"following\": \"string\",\n        \"followedBy\": \"string\"\n      },\n      \"labels\": [\n        {\n          \"src\": \"string\",\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"val\": \"string\",\n          \"neg\": true,\n          \"cts\": \"2023-12-15T02:54:25.733Z\"\n        }\n      ]\n    }\n  ]\n}"}
+                    responseExample={"{\n  \"profiles\": [\n    {\n      \"did\": \"string\",\n      \"handle\": \"string\",\n      \"displayName\": \"string\",\n      \"description\": \"string\",\n      \"avatar\": \"string\",\n      \"banner\": \"string\",\n      \"followersCount\": 0,\n      \"followsCount\": 0,\n      \"postsCount\": 0,\n      \"indexedAt\": \"2023-12-15T21:27:42.702Z\",\n      \"viewer\": {\n        \"muted\": true,\n        \"mutedByList\": {\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"name\": \"string\",\n          \"purpose\": \"string\",\n          \"avatar\": \"string\",\n          \"viewer\": {\n            \"muted\": true,\n            \"blocked\": \"string\"\n          },\n          \"indexedAt\": \"2023-12-15T21:27:42.702Z\"\n        },\n        \"blockedBy\": true,\n        \"blocking\": \"string\",\n        \"blockingByList\": {\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"name\": \"string\",\n          \"purpose\": \"string\",\n          \"avatar\": \"string\",\n          \"viewer\": {\n            \"muted\": true,\n            \"blocked\": \"string\"\n          },\n          \"indexedAt\": \"2023-12-15T21:27:42.702Z\"\n        },\n        \"following\": \"string\",\n        \"followedBy\": \"string\"\n      },\n      \"labels\": [\n        {\n          \"src\": \"string\",\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"val\": \"string\",\n          \"neg\": true,\n          \"cts\": \"2023-12-15T21:27:42.702Z\"\n        }\n      ]\n    }\n  ]\n}"}
                     language={"json"}
                   >
 

diff --git a/docs/api/app-bsky-actor-get-suggestions.api.mdx b/docs/api/app-bsky-actor-get-suggestions.api.mdx
@@ -781,7 +781,7 @@ Get a list of suggested actors, used for discovery.
                   value={"Example (from schema)"}
                 >
                   <ResponseSamples
-                    responseExample={"{\n  \"cursor\": \"string\",\n  \"actors\": [\n    {\n      \"did\": \"string\",\n      \"handle\": \"string\",\n      \"displayName\": \"string\",\n      \"description\": \"string\",\n      \"avatar\": \"string\",\n      \"indexedAt\": \"2023-12-15T02:54:25.735Z\",\n      \"viewer\": {\n        \"muted\": true,\n        \"mutedByList\": {\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"name\": \"string\",\n          \"purpose\": \"string\",\n          \"avatar\": \"string\",\n          \"viewer\": {\n            \"muted\": true,\n            \"blocked\": \"string\"\n          },\n          \"indexedAt\": \"2023-12-15T02:54:25.735Z\"\n        },\n        \"blockedBy\": true,\n        \"blocking\": \"string\",\n        \"blockingByList\": {\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"name\": \"string\",\n          \"purpose\": \"string\",\n          \"avatar\": \"string\",\n          \"viewer\": {\n            \"muted\": true,\n            \"blocked\": \"string\"\n          },\n          \"indexedAt\": \"2023-12-15T02:54:25.735Z\"\n        },\n        \"following\": \"string\",\n        \"followedBy\": \"string\"\n      },\n      \"labels\": [\n        {\n          \"src\": \"string\",\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"val\": \"string\",\n          \"neg\": true,\n          \"cts\": \"2023-12-15T02:54:25.735Z\"\n        }\n      ]\n    }\n  ]\n}"}
+                    responseExample={"{\n  \"cursor\": \"string\",\n  \"actors\": [\n    {\n      \"did\": \"string\",\n      \"handle\": \"string\",\n      \"displayName\": \"string\",\n      \"description\": \"string\",\n      \"avatar\": \"string\",\n      \"indexedAt\": \"2023-12-15T21:27:42.704Z\",\n      \"viewer\": {\n        \"muted\": true,\n        \"mutedByList\": {\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"name\": \"string\",\n          \"purpose\": \"string\",\n          \"avatar\": \"string\",\n          \"viewer\": {\n            \"muted\": true,\n            \"blocked\": \"string\"\n          },\n          \"indexedAt\": \"2023-12-15T21:27:42.704Z\"\n        },\n        \"blockedBy\": true,\n        \"blocking\": \"string\",\n        \"blockingByList\": {\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"name\": \"string\",\n          \"purpose\": \"string\",\n          \"avatar\": \"string\",\n          \"viewer\": {\n            \"muted\": true,\n            \"blocked\": \"string\"\n          },\n          \"indexedAt\": \"2023-12-15T21:27:42.704Z\"\n        },\n        \"following\": \"string\",\n        \"followedBy\": \"string\"\n      },\n      \"labels\": [\n        {\n          \"src\": \"string\",\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"val\": \"string\",\n          \"neg\": true,\n          \"cts\": \"2023-12-15T21:27:42.704Z\"\n        }\n      ]\n    }\n  ]\n}"}
                     language={"json"}
                   >
 

diff --git a/docs/api/app-bsky-actor-put-preferences.api.mdx b/docs/api/app-bsky-actor-put-preferences.api.mdx
@@ -5,7 +5,7 @@ description: "Set the private preferences attached to the account."
 sidebar_label: "Set the private preferences attached to the account."
 hide_title: true
 hide_table_of_contents: true
-api: eJy9Vm1vIjcQ/isrf+kXAoQmqoSqSiS5k6LmFJqQqmrKB+/ubNYXr+3aswQO8d87413CEnrhdKoKEvhl5pkXPzP2WqB8CmL8KKRz/TQ8r/oyQ+vFvCesAy9RWXOdi/Gb/b6rceqhAA8mgyB6IkBWe4UrwlqLC5AePA3nGwLy8HcNAS9sTrvrOFUeCBR9DT2RWYNgkLfIiFZZNDr4HKzhtZCVUEke4coBeWLTz5Ch6HWAHoXrOEMmnWfvUdGMFLubOxzpvVwRjEKo4ro1cFtE/9+zBEammoZkBRVqOMxNDkXoy7zWeNmExpkSm977uFqmoGltoYJKleZUHjHRJu6GFb/JhFPG0IgOSy6ORxCFPgLk4avg76lT/ukEpb4ClEp/HaPrYAHH3WKZ3xW8fJdTWHqQHfX55kgQHeZs4ocdDs6a0HBpNBzyXw4h88oxcQnp9ldyTJz929aFzJO7ph7Ef0R98J4KticqCEE+wSH9G4EdSkCvzBNpgKkrRrg2C6lVvvPrw9Ix+sw+g6Fpu99MOWVbUweY2xydDU8PY38wssbSevUlkvB/Dp7MUWxjMSEfPqkQortHQyGJ/SDuARMsIXFeLSTy/ytDEokoyes8QRtlZJbZ2mA/+keRcx91NmbYSSxpNjjeVv2CCil2pdprUikRXRgPBlEr2ExJPVh6lw3EW1cns2TqLdrM6mR6dZ/8cTe9TBrAWDj7eNKp1hPnvgFw4hyX0T7ofHcP3PPxNUewvQ1eM8wmObYoQvO0EeBk8+nf7e6LD0tZOQ0HTZyyse3D8RbhcJoG2qF3p5PSamlfYtRtEyTutILzbT/sLLFgqjyWV3TGpD0ajn48OR2dnJ7PhqPx+dl4dN7/aXT6Z0SMXatjt1Q53AExmj1t7rjO0sXqwRRWa/uyuwL3tm/UM1wyb8R4+LpFrNkD+622CNPdKvsRrGeCW503VUwUpWJDKrePrb2HELkUFbiOFXkSz6Vtgd0Djgc7mV7zQdVVJT1ncWKS2tiiUEy7hEqKyUnkSGyRdJR/CImGpeKS41q4dWAIiVabok4K6ysZ66LVJ+hhn760Qo0AqLuyW0ZGeny6niU37Sr5nFPTUIViRvFWpA3np5Kmo/SddbpH+FfCIixx4LRUhltGrJt1W8JvX05vS5jYVXLJk+B6ncoAD15vNrxMJOecPtJwIb1iNscXEynQHRWfT2vxDJz29h1xMmN3WFzX7Y213zaZBY3GJMvA4buy805Xmt7ez0g4bZ9olc1Zx8sXbrf0OxZ/0Vfwo5ARYlnHdS4781THDioaXD4PbvSd/LUF3tsOOm8saVYdL39uekUSr5pfaKOJBuPNQ5TdbP4BAAq1CA==
+api: eJy9Vm1vIjcQ/isrf+kXAoSm7QlVlUhyJ0XNKVxCqqopH7y7s1lfvLZrzxIo4r93xruEJfTC6VQVJPDLzDMvfmbstUD5GMT4QUjn+ml4WvVlhtaLeU9YB16isuYqF+NX+31X49RDAR5MBkH0RICs9gpXhLUW5yA9eBrONwTk4a8aAp7bnHbXcao8ECj6GnoiswbBIG+REa2yaHTwOVjDayEroZI8wpUD8sSmnyFD0esAPQjXcYZMOs/eo6IZKXY3dzjSe7kiGIVQxXVr4KaI/r9lCYxMNQ3JCirUcJibHIrQl3mt8aIJjTMlNr23cbVMQdPaQgWVKs2pPGKiTdw1K36VCaeMoREdllwcjyAKfQDIwxfB31Kn/NMJSn0JKJX+MkbXwQKOu8Uyvyl4/iansPQgO+rzzZEgOszZxA87HJw1oeHSaDjkvxxC5pVj4hLSza/kmDj7t61zmSe3TT2I/4j64D0VbE9UEIJ8hEP6NwI7lIBemUfSAFNXjHBlFlKrfOfX+6Vj9Jl9AkPTdr+Zcsq2pg4wtzk6G54exn5vZI2l9ervSML/OXgyR7GNxYR8+KhCiO4eDYUk9oO4A0ywhMR5tZDI/y8MSSSiJK/zBG2UkVlma4P96B9Fzn3U2ZhhJ7Gk2eB4W/ULKqTYlWqvSaVEdGE8GEStYDMl9WDpXTYQr12dzJKpt2gzq5Pp5V3y++30ImkAY+Hs40mnWk+c+wrAiXNcRvug8909cMfH1xzB9jZ4yTCb5NiiCM3TRoCTzad/u7sv3i9l5TQcNHHKxrYPx1uEw2kaaIfenU5Kq6V9jlG3TZC40wrOt/2ws8SCqfJYXtIZk/ZoOPr+5HR0cvrDbHQ6Hv00Phv1f3z37o+IGLtWx26pcrgFYjR72txxnaXz1b0prNb2eXcF7m1fqye4YN6I8fBli1izB/aptgjT3Sr7EaxngludN1VMFKViQyq3D629+xC5FBW4jhV5Es+lbYHdA44HO5le8UHVVSU9Z3FiktrYolBMu4RKislJ5EhskXSUvwuJhqXikuNauHFgCIlWm6JOCusrGeui1SfoYZ++tEKNAKi7sltGRnp8vJol1+0q+ZxT01CFYkbxVqQN56eSpqP0jXW6R/gXwiIsceC0VIZbRqybdVvCr19Or0uY2FVyyZPgep3KAPdebza8TCTnnD7QcCG9YjbHFxMp0B0Vn09r8QSc9vYdcTJjd1hc1+2Ntd82mQWNxiTLwOGbsvNOV5re3M1IOG2faJXNWcfLZ2639DsWf9JX8KOQEWJZx3UuO/NYxw4qGlw+D270nfy1Bd7bDjpvLGlWHS9/bnpFEq+aX2ijiQbjzUOU3Wz+ASmFtRQ=
 sidebar_class_name: "post api-method"
 info_path: docs/api/at-protocol-xrpc-api
 custom_edit_url: null

diff --git a/docs/api/app-bsky-actor-search-actors-typeahead.api.mdx b/docs/api/app-bsky-actor-search-actors-typeahead.api.mdx
@@ -759,7 +759,7 @@ Find actor suggestions for a prefix search term.
                   value={"Example (from schema)"}
                 >
                   <ResponseSamples
-                    responseExample={"{\n  \"actors\": [\n    {\n      \"did\": \"string\",\n      \"handle\": \"string\",\n      \"displayName\": \"string\",\n      \"avatar\": \"string\",\n      \"viewer\": {\n        \"muted\": true,\n        \"mutedByList\": {\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"name\": \"string\",\n          \"purpose\": \"string\",\n          \"avatar\": \"string\",\n          \"viewer\": {\n            \"muted\": true,\n            \"blocked\": \"string\"\n          },\n          \"indexedAt\": \"2023-12-15T02:54:25.741Z\"\n        },\n        \"blockedBy\": true,\n        \"blocking\": \"string\",\n        \"blockingByList\": {\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"name\": \"string\",\n          \"purpose\": \"string\",\n          \"avatar\": \"string\",\n          \"viewer\": {\n            \"muted\": true,\n            \"blocked\": \"string\"\n          },\n          \"indexedAt\": \"2023-12-15T02:54:25.741Z\"\n        },\n        \"following\": \"string\",\n        \"followedBy\": \"string\"\n      },\n      \"labels\": [\n        {\n          \"src\": \"string\",\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"val\": \"string\",\n          \"neg\": true,\n          \"cts\": \"2023-12-15T02:54:25.741Z\"\n        }\n      ]\n    }\n  ]\n}"}
+                    responseExample={"{\n  \"actors\": [\n    {\n      \"did\": \"string\",\n      \"handle\": \"string\",\n      \"displayName\": \"string\",\n      \"avatar\": \"string\",\n      \"viewer\": {\n        \"muted\": true,\n        \"mutedByList\": {\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"name\": \"string\",\n          \"purpose\": \"string\",\n          \"avatar\": \"string\",\n          \"viewer\": {\n            \"muted\": true,\n            \"blocked\": \"string\"\n          },\n          \"indexedAt\": \"2023-12-15T21:27:42.710Z\"\n        },\n        \"blockedBy\": true,\n        \"blocking\": \"string\",\n        \"blockingByList\": {\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"name\": \"string\",\n          \"purpose\": \"string\",\n          \"avatar\": \"string\",\n          \"viewer\": {\n            \"muted\": true,\n            \"blocked\": \"string\"\n          },\n          \"indexedAt\": \"2023-12-15T21:27:42.710Z\"\n        },\n        \"following\": \"string\",\n        \"followedBy\": \"string\"\n      },\n      \"labels\": [\n        {\n          \"src\": \"string\",\n          \"uri\": \"string\",\n          \"cid\": \"string\",\n          \"val\": \"string\",\n          \"neg\": true,\n          \"cts\": \"2023-12-15T21:27:42.710Z\"\n        }\n      ]\n    }\n  ]\n}"}
                     language={"json"}
                   >