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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
1,048 changes: 976 additions & 72 deletions bun.lock

Large diffs are not rendered by default.

65 changes: 65 additions & 0 deletions docs/API/Iglu Builder/build.api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
id: build
title: "Start build websocket"
description: "Create a websocket to start a build job."
sidebar_label: "Start build websocket"
hide_title: true
hide_table_of_contents: true
api: eJzNVdtu4zYQ/RViigK7gGIlffRbGrRFsm03QHbRB69RUNJEYlbicGeGsV3DwP5D/7BfsiB9iesoCPrWJwnkzOE5M8PDNTQoNbugjjxM4YrRKhprFlgJ1Z9RjZIRtazGmiq6vjEPVE3MJ/8bMRrn74kHm7KNrSiq0Q7NH4fkFUVTW2/unW/MrEPG+ZuyoVrKKxoCefQq5XXbx+9/OP8xoSN/d8h+CwVQQM7w1w1MIROAAhglkBcUmK7h4vwiff4t5G7htO6cb80tk1JNvZh/vv6dqN1tqS0cN8bG+xYrG3UCBSzPDqoT4IAitsX0K+ib52fc3L3/3fwVB3OX6oPeoPMoJus4u6FKEmhNXtFnQBtC7+qspnyQBLEGXQWEKVD1gLVCAYGTYnVbaa3T14MYA4lT4tVRrCg738KmgIqtr7vRrdbpR0H2dsCX9t/hOCrjl+gY5TLqMXZF1KP1KcLTVU8exzaf8huYzg6R88Q2Fe99rrC8Lr0mxuMwH4cKOZ0+2GXqwOjeZ8TwZ0tJyShzXCrbS25lVLnEStRpVOTjAMtsV1CAUxzGEjcFKEdRbG5j1bv6Ha7+Y3pNw2C3c/iMVG3rzi1fL1iI8kK71HKLOgpug3tpDMS13vl2fPukzfns+enqXtVBw7OIdAlOBmNegDrtcW8JN1TBZptXo3vEET9AfkQ+u/S6oHxXFw7TvdUohfmVWjHUIJufseuRJwkswQ2oHSXjSaUpINg07FDubUgyqMB0tobIPUyhUw0yLUtc2iH0OKlpKG1w5eMFbOYFJLvMhdqRT85ndr5nLm+voTih/aFzYpxkV22ojgN63bot3efFU4SJySn7FScmJO/eRc9y+C1TGo75mz3b1mkXq0zWtX08k+5tsq6kbUvjfHI+uUj9DiQ62OxcW9eA7H27l+HJPk90rJ9s8P/3xOymVnGpZeity9cht3O96/hs9/DMC+hINC2s15UV/Mj9ZpOWv0RM9jubF/Bo2dkqtXc2Px6hX376AJvNN+8Gl2I=
sidebar_class_name: "get api-method"
info_path: docs/API/Iglu Builder/iglu-builder-api
custom_edit_url: null
hide_send_button: true
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"Start build websocket"}
>
</Heading>

<MethodEndpoint
method={"get"}
path={"/build"}
context={"endpoint"}
>

</MethodEndpoint>



Create a websocket to start a build job.
More information about the Websocket you can find [here](/docs/Components/Iglu%20Builder#Websocket)

<ParamsDetails
parameters={undefined}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={undefined}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"101":{"description":"Switching Protocols – WebSocket wird aufgebaut.","x-websocket":{"message":{"send":{"description":"JSON zum Starten eines Build-Jobs.","content":{"application/json":{"type":"object","properties":{"git":{"type":"object","properties":{"repository":{"type":"string"},"branch":{"type":"string"},"gitUsername":{"type":"string"},"gitKey":{"type":"string"},"requiresAuth":{"type":"boolean"},"noClone":{"type":"boolean"}},"required":["noClone"]},"buildOptions":{"type":"object","properties":{"cores":{"type":"number"},"maxJobs":{"type":"number"},"keep_going":{"type":"boolean"},"extraArgs":{"type":"string"},"substituters":{"type":"array","items":{"type":"string"}},"trustedPublicKeys":{"type":"array","items":{"type":"string"}},"command":{"type":"string"},"cachix":{"type":"object","properties":{"push":{"type":"boolean"},"target":{"type":"string"},"apiKey":{"type":"string"},"signingKey":{"type":"string"}},"required":["push"]}},"required":["command","cachix"]}},"required":["git","buildOptions"],"title":"buildJob"}}},"receive":{"description":"Server-Antworten wie Status, Logs oder Fehler."}}}}}}
>

