-
Notifications
You must be signed in to change notification settings - Fork 0
Add first cache and builder api docs #5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
8bec195
add first api endpoint
Svenum 5381e1a
add search + second api endpoint
Svenum 65d7192
add component
Svenum 1985342
add timestamp information
Svenum 0f25113
document prometheus endpoint
Svenum 64d866f
rebase
Svenum 0055fa7
rebase
Svenum 5c8d275
Update docs/Components/Iglu Builder.md
Svenum 446ad5a
Update docs/Developer/API/Iglu Builder/build.api.mdx
Svenum 1d53e10
Update static/api/builder.yml
Svenum 8dfea8d
translate
Svenum 2e980ad
Merge branch 'add-cache-api-docs' of github.com:iglu-sh/docs into add…
Svenum File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| --- | ||
| id: build | ||
| title: "/api/v1/build" | ||
| description: "Create a websocket to start a build job." | ||
| sidebar_label: "/api/v1/build" | ||
| hide_title: true | ||
| hide_table_of_contents: true | ||
| api: eJzNWOtu2zYUfhVCw4B2iHzZuqALsB+Oe0vStFnTrFuzIKCkY4mJRKq8JE6CAHuHvcKeob/6L2+yJ9k5lKxYtls7wTYMMRCbIr+P5/A7F/EqSMDEWpRWKBlsBEMN3ALj7Bwio+JTsMwqZizXFgcjJ/KEnaiow36Tu0oDE3KkdMFpNeORcjg9A/auWXyhHIu5ZCMhE3aYgYajB91ExaY7VEWpJEhrultp7r7+trdJ6KC/alY/DNYCVYL28FsJbs9vAEc1GFxswAQbV0G/16d/bUP2z4WNMyFTtqeVVbHKDfvr9z9oa/vV1s6FThh3oxQi7mwHUcdhYzUBFmAMT4G+GpDJPMf2/utX7NIVbJ/8A5KBkGCYtyPcVpEh0FhJfOQBeVnmIvbWdE8MQVwF9qJEhkBFJxBbb9kHJzQg22GQCnuMy0cixQfe9GPluQ3hcjRvPHl+tBaUmnxlReWUqbVLWKSKczyIeQgNpTLCKn0xBWGsRqciRNsVz4Vlb5r57ODNS5wCY16UOa3KrC3NRreLu8pc1IlV0XUGdJcoOjgYXNcGgj4WyRSddEUEeo5u6wnDAfR9CtnNRy1SdH4tHzNN3EfcVfCeojzBWcRhHlozNCjc8f5zlf5mYSPNZZyt5plNP5e94gW03FJwIcl09AC5Q9Lz1QBBOntZrWCjm0+aDRwGnrRiJC4FaOfX3RI16BXZKSw80iqUcaTkxpwrnSzknmMyJs7ym0/GQE74tbYMBtW0eyKlcuByAWSEqUWuMRXNQzPQuCk8D4ybjAljp60a8dwAEk4EvJzrZ9AZnTQms4QbtkPLpFdSo13S/hwHkvAkEYTC872pIPGP1wIrrHczumdYxdytnheFXzvO7ijQWuco1FlJUkqAe8fPkFbPRc9qmiRle8RFQRigxxIX+xpRPyf/tBCWEWzir0yDiEgUnyV6wV1pa79XYXFLTZQgeZRDckdVEtjE6fzUijNBApoRo9WOtIi7T9PWoX/GoLfVxPDtRVntNJmksJkMIR3PaQhPkrJ1M4ClKlPqlCqBRsSj6/rLUuYhzgqfjksMUUNH4tlTKHOOharaQturPdZj39AfuZDrVZLeewF5OMCpwsKpdbqFN368frz+KMyFdGOCrC1xOv9iUnJazPG8q5ZSvanswMSIMtaYLTBWUCvQyttNHapHfCGaOHLlKJ/ScLsI/9ORPvTo7TK0IOz/rcJZOrNKAh80IbGHCxC63vei6OA6rXqrJRL1AFVGCuer5kXoM52XYynuXcxqlsHeFttBDEQzIpW4+t6I+9V6gqvkOJzs058Rtsels4lYIT1gpboEVLEUpha2bypfe4R2eHbPuO7mIupGVeiurOPK/pmC1XSYS7pGjBxMRcl813ifaha+rkj/Q3HH+PZilkMO5CXPcl8CUNhnoM/xTcB/2HDvINzBtorEWQgpCkrQ/SmaR0hT8DG+Lq1AtMvHouA5sJqx5JrnOeRITG8Sn+N4jBynAOVxqkhGy6P1mdLWAPaOkkUg2DPIkKKVJCdtFYyt5hiwZoV078zNn/aSmrTJiQ506grs5dqhG4bowkgZHxPGRQa16Cwdzy0H15pfzFG8xHoL7IxaCCE5vmL40GL70xjY61soFkq3rdH7lBoqMaSuGcb52uJzU0eKsTIdpX1klS5C3xzX6eUY88tdDL75OBqhJ713JZvKMYssboy53djMhsL+xvqr4Yvkyfc//PLou77qpe8uymhXDw7enEbb/fX3e7s/PXtuyvjJfnby64+YT65vc8aU9T7RTGRa5567VItG4Qt6jrpeTJLMUgEOnLl0mCexRZRNuxZuwgjl3fIFeqG6xbhjua8T1BdW0ZZvF3kODNzKexpiEGew4JYCNAZEOJAW6wndIJwLoNsEfB1cYy9Vapgic6oo7RAYwRVgM0XXIVRM6QzoRSvoTi5HjAfFLR3WSl/Y9mDl7J71g2tM4HSJ431cb57uY5qOF8vjfPOaYVnCD931JCr2gV51J2rkB2cROswvmYzg15JulOrZh346OpOC9ejBgssCgRNCkz2kCxWyrdpGr9Pr9H18KWNRKGRD9b4S1OY1Ppl52WguZf5/F1610C2m3y725NUFQZ2wqpM+rK/B8OQyNJwGrq4ibuBA59fXNPzBAV3aHOJXbA4EvfTQr2npPH/6FuX0N3haBL4= | ||
| sidebar_class_name: "get api-method" | ||
| info_path: docs/Developer/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={"/api/v1/build"} | ||
| > | ||
| </Heading> | ||
|
|
||
| <MethodEndpoint | ||
| method={"get"} | ||
| path={"/build"} | ||
| context={"endpoint"} | ||
| > | ||
|
|
||
| </MethodEndpoint> | ||
|
|
||
|
|
||
|
|
||
| Create a websocket to start a build job. | ||
| More information about the Websocket can be found [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","required":["git_config","build_options","cachix_config"],"properties":{"git_config":{"type":"object","required":["noclone"],"properties":{"repository":{"type":"string","description":"Git Repository URL","example":"https://github.com/user/repo.git"},"builder_id":{"type":"number","description":"ID des zugehörigen Builders","example":1},"id":{"type":"number","description":"Eindeutige ID der Git-Konfiguration","example":1},"branch":{"type":"string","description":"Git Branch Name","example":"main"},"gitusername":{"type":"string","description":"Git Benutzername für Authentifizierung","example":"username"},"gitkey":{"type":"string","format":"password","description":"Git Authentifizierungsschlüssel"},"requiresauth":{"type":"boolean","description":"Gibt an, ob Authentifizierung erforderlich ist","example":false},"noclone":{"type":"boolean","description":"Verhindert das Klonen des Repositories","example":false}},"additionalProperties":false,"title":"GitConfig"},"builder":{"type":"object","properties":{"id":{"type":"number","description":"Eindeutige Builder ID","example":1},"cache_id":{"type":"number","description":"ID des zugehörigen Caches","example":1},"name":{"type":"string","description":"Name des Builders","example":"Production Builder"},"description":{"type":"string","description":"Beschreibung des Builders","example":"Hauptbuilder für Production"},"enabled":{"type":"boolean","description":"Gibt an, ob der Builder aktiviert ist","example":true},"trigger":{"type":"string","description":"Trigger-Typ für den Build","example":"manual","enum":["manual","webhook","cron"]},"cron":{"type":"string","description":"Cron-Expression für geplante Builds","example":"0 0 * * *"},"arch":{"type":"string","description":"Ziel-Architektur","example":"x86_64-linux"},"webhookurl":{"type":"string","format":"uri","description":"Webhook URL für Benachrichtigungen","example":"https://example.com/webhook"}},"additionalProperties":false,"title":"Builder"},"cachix_config":{"type":"object","properties":{"id":{"type":"number","description":"Eindeutige Cachix-Konfiguration ID","example":1},"builder_id":{"type":"number","description":"ID des zugehörigen Builders","example":1},"push":{"type":"boolean","description":"Aktiviert Push zu Cachix","example":true},"target":{"type":"string","description":"Cachix Cache-Name","example":"my-cache"},"apikey":{"type":"string","format":"password","description":"Cachix API Key"},"signingkey":{"type":"string","format":"password","description":"Signing Key für Cache"},"buildoutputdir":{"type":"string","description":"Verzeichnis für Build-Outputs","example":"/var/lib/builds"}},"additionalProperties":false,"title":"CachixConfig"},"build_options":{"type":"object","required":["command"],"properties":{"id":{"type":"number","description":"Eindeutige Build-Options ID","example":1},"builder_id":{"type":"number","description":"ID des zugehörigen Builders","example":1},"cores":{"type":"number","description":"Anzahl der zu verwendenden CPU-Kerne","minimum":1,"example":4},"maxjobs":{"type":"number","description":"Maximale Anzahl paralleler Jobs","minimum":1,"example":8},"keep_going":{"type":"boolean","description":"Fortsetzen bei Fehlern","example":false},"extraargs":{"type":"string","description":"Zusätzliche Build-Argumente","example":"--verbose"},"substituters":{"type":"array","description":"Liste von Binary Cache Substituters","items":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL des Substituters","example":"https://cache.nixos.org"},"public_signing_keys":{"type":"array","description":"Liste von öffentlichen Signing Keys","items":{"type":"string","example":"cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY="}}},"title":"Substituter"}},"parallelbuilds":{"type":"boolean","description":"Aktiviert parallele Builds","example":true},"command":{"type":"string","description":"Auszuführender Build-Befehl","example":"nix build"}},"additionalProperties":false,"title":"BuildOptions"}},"additionalProperties":true,"title":"buildJob"}}},"receive":{"description":"Server-Antworten wie Status, Logs oder Fehler."}}}}}} | ||
| > | ||
|
|
||
| </StatusCodes> | ||
|
|
||
|
|
||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.