Autogenerate rest api docs

Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com>
This commit is contained in:
Joshua Castle committed 2024-03-12 00:35:02 -07:00
1 parent c441639de7
commit ef727cf6db
33 files changed
+8446 -55

No files matched your search

+157
View File
@@ -0,0 +1,157 @@
---
id: build-latest
title: "Gets information related to a specific build."
description: "Gets information related to a specific build."
sidebar_label: "Gets information related to a specific build."
hide_title: true
hide_table_of_contents: true
api: eJydVE1v2zAM/SsGTw2qxFl3mi5BgG1dgWEr1u4U+KBYTKxOllRJzpq5/u8DFSXpx1Zs9cUSRVPvPT66hyjWAfgCNuiDsma87JSW49qa6K3W6KFiYB16EZU1FxI4pIzPImKIwMAJL1qM6KlKD0a0CByctzdY07kytBWxAQYSQ+2Vo0rA4brBIucVSqKJaqXQT4CBx9tOeZTAo++QQagbbAXwngpF9PT1Qox/VafAIG4d3RiiV2YNAwO8E63TFFvjNqCHgR1wZZYv4poXOauwqyIeQf4rspMZ10md+8V0/G5SnY5nJzPuPN5ffZlfXn36ej2iQD4czUaz5yyGiu4KzpqAgcq/nZ7R6zHSj7YzEhhQt9BEShDOaVWnZpU3gbL6ByDzLXaZmjPQ85T9OcZQKLOyvk1VCo/ERhbRFqIIDmu1UnWRTECKtBgbK5PYOzvEBjiUm7MyyxbKPq+GMgsbyj6vhjIVCqXe+ymg3+zN1HkNHJoYXeBlKe1Po62Qk11b23pi/RpIKYKb6KmY+v4+Z4ZifnkB7NB1Dm8m08mUTOJsiK1I8mRr/C/xR7IdpI14F0unhTJ0SyLQZ1EWsDkjhbIswIAfx2SvDEWPJt2JAwyyPBWDxoZItfp+KQJ+93oYKHzbod8CX1QMNsIrsSQhFj1IFWgtga+EDvgM9sE6cPIte3tU/H0y/8gyB4XZEhGhO9oBgx+4ffAroCl8FZqX5vEVePbqDtXAoEEh0SeldqfzukYXH3z3bKDIcAfTn3+4hmH4DX1kzFw=
sidebar_class_name: "get api-method"
info_path: api/downloads/downloads-api
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Gets information related to a specific build.
</h1>
<MethodEndpoint
method={"get"}
path={"/v2/projects/{project}/versions/{version}/builds/latest"}
>
</MethodEndpoint>
Gets information related to a specific build.
## Request
<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"project","in":"path","description":"The project identifier.","required":true,"schema":{"pattern":"[a-z]+","type":"string"},"example":"geyser"}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"version","in":"path","description":"A version of the project.","required":true,"schema":{"pattern":"(?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?","type":"string"}}}
>
</ParamsItem>
</ul>
</div>
</details><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"302"}
value={"302"}
>
<div>
Found
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<div
style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}
>
object
</div>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>
+364
View File
@@ -0,0 +1,364 @@
---
id: build-specific
title: "Gets information related to a specific build."
description: "Gets information related to a specific build."
sidebar_label: "Gets information related to a specific build."
hide_title: true
hide_table_of_contents: true
api: eJytVt9z4jYQ/lc8+5TMGWwgIeAXJv0x6U1neplL+sQxN4u1BqW25JMEPerz/95Z2RAohFzTPtleSbvffvtp1xU4XFhIprAmY6VWnflK5qKTauWMznMyMAtBl2TQSa3eC0jA73goKZWZTCGEEg0W5MiwnwoUFgQJlEY/UeogBKn4E90SQhBkUyNL9gUJPC4paPcFUpByMpNkuhCCoS8raUhA4syKQrDpkgqEpGJHjgyfnmLnr9k7CMFtSo5onZFqAXUI9BWLMmfbgjaWDNThDleb51lct0G7K9BZ4J5Bfi+yi0mSoyPrvk3jzrg7e9eZXEyS0tC3h99u7x9++fB4yYZ28XJyOTnOYg+yJ/wVwH7PFm6L/jzcNp5UjhZkIIRMmwJdYxr0oa5nfNyWWlmyfKIfx/w4DP3hVwiB5ULK8SqWZS5Tr5boyfKW6jionrfaKA1ry8kmQEvzZym+q9InC71z0pBXnTlztzuzFcX/XcX9aP1urxtzsKacB6E+fRJ76b1Ykj13g7gOwcnTKe6OCXTU8bvqENIlKkX5SU7UquAmICjDVe58oJKMLEg5zGHW0FpoR2Lv+FzrnFBtfS+aIraLaAxuWLSOCvt66VNdFNIdY6tDsKuiQLM5uVaQtbg4QULt6XGe+R89OG8S+k+VaxQnEaEQknWL+f0BtvPItzo7lCuL4nPnFdE2Auw8lHKhXfcJvRbtEvvXwyOPWdwZz6rhVX3W45jS9GZwc5X2e70Y45ubbJj2R6MMr1BcD3A46vXTeCyuh+NYIMXzdDy8jkfZeDAWV+l8hAe8/dSSBfW+9QeW78e2L/CS5/WgJ9yRs4FUjQy5jRrimyQCpwMMbDs6mp7FTaogt9TC32LPL7e4BKJ1P2ovs42q9q2O2rtqo6p9qyPvyEaVfzJBlsx6O49WJocEls6VNomirQC6TcMo0q42C+BWx3h9tf+RvQ1u79/DXo+AXjdubnKprStQPavgX2d+wNtOaY6+uqjMUfq75ROoWlamsO7DrslZCCF5nrRbatj6POcadtjWdJ5ZCEttHfuqqjla+t3kdc3mLyviezadhbBGI3HOREwrENLyu4Akw9zSEexd+4eLj+28uQxeHu4ns9y2DcVNY435ir8ghD9os/c3wVPxTWjOjfQ34Nmy+x/wvDSx34CmqWvNbXpJKMj4qjVrt2lKpds7dTSgWfy7G3j38yPU9d+4cWKf
sidebar_class_name: "get api-method"
info_path: api/downloads/downloads-api
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Gets information related to a specific build.
</h1>
<MethodEndpoint
method={"get"}
path={"/v2/projects/{project}/versions/{version}/builds/{build}"}
>
</MethodEndpoint>
Gets information related to a specific build.
## Request
<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"project","in":"path","description":"The project identifier.","required":true,"schema":{"pattern":"[a-z]+","type":"string"},"example":"geyser"}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"version","in":"path","description":"A version of the project.","required":true,"schema":{"pattern":"(?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?","type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"build","in":"path","description":"A build of the version.","required":true,"schema":{"type":"integer","format":"int32"}}}
>
</ParamsItem>
</ul>
</div>
</details><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
>
<div>
OK
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"project_id"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** Value must match regular expression `[a-z]+`"}
schema={{"pattern":"[a-z]+","type":"string","example":"geyser"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"project_name"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"Geyser"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"version"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** Value must match regular expression `(?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?`"}
schema={{"pattern":"(?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?","type":"string","example":"2.1.0"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"build"}
required={false}
schemaName={"int32"}
qualifierMessage={"**Possible values:** Value must match regular expression `\\d+`"}
schema={{"pattern":"\\d+","type":"integer","format":"int32","example":30}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"time"}
required={false}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"channel"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** [`default`, `experimental`]"}
schema={{"type":"string","enum":["default","experimental"]}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"promoted"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
changes
</strong><span
className={"openapi-schema__name"}
>
object[]
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
>
Array [
</div>
</li><SchemaItem
collapsible={false}
name={"commit"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"summary"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"message"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
downloads
</strong><span
className={"openapi-schema__name"}
>
object
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
property name*
</strong><span
className={"openapi-schema__name"}
>
Download
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"name"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** Value must match regular expression `[a-z0-9._-]+`"}
schema={{"pattern":"[a-z0-9._-]+","type":"string","example":"Geyser-Spigot.jar"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"sha256"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** Value must match regular expression `[a-f0-9]{64}`"}
schema={{"pattern":"[a-f0-9]{64}","type":"string","example":"9ecc7374c2110a077f6c288fa4ad53a6812c09d5690dae0bc96508f939d4cb8a"}}
>
</SchemaItem>
</div>
</details>
</SchemaItem>
</div>
</details>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
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}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>
+401
View File
@@ -0,0 +1,401 @@
---
id: builds
title: "Gets all available builds for a project's version."
description: "Gets all available builds for a project's version."
sidebar_label: "Gets all available builds for a project's version."
hide_title: true
hide_table_of_contents: true
api: eJytVttu4zYQ/RVhXppgJUu2E8fWi5FekC4KdINN2hevsRiLI5spRWpJ2l1Xq38vSEm+1K53kfbJ1JAzPDw8POMKLC4NpDPYkDZcyWix5oKZKFPSaiUEaZiHoErSaLmSbxmk0CyBEErUWJAl7SpUILEgSKHU6oUyCyFw6T7RriAERibTvHRFIIXnFQXtuoAzkpbnnHQPQtD0ac01MUitXlMIJltRgZBWrpAl7bJnGP01fwMh2G3pdjRWc7mEOgT6jEUpXGxJW0Ma6nCHqz3hRVz3QbsqUHlg9yC/FdnVNBVoydgvsySa9OZvounVNC01fXn69f7x6ed3z9cu0E5eT6+np6eo524vUyppyLjygyRxP8dI3/0CIbhbImndLJal4Jm/pPjFuCXVAcJ2C7Vob6bU7kotbzZoD/mRs2/i+SzNuyIN29WFnIddTncl/zeHh7sNev1e4jZrZbuHhlrj1snBUmG+zpLPP4b64QM7oIdLS0vSEEKudIG2CQ0Hh3CGSR2C5ecp2qUxtBT5VXUI2QqlJHGWU7ku3ONllONaWL9RSZoXJC0KmDfXUihL7CB9oZQglF3tJf0HUjJVFNyeYqtDMOuiQL09O1eQMbg8Q0Lt6bH+5n7w4HyIqT+lUMjOIkLGuNM9iscjbJeRdzo9lrsT1cfoK6JvBBw9lXypbO8FvZbNCge3o5OKeRJN5tXopr5YcUJZdje8u8kG/X6Cyd1dPsoG43GON8huhzga9wdZMmG3o0nCkJJFNhndJuN8Mpywm2wxxiPefmzJgvow+nvz1r73Kj6a8SHzvrUcN+cpP7KbB7ImQCEC3CAXuBAUNO8pyJUOsPPJ70xnoM4xC7IrxbxLeP6d46YQbwZxu9zEVTuq4zbPxFU7quNdozGkN12XWWsBKaysLU0ax50weo0RFVlP6SU4C+UyV14F/2DFBPePb+HAe6DfSxqHKJWxBcq9Ol537CPmdjK09NnGpUDuH54/RdVSMoPNAHYO6g6c7ptox4uL7ltYS808hJUy1pWoqgUa+k2LunbhT2tyb282D2GDmjvonj7GjRszSHMUhk7Q7loKXL1vG9518O/t+uzhOiuRzkg2KNbuC0L4g7YH/w9ca34VmktN+hV4OlJrZ5crQkbaM9XM3mcZlfYg76TROrHtlP7w0zPU9d+YFyNj
sidebar_class_name: "get api-method"
info_path: api/downloads/downloads-api
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Gets all available builds for a project's version.
</h1>
<MethodEndpoint
method={"get"}
path={"/v2/projects/{project}/versions/{version}/builds"}
>
</MethodEndpoint>
Gets all available builds for a project's version.
## Request
<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"project","in":"path","description":"The project identifier.","required":true,"schema":{"pattern":"[a-z]+","type":"string"},"example":"geyser"}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"version","in":"path","description":"A version of the project.","required":true,"schema":{"pattern":"(?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?","type":"string"}}}
>
</ParamsItem>
</ul>
</div>
</details><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
>
<div>
OK
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"project_id"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** Value must match regular expression `[a-z]+`"}
schema={{"pattern":"[a-z]+","type":"string","example":"geyser"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"project_name"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"Geyser"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"version"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** Value must match regular expression `(?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?`"}
schema={{"pattern":"(?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?","type":"string","example":"2.1.0"}}
>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
builds
</strong><span
className={"openapi-schema__name"}
>
object[]
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
>
Array [
</div>
</li><SchemaItem
collapsible={false}
name={"build"}
required={false}
schemaName={"int32"}
qualifierMessage={"**Possible values:** Value must match regular expression `\\d+`"}
schema={{"pattern":"\\d+","type":"integer","format":"int32","example":30}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"time"}
required={false}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"channel"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** [`default`, `experimental`]"}
schema={{"type":"string","enum":["default","experimental"]}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"promoted"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
changes
</strong><span
className={"openapi-schema__name"}
>
object[]
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
>
Array [
</div>
</li><SchemaItem
collapsible={false}
name={"commit"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"summary"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"message"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
downloads
</strong><span
className={"openapi-schema__name"}
>
object
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
property name*
</strong><span
className={"openapi-schema__name"}
>
Download
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"name"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** Value must match regular expression `[a-z0-9._-]+`"}
schema={{"pattern":"[a-z0-9._-]+","type":"string","example":"Geyser-Spigot.jar"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"sha256"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** Value must match regular expression `[a-f0-9]{64}`"}
schema={{"pattern":"[a-f0-9]{64}","type":"string","example":"9ecc7374c2110a077f6c288fa4ad53a6812c09d5690dae0bc96508f939d4cb8a"}}
>
</SchemaItem>
</div>
</details>
</SchemaItem>
</div>
</details>
</SchemaItem><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</div>
</details>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
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}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>
+162
View File
@@ -0,0 +1,162 @@
---
id: download-latest
title: "Downloads the given file from a build's data."
description: "Downloads the given file from a build's data."
sidebar_label: "Downloads the given file from a build's data."
hide_title: true
hide_table_of_contents: true
api: eJylVMtu2zAQ/BVhL40R2nLTU3kxDPQVoGiDJr3UEApaWltMKZIhKTeuon8vVqZkp3m0SX0xtVxyZ2aH20AQaw98AYX5qZURxTg3OjijFDrIGBiLTgRp9GkBfEj6KAL6AAyscKLCgI7uaECLCoGDdeYSc9qXmj5FKIFBgT530tJlwOGixCTmJbJAHeRKopsAA4dXtXRYAA+uRgY+L7ESwBu6KKCj0wsx/pUdA4OwtVTRByf1GloGeC0qqyi2xq1HBy0bcG3Qear+GK55ErMSs0rCHuS/IjuacdWpc7OYjl9PsuPx7GjGrcOb80/zs/MPny9GFIibo9lodpfFAeRe8b9g7tN60MtaquIpYs7H3wjR9/F9qrYZXeSt0R49nX01PaG/2yjemVoTTjIQ6kAJwlol884/6aWnrOYAQaxilp1ZWvr9yexN5OU7Vmu5QZ2spMJk5UyViB3PFz4pRBBEt8JQmqJr/s6eoQQO6eYkjW30aRNXbRob7dMmrtq0u8+nuw6mvao+bfplCww8uk3v+Nop4FCGYD1PhwOTnfeqfGLcGkg+qVem4yxDZ849sfnZKbDBmhxeTqaTKTnZGh8q0WkWzfBUNW5pOegd8DqkVgmpqUpHoIlKLWBzQrJFrYAB37/lXi6K7l/STjFgoPqZMKhGiYN/Mwal8YFqNM1SePzqVNtS+KpGtwW+yBhshJNiSQItGiikp3UBfCWUxzt0Bp/B0Zfo8lHy8Fi5l30MCr0lgkLV9AUMfuD2YI7Re3wWmseGyTPw9Kr/B54HB8Uz4Ay9bbOWQYmiQNd1brc9z3O04eDgnWlAD2N4se/fXkDb/gZOgTrb
sidebar_class_name: "get api-method"
info_path: api/downloads/downloads-api
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Downloads the given file from a build's data.
</h1>
<MethodEndpoint
method={"get"}
path={"/v2/projects/{project}/versions/{version}/builds/latest/downloads/{download}"}
>
</MethodEndpoint>
Downloads the given file from a build's data.
## Request
<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"project","in":"path","description":"The project identifier.","required":true,"schema":{"pattern":"[a-z]+","type":"string"},"example":"geyser"}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"version","in":"path","description":"A version of the project.","required":true,"schema":{"pattern":"(?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?","type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"download","in":"path","description":"A download of the build.","required":true,"schema":{"pattern":"[a-zA-Z0-9._-]+","type":"string"}}}
>
</ParamsItem>
</ul>
</div>
</details><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"302"}
value={"302"}
>
<div>
Found
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<div
style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}
>
object
</div>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>
@@ -0,0 +1,310 @@
---
id: download-specific
title: "Downloads the given file from a build's data."
description: "Downloads the given file from a build's data."
sidebar_label: "Downloads the given file from a build's data."
hide_title: true
hide_table_of_contents: true
api: eJylVd1z2zYM/1dweFnSylaWPU0vOd/a23L7aG/JXubz7WARsthRpErCTl1V//uOlOQk5yRd0idRID5++AEEOhTaBCyWqNyNNY7UrHRWvDOGPa4ydC17Eu3spcLioHTVcqkrXWKGLXlqWNhHLx1aahgLbL37wKVghtrGX5IaM1QcSq/b6A4LvK4ZRj3Qiq3oSrOfY4aeP261Z4WF+C1nGMqaG8Kii46EfbRe0uzz6jVmKPs2Rgzitd1gnyF/oqY1UbbhfWCPfXbAtWMfYvSncC1g1AJXgdyC/L/ITi4KQ8JBvizPZj/OV69nFycXRev5y9Ufi/dXv7y7Po2C8fL04vTiOIs7kNdbbdRXACedCe6I/mm4YzxthTfsMcPK+YZkEP1wfg/BVPWvgJjUJhwJ1HPKuZj9HTn5Z/ZQXftVdBRaZwOHaHt+dhY/91G8+xUzrJlU6scO317T5lhrYe80HFTOA0EYW/pu8Qk8B7f1Jc/hUsCwBCiprDnAmqFxnoGrSpearQBZBYF2DGuy6kYrqTOgAAQ3vIbAfscelOMA1glYZgXion+2CgiqrTEw5Qd6YDA+xei6psGqrMluOHEaZJ9aPOjU6w+U9raV8KfBz+yNDq0LemDhiBQYeANtlS5JtN2A1CT3kOgA/KnlUgb4awalQ2tozyola4FEqKwbtpIN5jocOiMqjSwpMK4kY/bPTuY3CjL73alYPHWcRpwqioRTJNENAwnc1LqsUyLO6422Uz3WbDTvOKSrqdZwQwEMBYFmjPJMjH2GI1/xltrWJD6dzT+EgfkjW7dO4zKavspfPa2SAtxP+s1I8JDIRu/YQqUNQ+VdAzQ8xe9CJIZiMg1L7VSakJJmuNRYYL47z8dZF/JuPPX5+CBC3o2nPk/+Qt6lb59P9Q15Nx37yFAiedgLW2+wwFqkDUV+MJgPE7op585vMD5xbSuXktaS6L7NbPH+ErPDAC/w+/nZ/CzO+9YFaSjxOg6s59Jxj8wD4cKfJG8NaRujpAS6kaol7s4jbyNZmGFxu/EmvqL0dt8MlEXZNNAPrEXhYcauMqxdkBij69YU+C9v+j6KP27Z77FYrjLckde0jgQtO1Q6xLPCoiIT+CidQy/iyZ/jJD6Fx5fvg9mPQrL7mCCZbfzDDP/l/Z1tH3fGi9A8tXJfgGdi/RvwPLZRX4BmqPc3YHl0sb4AzKHP+lU/bcrURcP1oiy5lTuGR9MrPtLD+Pj57TX2/X/djILC
sidebar_class_name: "get api-method"
info_path: api/downloads/downloads-api
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Downloads the given file from a build's data.
</h1>
<MethodEndpoint
method={"get"}
path={"/v2/projects/{project}/versions/{version}/builds/{build}/downloads/{download}"}
>
</MethodEndpoint>
Downloads the given file from a build's data.
## Request
<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"project","in":"path","description":"The project identifier.","required":true,"schema":{"pattern":"[a-z]+","type":"string"},"example":"geyser"}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"version","in":"path","description":"A version of the project.","required":true,"schema":{"pattern":"(?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?","type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"build","in":"path","description":"A build of the version.","required":true,"schema":{"type":"integer","format":"int32"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"download","in":"path","description":"A download of the build.","required":true,"schema":{"pattern":"[a-zA-Z0-9._-]+","type":"string"}}}
>
</ParamsItem>
</ul>
</div>
</details><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
>
<div>
OK
</div><details
style={{"textAlign":"left","marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collaposed={true}
open={false}
>
<summary
style={{}}
>
<strong>
Response Headers
</strong>
</summary><ul
style={{"marginLeft":"1rem"}}
>
<li
className={"schemaItem"}
>
<summary
style={{}}
>
<strong>
ETag
</strong><span
style={{"opacity":"0.6"}}
>
string
</span>
</summary><div>
<div
style={{"marginTop":".5rem","marginBottom":".5rem"}}
>
An identifier for a specific version of a resource. It lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content has not changed.
</div>
</div>
</li><li
className={"schemaItem"}
>
<summary
style={{}}
>
<strong>
Content-Disposition
</strong><span
style={{"opacity":"0.6"}}
>
string
</span>
</summary><div>
<div
style={{"marginTop":".5rem","marginBottom":".5rem"}}
>
A header indicating that the content is expected to be displayed as an attachment, that is downloaded and saved locally.
</div>
</div>
</li><li
className={"schemaItem"}
>
<summary
style={{}}
>
<strong>
Last-Modified
</strong><span
style={{"opacity":"0.6"}}
>
string
</span>
</summary><div>
<div
style={{"marginTop":".5rem","marginBottom":".5rem"}}
>
The date and time at which the origin server believes the resource was last modified.
</div>
</div>
</li>
</ul>
</details><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<div
style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}
>
object
</div>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem><TabItem
label={"*/*"}
value={"*/*"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<div
style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}
>
object
</div>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>
+33
View File
@@ -0,0 +1,33 @@
---
id: downloads-api
title: "Downloads API"
description: ""
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---
import ApiLogo from "@theme/ApiLogo";
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"}
>
Version: 1.0.0
</span>
<h1
className={"openapi__heading"}
>
Downloads API
</h1>
+171
View File
@@ -0,0 +1,171 @@
---
id: project
title: "Gets information about a project."
description: "Gets information about a project."
sidebar_label: "Gets information about a project."
hide_title: true
hide_table_of_contents: true
api: eJyNU8Fu2zAM/RXjnTZMjbMcfSuwISh2WFF0pyAYFJuN1dmSS9FZM8P/PtB2jATphp4si+TTe49kB7H7iGyDhsMz5XKTBy8cqooYW4PQEFtxwd8VyE45MGgs25qEWGs7eFvTRdx5/bVSwqCgmLNrFAUZHktKprzEFeTFPTniBQyYXlrHVCATbskg5iXVFlmnQEKs1Rt782f7CQZybPTFKOz8Hr0Bvdq6qfRuT8dIjH6rkLEJPlJUlNVyqZ9LOt+/wUA1kxeN2qapXD5ITp+jpnRnRKZXw+5kA6tB4sYHJlk/XfEu0m9xNjPIaGn3n5r1XHMgji74eJZvme1RGyFUx2ucvu8NxMkAdD8++TCZpUENXxq1JomJ80+B68GdxO5CK4k9NVM7WJOUoRjkjEMiJTKkh1U6JcW0m049DCLx4TRBLVfIUIo0MUvTIvz2VbDFYvSlzheB90NHlcEgZ+L+ZcqMye39HWYrkOHzYrlYDo6GKLUdOjnN6Xu0XKif7RN6lbSprPOKPJDuJp0bHFaY+xdhkJ32YWtQhiia03U7G+kHV32v1y8t8RHZZmtwsOzsTkVtOhQu6rlA9mSrSFd05onFh4dpbT4m/16tN9mfJsXrnBxs1eofDH7R8WyX+21vUJItiAdmY/Q2z6mRs7qrvdFmzfOw/vqIvv8LZxiEXw==
sidebar_class_name: "get api-method"
info_path: api/downloads/downloads-api
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Gets information about a project.
</h1>
<MethodEndpoint
method={"get"}
path={"/v2/projects/{project}"}
>
</MethodEndpoint>
Gets information about a project.
## Request
<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"project","in":"path","description":"The project identifier.","required":true,"schema":{"pattern":"[a-z]+","type":"string"},"example":"geyser"}}
>
</ParamsItem>
</ul>
</div>
</details><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
>
<div>
OK
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"project_id"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** Value must match regular expression `[a-z]+`"}
schema={{"pattern":"[a-z]+","type":"string","example":"geyser"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"project_name"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"Geyser"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"versions"}
required={false}
schemaName={"string[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string"}}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"project_id\": \"geyser\",\n \"project_name\": \"Geyser\",\n \"versions\": [\n \"string\"\n ]\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>
+129
View File
@@ -0,0 +1,129 @@
---
id: projects
title: "Gets a list of all available projects."
description: "Gets a list of all available projects."
sidebar_label: "Gets a list of all available projects."
hide_title: true
hide_table_of_contents: true
api: eJyVUj1v2zAQ/SvCmxnJ9cgtQIsg6NAgaCfDw1m6SEwpkSXPagWB/7042XWTbp1I3j3e+yBXCPUZ9oCYwiu3ku/aMEkK3nPC0SBETiQuTI8d7A0Eg8Q5hilzhl2x3+106Ti3yUWFw+LLZxjoNJ5EuxSjd+02rHnNClmR24FH0p0skWERTkoAo1SRk7gLwY34L5JSogUGTnh8W8+S3NSjlGIgTrzWnq7Xn6+itav994IfWHJFlXdZqvBSkfcVzeQ8nTxXfxTUMBhZhqB59LxJJRlg0cz75k1AmdPMSbNdcU4eFoNIzLZpuvBz8oG6uuclcxrbOqQe5WjgppewWbnq/nhF5ur+6REGOvCi9UO9q3coBjFkGWkLc6KR/8fGO/e3/IR/SRM9uUnHb8rXq8UD5v3laS4mjwZDyKKNdT1R5m/Jl6LlH2dOC+zhaDBTckqtp2IwMHWctlS+8wKL+7blqDHO5M/bw/77TzSZW+QPn76ilN9O0+6q
sidebar_class_name: "get api-method"
info_path: api/downloads/downloads-api
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Gets a list of all available projects.
</h1>
<MethodEndpoint
method={"get"}
path={"/v2/projects"}
>
</MethodEndpoint>
Gets a list of all available projects.
## Request
<div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
>
<div>
OK
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"projects"}
required={false}
schemaName={"string[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string"}}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"projects\": [\n \"string\"\n ]\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>
+185
View File
@@ -0,0 +1,185 @@
---
id: version
title: "Gets information about a version."
description: "Gets information about a version."
sidebar_label: "Gets information about a version."
hide_title: true
hide_table_of_contents: true
api: eJytVE1v2zAM/SsGTw2q2Gl2mi9BgA1dMWAt2m6XwBgUm4nV2ZYq0Vkz1/+9oC27KfqBotjJMimSj3xPbIDk1kG8gh1ap3Q1TXVFVhcFWkgEaINWktLVWQbxcAcEGGlliYSWYxuoZIkQg7H6BlMCAariX0k5CMjQpVYZzgIxXOcY+HuByrAitVFoQxBg8bZWFjOIydYowKU5lhLihhMRWo5eyem/5BgE0N5wRUdWVVtoBeCdLE3Bti3uHVpoxYjrEffruJaBvxXoTUCPIN+L7GgRF5LQ0f1qNv0cJsfTxdEiNhbvr34sL66+nV9P2OCdk8Vk8byLNuFazujKoeP089mMP0+Rnn8HAUwTVsReaUyh0o6l6MbxleYAoS+h154ZY5lTUn0B3+Rvlb1rzi+OeUzST7t5I+Z0jBko+d8zPKw2D0/CGRdb16rI3AE0aa3csxwIy0O7qgi3aEHARttSUm/6NIe2bQWQoi7vrx77pWeKnex+ytIpkgtU1edhWcm1rimQg8xYVyVSrrNulh01rMsYot088iN1UeNPbeTjXNT4UwsCHNrd8AhrW0AMOZFxcRRl+m9VaJmFPU9lGmq7BVYYg+p69u188TddsLw4gwNq4CSc9QM02lEpO7b8k3pPe08GMs6Y8I4iU0hVceYOdONbX8FuDqOeHAiIH1fK0D9bB4iJgFw74simWUuHP23Rtmy+rdHuIV4lAnbSKrnmVlcNZMrxOYN4IwuHz0CO7wqOLv2rnwSv76wXexpEVrHEdrKo+Q8E/MH9wZLk/fQhNG9tqg/gGWbZJq2AHGWGtptU712mKRo6iHu2bVhSo5BPv15D2z4AzkkjVQ==
sidebar_class_name: "get api-method"
info_path: api/downloads/downloads-api
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Gets information about a version.
</h1>
<MethodEndpoint
method={"get"}
path={"/v2/projects/{project}/versions/{version}"}
>
</MethodEndpoint>
Gets information about a version.
## Request
<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"project","in":"path","description":"The project identifier.","required":true,"schema":{"pattern":"[a-z]+","type":"string"},"example":"geyser"}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"version","in":"path","description":"A version of the project.","required":true,"schema":{"pattern":"(?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?","type":"string"}}}
>
</ParamsItem>
</ul>
</div>
</details><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
>
<div>
OK
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"project_id"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** Value must match regular expression `[a-z]+`"}
schema={{"pattern":"[a-z]+","type":"string","example":"geyser"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"project_name"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"Geyser"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"version"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** Value must match regular expression `(?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?`"}
schema={{"pattern":"(?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?","type":"string","example":"2.1.0"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"builds"}
required={false}
schemaName={"int32[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"integer","format":"int32"}}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"project_id\": \"geyser\",\n \"project_name\": \"Geyser\",\n \"version\": \"2.1.0\",\n \"builds\": [\n 0\n ]\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>