</StatusCodes>



64 changes: 64 additions & 0 deletions docs/API/Iglu Builder/healthcheck.api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
id: healthcheck
title: "healthcheck"
description: "Endpoint to check the service health of the Builder"
sidebar_label: "healthcheck"
hide_title: true
hide_table_of_contents: true
api: eJylUsFu3CAQ/RU6p1Si603VXrhtpSjaQ6sc0tPKBxZPDA0GCmM3K4t/r8DrNru5tSfEMG/e472ZocOkoglkvAMBd64L3jhi5JnSqJ4ZaWQJ42QUMo3Skmb+qVa/jMZ2GIGDDxhlmbDvQMDSVdHAIWIK3iVMIGb4uN2W44pzwngibVzPTGJxdM64Hjgo7wgdFQDhCzXBSuPKLSmNg6z1U0AQkCguEHyRQ7D4Z2iZmRCHdJZ+egc558zh0/bzWyFfkbTvkDmjNDGMVo5H+l8hy1D2zRPbWet/YVclZA5DfQEBPRaWIEmDgObSvmI9xgTiMMMYbbGXKCTRNGeKjfJDI4NpplvILQfjnnxVZKjy73s7rlGx3cMe+NWvH7VJxfgSaefVOKCjGuaa8/WEDauQtWISCzLS2n2o7Q/R/0BF7c2qtjekx2MVa3o7fkj6/QY4lL8tMrab7eYWMofgEw2y+uvkgG8W6kL9/Decf9zdc3Kvgs18cXo+R3K4ENBy0D5RKc/zUSb8Hm3OpfxzxHgCcWg5TDIaeSz+H9rMC76QlQyf8QQCdkphKKFP0o7X9O2r1bi/e4ScfwOQ1EGl
sidebar_class_name: "get api-method"
info_path: docs/API/Iglu Builder/iglu-builder-api
custom_edit_url: null
hide_send_button: true
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"healthcheck"}
>
</Heading>

<MethodEndpoint
method={"get"}
path={"/healthcheck"}
context={"endpoint"}
>

</MethodEndpoint>



Endpoint to check the service health of the Builder

<ParamsDetails
parameters={undefined}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={undefined}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Everything is running","content":{"text/plain":{"schema":{"type":"string","example":"Everyting seems healthy!"}}}},"405":{"description":"Methode nicht erlaubt","content":{"text/plain":{"schema":{"type":"string","example":"Method Not Allowed"}}}}}}
>

</StatusCodes>



35 changes: 35 additions & 0 deletions docs/API/Iglu Builder/iglu-builder-api.info.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
id: iglu-builder-api
title: "Iglu Builder API"
description: "This is the documentation of the Iglu Builder API. This Builder is part of the [Iglu Project](https://github.com/iglu-sh)."
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---

import ApiLogo from "@theme/ApiLogo";
import Heading from "@theme/Heading";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";

<span
className={"theme-doc-version-badge badge badge--secondary"}
children={"Version: 0.0.1"}
>
</span>

<Heading
as={"h1"}
className={"openapi__heading"}
children={"Iglu Builder API"}
>
</Heading>



This is the documentation of the Iglu Builder API. This Builder is part of the [Iglu Project](https://github.com/iglu-sh).



30 changes: 30 additions & 0 deletions docs/API/Iglu Builder/sidebar.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";

const sidebar: SidebarsConfig = {
apisidebar: [
{
type: "doc",
id: "API/Iglu Builder/iglu-builder-api",
},
{
type: "category",
label: "UNTAGGED",
items: [
{
type: "doc",
id: "API/Iglu Builder/build",
label: "Start build websocket",
className: "api-method get",
},
{
type: "doc",
id: "API/Iglu Builder/healthcheck",
label: "healthcheck",
className: "api-method get",
},
],
},
],
};

export default sidebar.apisidebar;
16 changes: 16 additions & 0 deletions docs/Components/Archtitecture.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
sidebar_position: 4
---

import { useColorMode } from '@docusaurus/theme-common';

export const Image = () => {
const { colorMode } = useColorMode(); // 'light' oder 'dark'

const imagePath = "/img/docs/Components/Archtecture/communication_" + colorMode + ".excalidraw.svg"

return <img src={imagePath}/>

}

<Image/>
Loading