Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions services/console/src/components/docs/menu/ApiList.astro
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ interface Props {
}

// Api
const apiRunCollection = await getEnOnlyCollection(Collection.api_run);
const apiOrganizationsCollection = await getEnOnlyCollection(
Collection.api_organizations,
);
Expand All @@ -23,6 +24,11 @@ const { lang } = Astro.props;
---

{[
{
label: "Run",
collection: Collection.api_run,
content: apiRunCollection,
},
{
label: "Organizations",
collection: Collection.api_organizations,
Expand Down
3 changes: 3 additions & 0 deletions services/console/src/components/docs/menu/DocsMenu.astro
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ const docsReferenceCollection = await getLangCollection(
);

// Api
const apiRunCollection = await getEnOnlyCollection(Collection.api_run);
const apiOrganizationsCollection = await getEnOnlyCollection(
Collection.api_organizations,
);
Expand Down Expand Up @@ -104,6 +105,8 @@ const displayStyle = (menu: DocsMenuId, tab: DocsTab) => {
);
case DocsMenuId.Api:
return (
1 +
apiRunCollection?.length +
1 +
apiOrganizationsCollection?.length +
1 +
Expand Down
1 change: 1 addition & 0 deletions services/console/src/content.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ export const collections = {
docs_explanation: docs("explanation"),
docs_reference: docs("reference"),
// api
api_run: api("run"),
api_organizations: api("organizations"),
api_projects: api("projects"),
api_users: api("users"),
Expand Down
11 changes: 11 additions & 0 deletions services/console/src/content/api-run/run.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Run"
description: "The Bencher Run REST API"
heading: "Run REST API"
sortOrder: 1
paths:
- path: /v0/run
method: post
headers: pub
cli: run
---
45 changes: 45 additions & 0 deletions services/console/src/pages/[lang]/docs/api/run/[slug].astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
export const prerender = true;

import { getCollection } from "astro:content";
import ApiLayout from "../../../../../layouts/docs/ApiLayout.astro";
import Operation from "../../../../../components/docs/api/Operation.astro";
import { otherLanguages } from "../../../../../i18n/ui";
import Collection, { fmtPageId } from "../../../../../util/collection";
import {
API_DOCS_MODIFIED,
API_DOCS_PUBLISHED,
} from "../../../../../i18n/utils";

const collection = Collection.api_run;

export async function getStaticPaths() {
const collection = Collection.api_run;
const pages = await getCollection(collection);
return otherLanguages.flatMap((lang) => {
return pages.map((page) => ({
params: { lang, slug: fmtPageId(page.id) },
props: { page },
}));
});
}

const { page } = Astro.props;
const { lang, slug } = Astro.params;
---

<ApiLayout
title={page.data.title}
titleFmt={(_title) => `🐰 ${page.data.heading}`}
description={page.data.description}
heading={page.data.heading}
published={API_DOCS_PUBLISHED}
modified={API_DOCS_MODIFIED}
collection={collection}
slug={slug}
lang={lang}
>
{page.data.paths.map(({path, method, headers, cli}, index) =>
<Operation lang={lang} path={path} method={method} headers={headers} cli={cli} index={index} />
)}
</ApiLayout>
12 changes: 12 additions & 0 deletions services/console/src/pages/[lang]/docs/api/run/index.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
export const prerender = true;

import { otherLanguages } from "../../../../../i18n/ui";
export async function getStaticPaths() {
return otherLanguages.map((lang) => {
return { params: { lang } };
});
}
const { lang } = Astro.params;
---
<meta http-equiv="refresh" content={`0;url=/${lang}/docs/api/run/run`} />
36 changes: 36 additions & 0 deletions services/console/src/pages/docs/api/run/[slug].astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
export const prerender = true;

import ApiLayout from "../../../../layouts/docs/ApiLayout.astro";
import Operation from "../../../../components/docs/api/Operation.astro";
import {
API_DOCS_MODIFIED,
API_DOCS_PUBLISHED,
getEnOnlyPaths,
} from "../../../../i18n/utils";
import Collection from "../../../../util/collection";

const collection = Collection.api_run;

export async function getStaticPaths() {
const collection = Collection.api_run;
return await getEnOnlyPaths(collection);
}

const { slug } = Astro.params;
const page = Astro.props;
---

<ApiLayout
title={page.data.title}
description={page.data.description}
heading={page.data.heading}
published={API_DOCS_PUBLISHED}
modified={API_DOCS_MODIFIED}
collection={collection}
slug={slug}
>
{page.data.paths.map(({path, method, headers, cli}, index) =>
<Operation path={path} method={method} headers={headers} cli={cli} index={index}/>
)}
</ApiLayout>
4 changes: 4 additions & 0 deletions services/console/src/pages/docs/api/run/index.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
export const prerender = true;
---
<meta http-equiv="refresh" content="0;url=/docs/api/run/run" />
4 changes: 4 additions & 0 deletions services/console/src/util/collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ enum Collection {
docs_explanation = "docs_explanation",
docs_reference = "docs_reference",
// API
api_run = "api_run",
api_organizations = "api_organizations",
api_projects = "api_projects",
api_users = "api_users",
Expand All @@ -27,6 +28,7 @@ enum Collection {
}

export const ApiCollections = [
Collection.api_run,
Collection.api_organizations,
Collection.api_projects,
Collection.api_users,
Expand All @@ -45,6 +47,8 @@ export const collectionPath = (collection: Collection) => {
return "explanation";
case Collection.docs_reference:
return "reference";
case Collection.api_run:
return "run";
case Collection.api_organizations:
return "organizations";
case Collection.api_projects:
Expand Down
Loading