Skip to content

Commit

Permalink
Gen rest docs from JSON
Browse files Browse the repository at this point in the history
Signed-off-by: Joshua Castle <[email protected]>
  • Loading branch information
Kas-tle committed Mar 12, 2024
1 parent ef727cf commit 66d6ba1
Show file tree
Hide file tree
Showing 5 changed files with 1,447 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/api/downloads/build-specific.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ Gets information related to a specific build.
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"project_id\": \"geyser\",\n \"project_name\": \"Geyser\",\n \"version\": \"2.1.0\",\n \"build\": 30,\n \"time\": \"2024-03-12T07:16:17.367Z\",\n \"channel\": \"default\",\n \"promoted\": true,\n \"changes\": [\n {\n \"commit\": \"string\",\n \"summary\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"downloads\": {}\n}"}
responseExample={"{\n \"project_id\": \"geyser\",\n \"project_name\": \"Geyser\",\n \"version\": \"2.1.0\",\n \"build\": 30,\n \"time\": \"2024-03-12T07:39:10.078Z\",\n \"channel\": \"default\",\n \"promoted\": true,\n \"changes\": [\n {\n \"commit\": \"string\",\n \"summary\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"downloads\": {}\n}"}
language={"json"}
>

Expand Down
2 changes: 1 addition & 1 deletion docs/api/downloads/builds.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ Gets all available builds for a project's version.
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"project_id\": \"geyser\",\n \"project_name\": \"Geyser\",\n \"version\": \"2.1.0\",\n \"builds\": [\n {\n \"build\": 30,\n \"time\": \"2024-03-12T07:16:17.366Z\",\n \"channel\": \"default\",\n \"promoted\": true,\n \"changes\": [\n {\n \"commit\": \"string\",\n \"summary\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"downloads\": {}\n }\n ]\n}"}
responseExample={"{\n \"project_id\": \"geyser\",\n \"project_name\": \"Geyser\",\n \"version\": \"2.1.0\",\n \"builds\": [\n {\n \"build\": 30,\n \"time\": \"2024-03-12T07:39:10.075Z\",\n \"channel\": \"default\",\n \"promoted\": true,\n \"changes\": [\n {\n \"commit\": \"string\",\n \"summary\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"downloads\": {}\n }\n ]\n}"}
language={"json"}
>

Expand Down
4 changes: 2 additions & 2 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ const config: Config = {
docsPluginId: "classic",
config: {
downloads: {
specPath: "openapi/downloads.yaml",
specPath: "openapi/downloads.json",
outputDir: "docs/api/downloads",
},
global: {
specPath: "openapi/global.yaml",
specPath: "openapi/global.json",
outputDir: "docs/api/global",
}
}
Expand Down
Loading

0 comments on commit 66d6ba1

Please sign in to comment.