Autogenerate rest api docs
Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com>
This commit is contained in:
33 files changed
+8446
-55
No files matched your search
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -0,0 +1,69 @@
|
||||
---
|
||||
id: global-api-web-api-health-controller-health
|
||||
title: "Simple server online check"
|
||||
description: "Simple server online check"
|
||||
sidebar_label: "Simple server online check"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyFkDFPwzAQhf9KdLOVlIopW4VQYaaIAXW4pEdt1bHN+VpRRf7v6JJSFRYmyyd9T+97I/TofYf9IUM7FgMxEaO4GJ530MLaxw79Krk36upVcvUToRf7EINw9J64ttMBDCRkHEiIM7TvWwNMOcWQSXNhubjXZ0e5Z5c0HlrYWKoy8Ym4crmKwbtAUIoBwb2GwCV7a/6AL25I/srOYNVb6g9gYCCxUbvvSaZaYqGF5tpzpjR/hCN7aMGKpNw2DSZX7+mciYe+jrwHAydkh52fJErZKt0f2cl5dnThI6qXOPF0nataJacscZ773tWLegnFQIpZBgyKBBzoP5Vf1iPIOSki9CVN8uiCRk4K40XzdjIbs+hlHDvM9Mq+FD1/Hokv7X/k9Fduhls/bqCUb/JauCM=
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
Simple server online check
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/health"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Simple server online check
|
||||
|
||||
## Request
|
||||
|
||||
<div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"204"}
|
||||
value={"204"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
The server is online
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,97 @@
|
||||
---
|
||||
id: global-api-web-api-link-controller-get-bedrock-link-v-1
|
||||
title: "GlobalApiWeb.Api.LinkController.get_bedrock_link_v1"
|
||||
description: "GlobalApiWeb.Api.LinkController.get_bedrock_link_v1"
|
||||
sidebar_label: "GlobalApiWeb.Api.LinkController.get_bedrock_link_v1"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydkk2L2zAQhv+KeU8tCDufZatb+sFS6Km09BBCkO1ZW0SWtJIcEoz+e5HjbDbbnnqyLd6R53lmBlRCqVJUBw8+RIaarKNKBKrBg+uJwVhyIkijv9XgeFSmFGpj5W8q842V+XepD5+NDs4oRS5vKOxLqp2pDnsl9WF/nIPBCic6CuQ8+HZATb5y0qZLwfHpEs9OvazBQCfRWUXgWKyX69VyMf/4YbZ6eFiuwSBTgRWhBYMWXUpNZY6ee+lubfuqpU6ADwhnm3I+OKkbxLhLYW+N9pSgsZrN0uO+qS83DzEyBNGk1pGQsGNvwv8npaPQmuS0oTA6Ci04iuO8SJliKiiGBBjB4MkdrwZ7p8DRhmA9LwphZd7Q2ZPrqty4BgxH4aQo1Ug4InuqeifDGXy7Sx6fzOhGhlH1hSDbWJlqyfkL2Dyf5QtEBmt86IROJZP2W0X2mjq7x84miiwhZSP2nbqX6QQ6hcIqIXX63Yg3TEq2GOtG9QzThWDg4+R3DK3xIcWGoRSefjkVYzp+7slNuFcbl+2TPr3X4E9Cefqro8roQDqA492PaaneZ2+W9J9dT4dCn8cBqD59geFA5+uexl18NfjHrz8R4x+wDjDB
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
GlobalApiWeb.Api.LinkController.get_bedrock_link_v1
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/v1/link/bedrock/{xuid}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
:::caution deprecated
|
||||
|
||||
|
||||
|
||||
:::
|
||||
|
||||
GlobalApiWeb.Api.LinkController.get_bedrock_link_v1
|
||||
|
||||
## 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={{"description":"Bedrock xuid","example":"2535432196048835","in":"path","name":"xuid","required":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Deprecated
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,253 @@
|
||||
---
|
||||
id: global-api-web-api-link-controller-get-bedrock-link-v-2
|
||||
title: "Get linked Java account from Bedrock xuid"
|
||||
description: "Get linked Java account from Bedrock xuid"
|
||||
sidebar_label: "Get linked Java account from Bedrock xuid"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJylVU1v4zYQ/SvEnLqAYju2k3V0c9tFsEXRQ5Ggh8AIxtTYYkyRXJJyYxj674uhJMdfwHbRk75m5s17M3zag0Stlyg3AfJ9k4F15DEqa74WkMOjtkvUc6f+oeVg7tTgT2U2v1kTvdWa/GBN8XVJhbdy86qV2bxux5CBQ48VRfIB8pc9FBSkV46LQg6/tuHivVYFZEDvWDlNkMP4bnI3nYxvH+5H09lscgcZKE5wGEvIwGDFUV2ap2+18lRAHn1NGQRZUoWQ7yHuHMeF6JVZQ9MsODg4awIxRRiPRnyR1kQykW/ROa1kIj18C9zk/qjeafdzwTTFkuK/REag+AO3KNAUAkXPDKW0tYkshGc5o2qRe6FUcVmXaQm7ErGkQx2ncUf+WKNziTJYWV9hhByUifdTyHr6ykRak4cmgzfc4lXM5+evv/eYicYlIBSTKS2n08839/QwupnKz7Obh/Hs9uZ+NCpWsxnS6pbHcWijbsdzNoSuiXaEF20E8vzlR608qWo8mlwrrjHEVPy1dgXGaxhGvYtKaa1CD8NJLVYCbzOFLElu4D/o2hzv4MvxbD8UP6Z9pctFBlHFxI2P1QeIXb6RjNAwyCkPjqOi37AgrBdoBFUu7kSbJVSi50moIIztQ9PaUsFqTf/XAXgkQ15J0QrEF+E8xbgTVS1LQVvyO0HeWw+nClUUAq4T69Nj0X+4gHoqqa0k+pCL2TcfEn7pMH+o4V82eY9w3m5VQQWLqMwWtSragrhm3wJWjLs9599r2R39Tt+Vt5U487aKYmnZRteU3ICNLIfhdjzkCsNuZ4Z7Dm8gg0B+25tm7TXkUMboQj4colODNe0C+UoOrF9DBlv0Cpc6aZhcLpCsvYo7yF8WbJ0rm+ywk6d1cjF3inPJh5bO7WA0GPNWOBtihWn0ndP+DNMTjQ4eHOk9Dp1GZRghMdp3KrxA+lPodu87JSCDPBVcZFDaEDlsv19ioGevm4Zff6vJdwx7Adp/jAp8X0C+Qh3ooqPDtsMvf3dL+emcxNWuu5dodklzXfMTZLChXf83ahZNBiVhQT710n6aS0kuHiVdnDIe2mFFHr88QdN8B2WxkM8=
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
Get linked Java account from Bedrock xuid
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/v2/link/bedrock/{xuid}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get linked Java account from Bedrock xuid
|
||||
|
||||
## 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={{"description":"Bedrock xuid","example":"2535432196048835","in":"path","name":"xuid","required":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Linked accounts or an empty object if there is no account linked
|
||||
|
||||
|
||||
</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={"bedrock_id"}
|
||||
required={true}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"xuid of the Bedrock player","example":2535432196048835,"format":"int64","type":"integer"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"java_id"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"UUID of the Java player","example":"d34eb447-6e90-4c78-9281-600df88aef1d","format":"uuid","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"java_name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"Username of the Java player","example":"Tim203","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"last_name_update"}
|
||||
required={true}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"Unix millis of the last Java name update check","format":"int64","type":"integer"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"bedrock_id\": 2535432196048835,\n \"java_id\": \"d34eb447-6e90-4c78-9281-600df88aef1d\",\n \"java_name\": \"Tim203\",\n \"last_name_update\": 0\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
No xuid provided or invalid
|
||||
|
||||
|
||||
</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={"message"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The error message","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"message\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,97 @@
|
||||
---
|
||||
id: global-api-web-api-link-controller-get-java-link-v-1
|
||||
title: "GlobalApiWeb.Api.LinkController.get_java_link_v1"
|
||||
description: "GlobalApiWeb.Api.LinkController.get_java_link_v1"
|
||||
sidebar_label: "GlobalApiWeb.Api.LinkController.get_java_link_v1"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydksFu2zAMhl/F+E8boNhJF7SpbsU6FB12GlbsEAQBYzOJFtlWJTloYOjdBzpJ02477WRbJil+H9mjJGtXVO4CdJ8UKnaeS4pcQUffsULr2FM0bfNYQePBtiuyd8785FV+50z+zTS7z20TfWst+3zDcfmL9rS0ptkt9xMoOPJUc2QfoOc9Kg6lN04qQuMr7Sl7enq8hwK/UO0sQ6P6NOXVdHozuubb8Wha3sxGt1ezyeh6PK7WsxnxelJBwUgFR3ELhYZqyew6I388P3fGXyBCueWaoHvEg5O4EL1pNkhpIcHBtU1gUYDpeCyP913eX6ykpBBpIywQRizUH8H/oajmuG1F74bjYCxuoVHsJ4XEFBJd9IKWoBDY788yO2+hsY3RBV0U5Ey+4UNgX5d56zdQ2JM3tLID2wAbuOy8iQfo+UIMrtvBiomD+GPv2Z0zkss+HJEm+Ti/QlJwbYg1NZJyEn7JyN7yZu+BM0HIBCYbgN8Zex1K5JdYOEumkbsGtv4kY44hbzCuINWgoIdpLxS2bYgS0/crCvzkbUpy/NyxP4GePRxX0AR5r6DXZAP/1U7ZNpGbCI0P30+L9DF7u6n/7Pd0SM1h8G47+YLCjg/nxUyL9GbYD19+IKXfOi4tNw==
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
GlobalApiWeb.Api.LinkController.get_java_link_v1
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/v1/link/java/{uuid}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
:::caution deprecated
|
||||
|
||||
|
||||
|
||||
:::
|
||||
|
||||
GlobalApiWeb.Api.LinkController.get_java_link_v1
|
||||
|
||||
## 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={{"description":"Java UUID","example":"d34eb447-6e90-4c78-9281-600df88aef1d","in":"path","name":"uuid","required":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Deprecated
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,265 @@
|
||||
---
|
||||
id: global-api-web-api-link-controller-get-java-link-v-2
|
||||
title: "Get linked Bedrock account from Java UUID"
|
||||
description: "Get linked Bedrock account from Java UUID"
|
||||
sidebar_label: "Get linked Bedrock account from Java UUID"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJylVd9v4kYQ/ldW89RKDhAgOeI32p6iq059OCXqQ4TQsB7whvXu3u6axkL+30+zxgQCUq/qE8bz65tvZj7vQaLWK5TbAPm+zcA68hiVNV8KyOFR2xXquVN/02owd2rwVZnt79ZEb7UmP9hQXL7iDpdame1yN4YMHHqsKJIPkL/soaAgvXKcEXL4E3conp+//AEZ0BtWThPkUEymtJpOP93c08PoZio/zW4exrPbm/vRqFjPZkjr2wIyUJzBYSwhA4MVR9a1Youn77XyVEAefU0ZBFlShZDvITaO/UL0ymygbRfsHJw1gbhhGI9G/COtiWQiP6JzWslEwfA1MOr9Sb7zdr4dUonOQaytFyi0ClHYtWBOAuOOVIXL4HlyECuK/xAZgSKRg6YQKH6jwlu5FSilrU1kWj1PJqoO9qqzL1VxmfetVgWXjyUd8ziNDflT0sd3k7vpZHz7cD+azmaTuwzW1lcYIQdl4v0Usp47ZSJtyEObQRr1tZo80r5mauOy4M9O+QjjMNsPEzyA6OZ/ASOQZ8u/QXlS1Xg0uZZcY4gp+bJ2BcZrNYx6E5XSWoW+DAd1tVLxLlLIkuQWfoLX9nSBX05n+874adtXUC4yiCqm3vhC34vY1SvJyJ2d2r+qEN990HtsoGUc562yKxX9EgpebiOocrERXV6hEgGehArC2KOnToFcdfq/7uuRDHklRUdhOi/nKcZGVLUsBe3IN4K8tx7OOawoBNwkXs4PpzdclHoqqcskepeL7Tgh8fOh5geWLyn8yya5E87bnSqoYBKV2aFWRZcQN6yTwIwx2o/991x+VASx9rYSp3JaUSwta/aGkl6wTuYw3I2HnGHI6zPc8021kEEgv+sVuvYacihjdCEfDtGpwYaaQL6SA+s3kMEOvcKVTgQmBQ0ka69iA/nLgmV5bZPUHrjpvhli7hTHkg9dL7eD0WDMK+FsiBWmuR9U/L+0eUbQUd8jvcWh06gMV0gd7Q8UvED6LOnuLJgGyCBP4rLIoLQhss9+v8JAz163Lb/+XpM/tNd3333NVODnAvI16kAXcI57Dr98O6zjr2fwr+Lt79A0iW1d8z/IYEtNr4Ptos2gJCzIJyCdaS4luXgSdHFcPK7jZjx+foK2/QF30a7G
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
Get linked Bedrock account from Java UUID
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/v2/link/java/{uuid}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get linked Bedrock account from Java UUID
|
||||
|
||||
## 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={{"description":"Java UUID","example":"d34eb447-6e90-4c78-9281-600df88aef1d","in":"path","name":"uuid","required":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Linked account or an empty object if there is no account linked
|
||||
|
||||
|
||||
</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"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"bedrock_id"}
|
||||
required={true}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"xuid of the Bedrock player","example":2535432196048835,"format":"int64","type":"integer"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"java_id"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"UUID of the Java player","example":"d34eb447-6e90-4c78-9281-600df88aef1d","format":"uuid","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"java_name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"Username of the Java player","example":"Tim203","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"last_name_update"}
|
||||
required={true}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"Unix millis of the last Java name update check","format":"int64","type":"integer"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"[\n {\n \"bedrock_id\": 2535432196048835,\n \"java_id\": \"d34eb447-6e90-4c78-9281-600df88aef1d\",\n \"java_name\": \"Tim203\",\n \"last_name_update\": 0\n }\n]"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
No UUID provided or invalid
|
||||
|
||||
|
||||
</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={"message"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The error message","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"message\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,93 @@
|
||||
---
|
||||
id: global-api-web-api-render-controller-get-front-texture
|
||||
title: "GlobalApiWeb.Api.RenderController.get_front_texture"
|
||||
description: "GlobalApiWeb.Api.RenderController.get_front_texture"
|
||||
sidebar_label: "GlobalApiWeb.Api.RenderController.get_front_texture"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydkk2L2zAQhv+KmVMLwrHzgTe6hVKW9ri09BBCkK1xLNaWtCM5bDD670WKt9l0e+rJ8uidGT3vzATGIgmvjP4mgcNjb2rR76z6hXW+syp/Qi2RvhjtyfQ9Un5Cf2zJaH/0+OpHQmBgBYkBPZIDvp9AomtI2VgUOHwXZ5HN2kxJYICvYrA9AgexLapt0WwqLB9KlOVKSJTlullXiMu2ah4krjarFRZlVYvtphJtVct2K9uylrhdt8BAxR5W+A4YaDHEqnOzY2pG+DIqQgnc04gMXNPhIIBP4C82qp0npU8QwiGKnTXaoYv3y6KIn3sa8wwhsL+C/+fagL4z0fQT+mSi74DDglLuIqkX040lAAOHdH5zeaQeOHTeW8cXC2FVfsKLQxqa3NAJGJwFKVH3CSbROWxGUv4CfH+IxrUm2aB8msUVIttZFXOR3JWtzIt8CYGBNc4PQseU2edbRnYPnt2TZ4klu5HfufdnEPF+YXuhdGyX8KbZlT1cXQEGqRYw4O+mfGDQGeejbppq4fAn9SHE8MuINPO+2XFdUeXiWQJvRe/ww5Maoz1qDxw+Pc0L9Dn7uMn/fPkcFPqShtCP8Q8YPOPlfjnDIbzbgsevPyCE38S8OIg=
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
GlobalApiWeb.Api.RenderController.get_front_texture
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/render/front/{texture_id}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
GlobalApiWeb.Api.RenderController.get_front_texture
|
||||
|
||||
## 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={{"description":"Java texture id","example":"a90790c57e181ed13aded14c47ee2f7c8de3533e017ba957af7bdf9df1bde94f","in":"path","name":"texture_id","required":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
ok
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,93 @@
|
||||
---
|
||||
id: global-api-web-api-render-controller-get-raw-texture
|
||||
title: "GlobalApiWeb.Api.RenderController.get_raw_texture"
|
||||
description: "GlobalApiWeb.Api.RenderController.get_raw_texture"
|
||||
sidebar_label: "GlobalApiWeb.Api.RenderController.get_raw_texture"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydkk1v2zAMhv+KwdMGCP7IB9zoFgxDsR2LDTsEQUBbdCzUtlRKThoY/u+DHHdp1p12kkSRot7n5QDGEqPXpvumQMJjYwpstlb/oiLeWh0/UaeIv5jOs2ka4vhI/sB4Pnh69T0TCLDI2JIndiB3AyhyJWsbngQJ3/GE0ZwbaQUC6BVb2xBIwE2ab9JynVP2kJHKlqhIZatylRMtqrx8ULRcL5eUZnmBm3WOVV6oaqOqrFC0WVUgQIceFn0NAjpsw6tzs8PUjOml10wKpOeeBLiyphZBDuAvNmQ7z7o7wjjuQ7KzpnPkwv0iTcNyr8Y8wziKv4L/w6wlX5sA/Eh+QuhrkJDwVJkwnpPhpmMEAY749Ea45wYk1N5bJ5MErY6PdHHEbRkbPoKAE7LGopmETMoclT1rfwG52wdolZkQaD/5cBUQba0OtcTuqiuL03gBowBrnG+xCyUz41tFdC86ulcdMZ6jm+o7bn8sCPeJbVB3odkkbpiJ7OBKJDiJZxAg37m7F1Ab50PWMBTo6Cc34xjCLz3xrPUNxXU0tQt7BbLCxtGHD5Wm89R5kPDpaR6cz9HHCf7nv+cgdpfJgKYPJxDwTJf7oRz34zv/H7/+gHH8DdnMNC0=
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
GlobalApiWeb.Api.RenderController.get_raw_texture
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/render/raw/{texture_id}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
GlobalApiWeb.Api.RenderController.get_raw_texture
|
||||
|
||||
## 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={{"description":"Java texture id","example":"a90790c57e181ed13aded14c47ee2f7c8de3533e017ba957af7bdf9df1bde94f","in":"path","name":"texture_id","required":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
ok
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,286 @@
|
||||
---
|
||||
id: global-api-web-api-skin-controller-get-recent-uploads-page
|
||||
title: "Get a list of the most recently uploaded skins"
|
||||
description: "Get a list of the most recently uploaded skins"
|
||||
sidebar_label: "Get a list of the most recently uploaded skins"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJylVdtu3EYM/RWCTwmgam2jT3ozktRI0QuQpuiDYRiUxJUmHs1MONQmi4X+vaCkXdux3SDoky7D6+HhmQM25H1NzV3G6jAVGBMLqYvhfYsVXvlYk79M7h+uy8vkyr/uXHgTg0r0nqXsWG+FGw56OyYfqc1loo6xwERCAytLxur6gC3nRlyywFjhH+NQs0DN+oU5wDn8BOYG3g1OS3jLWxq9ZtAI51ggf6UhecbqvEBn/om0xwIDDTx/zRmFP49OuMVKZeQCc9PzQFgdUPfJ7LKKCx1O040Z5xRDZusaL87O7NHEoBzUXikl75oZh82nbDUfHsR73MxvLivELQwxKyxg+D00MexYlFvIdy7kEv6UloVbqPcvWRpqYvirW+pqSed8TnnITxN/7HkJVVN2DbiwjXAEwaDLffwCBL/SjuYiIAbQniE75Se5XPt8gsd9gLMqVzxdUO5YcCpQ+auOwrcvRVnPwbUw5gWE313gRmir9wFPA3o4zGtcct5nuClQnRof8MMM4ptjjcbOD7xl4dDwfdxYf+JG5zqXHyRC+/k7KvlbI9AL+NIQxzCPdzYC2pHzVHt+BobpP+symjwtyZxemOqJIMtm3TPpFydZgT0PHBR6ylDbFp3MHnuzNqW1+vP/IvkVBxbXwDbKQGoPSMKqexjGpgfeseyBRaLg4+ENnLPt5823hDsePAv7HAmOJs8R5Ij0uzXnd3F9H3bkXbsITVgE6BWXXQmBO1K34wJabtxAvgCNETxJx6+XZNSZjKENwDr5FhsFAr/KgH5nfljgwNpHk9eOdZZK7bHCze5iYxabmluJzd1mCbA5WMUTFphZdkc9HcVjhb1qytVmQ8mVHe8zy9CUUToscEfijKezrJviZW5GcbrH6vrGZHQbZ2lcYVyEHi6TM1+WvLR2Xp6VF8aeFLMONFNkVd0f7voRaCdRtr3eJE8uWJq5rcOKyDXuLqxtA73AFZWZXpYCC6zSyqw+ZjX7w6GmzH+Lnyb7/XlkWfs9wrFcRi7be4vVlnzmJ6WddgRffVip/Bp+8M56tr2j/IT9PCE/2hcWeMf74z023UwF9kwty1zrcnTZNJz0gdOT3bURn3h19e4jTtO/hw+6VA==
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
Get a list of the most recently uploaded skins
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/v2/skin/bedrock/recent/{page}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get a list of the most recently uploaded skins
|
||||
|
||||
## 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={{"description":"Number between 1 - page limit. Defaults to 1","example":1,"in":"path","name":"page","required":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
The most recently uploaded skins. First element has been uploaded most recently etc.
|
||||
|
||||
|
||||
</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={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
data
|
||||
</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={"id"}
|
||||
required={true}
|
||||
schemaName={"integer"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The converted skin id","type":"integer"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"texture_id"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The texture id used by Minecraft","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"total_pages"}
|
||||
required={false}
|
||||
schemaName={"integer"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The amount of pages available","type":"integer"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"data\": [\n {\n \"id\": 0,\n \"texture_id\": \"string\"\n }\n ],\n \"total_pages\": 0\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid page number (e.g. negative, decimal, too large)
|
||||
|
||||
|
||||
</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={"message"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The error message","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"message\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,262 @@
|
||||
---
|
||||
id: global-api-web-api-skin-controller-get-recent-uploads
|
||||
title: "Get a list of the most recently uploaded skins"
|
||||
description: "Get a list of the most recently uploaded skins"
|
||||
sidebar_label: "Get a list of the most recently uploaded skins"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJylVMGO3DYM/RWBpxYwPJtFT74tgnSRoEWBNEUPi8WCljm2MrKkULRbY+B/LyjPZDDZ3QZoT7Ylko9875lHsOh9i/aQoTmuFcREjOJieN9BA/c+tujvkvuT2vouufr3gwtvYxCO3hPXPckTk6UgT1PyEbsMFTDlFEMmrQi3Nzf6sDEIBdFXTMk7WzB2n3MMepbtQCPqW0fZskt6Cw384rKYuDdjzGI2IL8YG8NMLNSZfHAh1+Y37oipM+3yWiRUkFhnE7f11aEUPCc05ufAnwbaSrWYnTUu7KNh+jI5hZFo8hD/Mmg+4IylCRODkYFMdkLPsFz3MsD1HMZpl7IkggZcEOqJYa1A6G+ZmJ5eq3K6N64zU95I+NUFsox7uRTMwi70sK6qzzYHNA+wYV4QHisQJ14zPhYS3557VOU/0p6YgqVL3dh+Jiulz+0AmXEp31HQPyXs6RV+cYxTKPKWIIMzOo+tpxdoWP+1L7XJ85Y06RVVvxpkc+3FST87zmLI00hBzIDZtEThEnadTWJrHfWn/2XyewrEzpp95BFFHyYxiSxmnOxgaCZeDDFHhmvxRsoZe1LRrg13vniR9lLJnENeMsiZ6XcnzO/y+j7M6F1XdDRhGlti8wPVfW0C9Shupsp0ZN2IvjISo/HIPf24gWGfdRgVQCf5lhsxaPxpDch39IMKRpIh6urqSS2RUAZoYDff7jRi11LH0R52WwGoIBPPxNrBESb20MAgknKz22FydU9LJh5tHbmHCmZkpwYtu3J91Gw7sZMFmofHCnRLKOdn/rbtae6S01zivM30pr6pb9U2KWYZsXgj4Ej/Zdwrto5npfSH3iWPLihMGet4ouIB5lsdW9mu4ERH8VUh5LGCIWbRuOOxxUx/sF9XPf4yEZ/mPNOgX2sFA2FHXBg80AIN3FlLSQpffio74du/Qbn7qtT9u0+wrv8AAelJYQ==
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
Get a list of the most recently uploaded skins
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/v2/skin/bedrock/recent"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get a list of the most recently uploaded skins
|
||||
|
||||
## Request
|
||||
|
||||
<div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
The most recently uploaded skins. First element has been uploaded most recently etc.
|
||||
|
||||
|
||||
</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={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
data
|
||||
</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={"id"}
|
||||
required={true}
|
||||
schemaName={"integer"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The converted skin id","type":"integer"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"texture_id"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The texture id used by Minecraft","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"total_pages"}
|
||||
required={false}
|
||||
schemaName={"integer"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The amount of pages available","type":"integer"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"data\": [\n {\n \"id\": 0,\n \"texture_id\": \"string\"\n }\n ],\n \"total_pages\": 0\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid page number (e.g. negative, decimal, too large)
|
||||
|
||||
|
||||
</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={"message"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The error message","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"message\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,262 @@
|
||||
---
|
||||
id: global-api-web-api-skin-controller-get-skin
|
||||
title: "Get the most recently converted skin of a Bedrock player"
|
||||
description: "Get the most recently converted skin of a Bedrock player"
|
||||
sidebar_label: "Get the most recently converted skin of a Bedrock player"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJylVcFu2zgQ/RViTi0g2KmTLFrdvN0gyAJ72XSxh8AIRtJYYk2R7HBkRDD07wtSktdOvGixPUkQOY9v3jw+HaBEYwosdwHyw5CB88Qo2tmHCnK4N65As/b6byoWa68XjzttPzsr7IwhXtQkz2GnLWTgkbElIQ6QPx2golCy9hEJcviVKnblTr10uoIM6AVbbwhyWN1e395crz58+uXq5uPH61vIQMcCj9JABhbbuGsqY/rWaaYKcuGOMghlQy1CfgDpfdwXhLWtYRg2cXPwzgaKfcHq6io+SmeFrMRX9N7oMnW6/BoiycMJ3jn731BQMXmmQFa0rRWq2LWSBkU1GFRBZFXp7J5YqFJoK9V547CiSolTv+Me1V2lE14GnqPKokduDYbm7ZlfGorIjXJbJQ2N5xW9UIDsdbsZ6PAchPb0FufhpFwHheox7lOOFVq1NvTyL1zhnCG0ES/o2qJ0fAEwEjsun7GrokxdoEoVvfpDWyoZt3KJrtBLrH7W1WX8aV3p6sfw9mi6/6Calv4XzeHUcE/jmM6oz+dGuWw9ynUyik0GoiW5/PPsjMfxrkwnueIrlQJDPOqc+bFgpDxOi1ovvRqLlE4dRY2Csm7cFsQxVWrreHSmN9gTR4Fufsr/92SJdRmBW5SE75lEetV2ZaNoT9wrYnYM55q1FALWSYpzz88LF0eWkNS85dJcZl3vpjO/q+eD3aPRVcof9c46iXpqK+9HOKxjaEFKss3r2nuSZJ7WBVFMJVkx/cllHye0VajmlJt0z6AlaVzM0ZokRaQ0kMNyv1rGouUh0hmif4j3c3B2bCCHRsSHfLlErxc19YG4LReO62Q61liYJGRKukBlx1p6yJ82MT63LkXipNEY4WrtdawlDmNXHxZXi1W0hndBWkzzn9L2Jxo+U+4Yy/HOLL1BnbIlNXiYxHiC/SoKMN6LPAX9JoPGBYmLh0OBgf5iMwzx87eOeGpzVmH82egQ3yvIt2gCveFx9D28+3Oy53v16p90kev0EW1/vO05QAY76uff0rAZMmgIK+LEZVxalyV5OSl6c9/i5I7+uL/7AsPwD7ybmtA=
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
Get the most recently converted skin of a Bedrock player
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/v2/skin/{xuid}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get the most recently converted skin of a Bedrock player
|
||||
|
||||
## 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={{"description":"Bedrock xuid","example":"2535432196048835","in":"path","name":"xuid","required":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Converted skin or an empty object if there is no skin stored for that player
|
||||
|
||||
|
||||
</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={"hash"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The hash of the skin bytes","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"is_steve"}
|
||||
required={true}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"If the skin is a Steve or an Alex","type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"signature"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The signature of the skin data used by Minecraft","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"texture_id"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The texture id used by Minecraft","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"value"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The value of the skin data used by Minecraft","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"hash\": \"string\",\n \"is_steve\": true,\n \"signature\": \"string\",\n \"texture_id\": \"string\",\n \"value\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid xuid (not an int)
|
||||
|
||||
|
||||
</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={"message"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The error message","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"message\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,207 @@
|
||||
---
|
||||
id: global-api-web-api-stats-controller-get-all-stats-2
|
||||
title: "Get all publicly available Global Api statistics"
|
||||
description: "Get all publicly available Global Api statistics"
|
||||
sidebar_label: "Get all publicly available Global Api statistics"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydU8Fu2zAM/RWBl26A52Q5+hYMRbBzO+xQBAEtM7YaWVIlOlhg+N8H2nGbJsWA9WT5mdbje3zsQaO1JepDgqIfMvCBIrLx7mcFBWysL9Gug/lNZb4OJn9g5PTDO47eWop5TbxDa3dJcPVl9RUyCBixJaaYoHjaZhApBe8SCQOslkt5aO+YHMsRQ7BGj5yL5+SdYEk31KKcKko6miBfoYC1tSp0pTXanhQe0VgsLSlhN4mNTkIfRQObiS9E2nXBeqx2Lx11NGGXFZZczc0t12NDClvfOVZ+r9LBuKSMU9yQCpG+TZeq6dIM+BQICjCOqaYIw/AK+fKZNMOQwb/7oMSmRaZqV3XTCG57up9r1Fyj2KtzK3eTkrvrriGDvY8tMhRQkTYt2reGXdeW0m/2GR/+2wNBDFuBHi5ndl02ZFdNXFSPl2At4YIxdrC9rt4QK/w4KlOi1TqY96lpiRsvka+JxwyLFbA4rhYTRwaJ4nHKdA9dtFBAwxxSsVhgMHlNp0Sx1bmPNWRwxGiEb9yqYSt/6y4aPk0rYdzei9OzGW9dyb8U06Tje77MVzKb4BO3OAbCYUufk/jOo372nOkPL4JF48aIirD+LP8JjisRPpvc+MSC9n2JiX5FOwwCv3QUz7pm2fI2ZNAQVhRHxw50kv3VmgKP/ljZgdvlF69eZ7G5f4Rh+AsJ0582
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
Get all publicly available Global Api statistics
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/v2/stats"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get all publicly available Global Api statistics
|
||||
|
||||
## Request
|
||||
|
||||
<div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Statistics
|
||||
|
||||
|
||||
</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={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
pre_upload_queue
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
object
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"length"}
|
||||
required={false}
|
||||
schemaName={"integer"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The amount of skins in the pre-upload queue","type":"integer"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</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"}
|
||||
>
|
||||
upload_queue
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
object
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"estimated_duration"}
|
||||
required={false}
|
||||
schemaName={"decimal"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"Estimated duration to upload 'length' amount of skins","format":"decimal","type":"number"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"length"}
|
||||
required={false}
|
||||
schemaName={"integer"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The amount of skins in the upload queue","type":"integer"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"pre_upload_queue\": {\n \"length\": 0\n },\n \"upload_queue\": {\n \"estimated_duration\": 0,\n \"length\": 0\n }\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,207 @@
|
||||
---
|
||||
id: global-api-web-api-stats-controller-get-all-stats
|
||||
title: "Get all publicly available Global Api statistics"
|
||||
description: "Get all publicly available Global Api statistics"
|
||||
sidebar_label: "Get all publicly available Global Api statistics"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydU8Fu2zAM/RWBl148O+nRt2Aoip3bYYciCGiZsdXIkirRwQLD/z7Qjts0GQasJ8vPNPne0+MAGq2tUB8SlMOYgQ8UkY13P2oo4dH6Cu0mmF9U5Ztg8idGTt+94+itpZg3xDu0dpcEhwwCRuyIKSYoX7YZRErBu0TSHe5XK3lo75gcyxFDsEZP84rX5J1gSbfUoZxqSjqaIF+hhI21KvSVNdqeFB7RWKwsKZlsEhs9jY/Cn808L0Ta9cF6rHdvPfU0Y5cVllzD7e2s55YUdr53rPxepYNxSRmnuCUVIn2bm6q5aQZ8CgQlGMfUUIRxfId89UqaYczg3zwosemQqd7V/Wz/LaeHpUYtNYq9OlO5m5XcXbOGDPY+dshQQk3adGg/CLu+q4Rv9hUf/tsDQQxbgZ4u7+y6bMyuSFxUT02wkXDBHLntdfUjscK/R2VOs9oE8zk1HXHrJe4N8ZRhsQKK47pYYp0oHudMD9BHCyW0zCGVRYHB5A2dEsVO5z42kMERo5F500aNW/lb99HwaV4J4/ZenF7M+GAl/1JMs451vsrv5W6CT9zhFAiHHX1N4iePhsVzpt9cBIvGTREVYcNZ/gsc1yJ8Mbn1iQUdhgoT/Yx2HAV+6ymedS2y5W3MoCWsKU6OHegk+6s1BZ78sbIDt8svXr3fxePDM4zjH9KqnpE=
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
Get all publicly available Global Api statistics
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/v1/stats"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get all publicly available Global Api statistics
|
||||
|
||||
## Request
|
||||
|
||||
<div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Statistics
|
||||
|
||||
|
||||
</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={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
pre_upload_queue
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
object
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"length"}
|
||||
required={false}
|
||||
schemaName={"integer"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The amount of skins in the pre-upload queue","type":"integer"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</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"}
|
||||
>
|
||||
upload_queue
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
object
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"estimated_duration"}
|
||||
required={false}
|
||||
schemaName={"decimal"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"Estimated duration to upload 'length' amount of skins","format":"decimal","type":"number"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"length"}
|
||||
required={false}
|
||||
schemaName={"integer"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The amount of skins in the upload queue","type":"integer"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"pre_upload_queue\": {\n \"length\": 0\n },\n \"upload_queue\": {\n \"estimated_duration\": 0,\n \"length\": 0\n }\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,358 @@
|
||||
---
|
||||
id: global-api-web-api-utils-controller-get-bedrock-or-java-uuid
|
||||
title: "Utility endpoint to get either a Java UUID or a Bedrock xuid"
|
||||
description: "Utility endpoint to get either a Java UUID or a Bedrock xuid"
|
||||
sidebar_label: "Utility endpoint to get either a Java UUID or a Bedrock xuid"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzlVk1v4zYQ/SvEXJoAgu11sltUt7RNgxRdYLFI0AJBENDUWGJCkdrhyBvD0H9fDCU5ju1+LHJsLpEpcebNe2843IDRzi20eYqQb7oMQoOk2QZ/XUAOVy4stLto7J+4mFw0dnLL1sVfgmcKziFNSuSHBRYUzNNDoIdHvdIPbWsLyKDRpGtkpAj53QYKjIZsI6Ehh5sKVRuRvK5RhaXiCtVH69GQXrJqnF4jQQb4rOvGoWCDIY08rrRrEXKY3Nh6PjuDLgPJvPtqfNNlYCVho7mCDCQf5DCmhgwIv7SWsICcqcUMoqmwTqF43ci3kcn6UiIdK6IhXNpnqaVQ1qt1aEn95kIoSs2oTPBLW74UIphhQPSlRVq/QOoDfRege/k4NsHHnqH5bCb/TPCMnuVRN42zJuk5fYwCerMT73U1t6McHHYquL29/lUK+xgetS93NaKwtA7VMlCtWfQm8Q7bHostDjMIX3uRB+l/7rU9EB5ymB3+/TR7t/xwvvzw3vxoziCDAUIOg/P2eBop/mc4O5bYEWuw0UHMblenO0hp0+77DNhy2jwS+qln6iVIWDyiYegkyiGkkYvn1iZL7THWF6u0L7aQJ+rzYANV6yIJuEBlC/RsjXbyO/VXLyH6ognWsxAzn50f8nJpuUJKW0pdI7EulY2KQ1Au+FIFSs+xCsQqeIPp06ERvuqoCOuwwiJ9WCGh7PZB/bUIz0obE1rPirC0kZGwGOGNuQTX2Wx+XK/eIBJQq9/1So8LQsdX/ME5RVhYQsPSin9TuXCouNL8InqXwfmbuucKPZI1ozySoSFkXqu6NZXCFdJaIVEgeG2dGmPUZTLO6w4aXxzlIUVS4yfH7Dm68HLI+a/eu/Yr7WwxCnniw/CYKawbXo+6iwdOhbD3s7P/NWESVoBhZCy2xpYG8IGV0aaS5WRM9VXaQJb1wqUGlbGbvJm64g+7QnXx6VqdkDS6s7WVmNO0JSK3zWmPUZcyTaGVMSwM7B3hbJ3l9YvROagSWWHf0UPL9Aev/Nw9aiCDGrkKMvZLTAe6jMwcpqv5NOWbyvE63Zv2083YQx1kEJFW48BvyUEOFXMT8+lUN3ZS4joi1WYSSGbiSpMVOtLNQ4ZZRNOS5TXkd/cyJJchTb1Bl/4uoi4aK3uRYl/zu8lsMhc7NiFyrZPnhpH6RjpecbudvozPPG2ctl6SpiI3A1V3sJpDNoiTjdNojzDIIN8eO/cZVCGybN1sFjriLbmuk+X+dpAuTjYKSwXkS+0iHuDa9h+cfB7a5FR9x9XkaF1PuN69k4y3KhCZRt3ehu4/3P6OIhsWtV/v4hoRvxzo910GFeoCKeHsX18Ygw3vbDw4saTAbR9cXd5A130DdnbXhw==
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
Utility endpoint to get either a Java UUID or a Bedrock xuid
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/v2/utils/uuid/bedrock_or_java/{username}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Utility endpoint to get either a Java UUID or a Bedrock xuid
|
||||
|
||||
## 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={{"description":"The username of the Minecraft player","examples":{"bedrock":{"value":".Tim203"},"java":{"value":"Tim203"}},"in":"path","name":"username","required":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><details
|
||||
style={{"marginBottom":"1rem"}}
|
||||
className={"openapi-markdown__details"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-params"}
|
||||
>
|
||||
Query Parameters
|
||||
</h3>
|
||||
</summary><div>
|
||||
<ul>
|
||||
<ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"description":"The prefix used in your Floodgate config","example":".","in":"query","name":"prefix","required":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
The Bedrock xuid in Floodgate UUID format and username. Response made to be identical to the Mojang endpoint
|
||||
|
||||
|
||||
</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={"id"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The Floodgate UUID of the Bedrock player","example":"0000000000000000000901f64f65c7c3","format":"uuid","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The Floodgate username","example":".Tim203","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"id\": \"0000000000000000000901f64f65c7c3\",\n \"name\": \".Tim203\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"204"}
|
||||
value={"204"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Either the gamertag is too long or too short once the prefix was removed or there is no Xbox account registered to the gamertag
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"302"}
|
||||
value={"302"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
The player is a Java player and we'll redirect you to the Mojang endpoint for that username
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid prefix (no prefix, empty or too long)
|
||||
|
||||
|
||||
</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={"message"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The error message","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"message\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"503"}
|
||||
value={"503"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
The requested account was not cached and we were not able to call the Xbox Live API (rate limited / not setup)
|
||||
|
||||
|
||||
</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={"message"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The error message","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"message\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,97 @@
|
||||
---
|
||||
id: global-api-web-api-xbox-controller-get-gamertag-v-1
|
||||
title: "GlobalApiWeb.Api.XboxController.get_gamertag_v1"
|
||||
description: "GlobalApiWeb.Api.XboxController.get_gamertag_v1"
|
||||
sidebar_label: "GlobalApiWeb.Api.XboxController.get_gamertag_v1"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVkkuL2zAUhf+KOasWhJ1nmWqXPhi6LS0tDGGQ7TuOiGxppOuQYPTfi5x4Mpl205VlcY50zqc7oFLGlKraB8ghCtTkPFWKqYZk35OAdeQVa9t9qyFxb2ypzMbpX1TmG6fz36U9frYde2sM+bwhfmxUS55V83iYQ8Apr1pi8gHyYUBNofLapQMh8Ylqb6t9dux1DQE6qtYZgsRivVyvlov5xw+z1d3dcg0BnQxO8Q4CnWqT6mLz9Nxrf40cqh21CnIAn1zSBfa6axDjNomDs12gVBir2Sx9bkN9uTKIUYBVk6LjWNojtuKN+P+BtMQ7m1g2xCMf3kGiOMyLdEMxiYshtYsQCOQPE77eG0jsmF2QRaGczhs6BfJtlVvfQOCgvFalGeuNfQNVvdd8gnzYJohPdgSjeeR8jp9tnE5e8uHcap7P8gWigLOBW9Uly4X51ZG9rpzdds6mGtnY+YbZy7MwHblwRukuXTVWGy48HjD6RuYC02EQkOObbwV2NnDSDUOpAv30Jsa0/dyTv3SdUJznToe0riGflAn0V6TKdkwdQ+Ld98s4vc/ejOc/Y182VXca6Zs+/UFgT6dpQuM2vnr2+68/EOMfdQMtcQ==
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
GlobalApiWeb.Api.XboxController.get_gamertag_v1
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/v1/xbox/gamertag/{xuid}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
:::caution deprecated
|
||||
|
||||
|
||||
|
||||
:::
|
||||
|
||||
GlobalApiWeb.Api.XboxController.get_gamertag_v1
|
||||
|
||||
## 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={{"description":"Bedrock xuid","example":"2535432196048835","in":"path","name":"xuid","required":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Deprecated
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,299 @@
|
||||
---
|
||||
id: global-api-web-api-xbox-controller-get-gamertag-v-2
|
||||
title: "Get the gamertag from a xuid"
|
||||
description: "Get the gamertag from a xuid"
|
||||
sidebar_label: "Get the gamertag from a xuid"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzlVcGK5DYQ/RVRpxkw7U5vcvGtE5ZhIYewTEhgaBa1XG1rR5a0pXJPG+N/DyXbnZn0JhvIMSfb0qtyvaeqpxGMdu6ozXOCapwKCBFJsw3+Qw0VPLhw1G4f7W943Oyj3fx+DJefgmcKziFtGuRPje6QWDefzjsoIGrSHTJSgupphBqTIRslIVTw2KK69LZW4aS4RfUj1hTMs4pOD0hQgBVU1NxCAV53CBUIHgog/NJbwhoqph4LSKbFTkM1Ag9RcInJ+gam6SDgFINPKJxgt93KwwTP6FledYzOmsyy/JyksvFVvrclPyCrlaE6UehmAoSpd/ymridYcXAoIJIoyXau4bpzk18kue4WgBfdRSd8Hm23276D4oZfAWw5Q+QwHpbYj2tBCzwcP6NhmAT/939UOqVgrGas1YvlNp/KfEKktFfYRR7UnEvZfGiEyialjQm95z+DGntGn0NhKuD7/6i5R7JGnQJ1muWhIiHzoLretArPSINCokB/OYAOU9IN3uq/bnxV/pxJrZB/Evz98s9/pXGW0SZl/Vk7W6s7H1g0tZ7vRaMftu/+9xpJYZik+64NpZMSoYw2rSz7Wr2gepG2y/odHSoOSlwr953MgPrZnlHtf/mg7kgzKmc7KznLHJKQ+3g/16gbsSW4HMNFBLgddX49HHnctVocqENug5hig5yNjluooDzvSklXrlHlKPgJCkhI59UHe3JQQcscU1WWOtpNg0NC6swmkAz+WZMVctmGxcMSmp4sD1A9HcQYTyGb3aLybMxqH63EIqWZwneb7WYnzRVD4k7nDlp89Bvs3khxNVXGC5fRaeslaSYxLsyfIPt9lrKAVxZW5YyHAtqQWHDjeNQJfyU3TbL8pUdaWK2k56vCJnmvoTppl/CmpOugwN3HpZ/v1TdvlK8SWRa1H7LyrpcvKOAZh/XGmQ5TAS3qGilXN2/tjcHIr4JuRlaO7topD+8fYZr+AMbXjqk=
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
Get the gamertag from a xuid
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/v2/xbox/gamertag/{xuid}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get the gamertag from a xuid
|
||||
|
||||
## 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={{"description":"The xuid of the Bedrock player","in":"path","name":"xuid","required":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
The gamertag associated with the xuid or an empty object if there is account with the given xuid
|
||||
|
||||
|
||||
</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={"gamertag"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The gamertag","example":"Tim203","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"gamertag\": \"Tim203\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
The xuid is invalid (not an int)
|
||||
|
||||
|
||||
</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={"message"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The error message","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"message\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"503"}
|
||||
value={"503"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
The requested account was not cached and we were not able to call the Xbox Live API (rate limited / not setup)
|
||||
|
||||
|
||||
</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={"message"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The error message","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"message\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,97 @@
|
||||
---
|
||||
id: global-api-web-api-xbox-controller-get-xuid-v-1
|
||||
title: "GlobalApiWeb.Api.XboxController.get_xuid_v1"
|
||||
description: "GlobalApiWeb.Api.XboxController.get_xuid_v1"
|
||||
sidebar_label: "GlobalApiWeb.Api.XboxController.get_xuid_v1"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVkk2L2zAQhv+KeE8tCDspPemWfrD0Wra0EMIi2xNbRLa00jjEGP33Im++tt1De7It3pHneWZm1NraSteHCDUniYZ8oFozNVAcRpJwnoJm44ZvDRQerKu03Xjzk6pi403xq3Knz27g4KylULTET6fRNE/HNSS8DronphChtjMainUwPl8GhceORKt7Cqxb4faCOxKfqAmuPghv9UQBEiYnveYOEoPuCQqXGkgEeh5NuPUa6456DTWDJ5+zkYMZWqS0y+Ho3RApk+LjapUfrzv6coNPSYJ1m/vGqXIn7OQf4f8z0RN3LgtsiRcx3EGhPK7LfHuZg+V8IUuQiBSOF29jsFDomH1UZam9KVqaIoW+LlzIHo46GF3ZBW1hjVSPwfAEtd1liXu3SDFs6dq62HiTaynEF6J1sSo+IEl4F7nXQy45O79ViHtc8ZpXZAyx8L5ydR0H04lLb7UZ8m8WrPnsYoulbnEtkS+ChLrOeifRucg5N8+VjvQj2JTy8fNI4cx50fCybCbm9wZqr22kv1qq3cA0MBTefT+v0XvxTzv5Jsz5UA/TMg875i9IHGi639m0S3fL8PD1ESn9BuA2NGk=
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
GlobalApiWeb.Api.XboxController.get_xuid_v1
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/v1/xbox/xuid/{gamertag}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
:::caution deprecated
|
||||
|
||||
|
||||
|
||||
:::
|
||||
|
||||
GlobalApiWeb.Api.XboxController.get_xuid_v1
|
||||
|
||||
## 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={{"description":"The gamertag of the Bedrock player","in":"path","name":"gamertag","required":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Deprecated
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,299 @@
|
||||
---
|
||||
id: global-api-web-api-xbox-controller-get-xuid-v-2
|
||||
title: "Get the xuid from a gamertag"
|
||||
description: "Get the xuid from a gamertag"
|
||||
sidebar_label: "Get the xuid from a gamertag"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzlVd+L40YM/leEnnbBJNnsD65+S8uxHPShHFd6sIRjMlbsuR3PzGnkbELw/17kONlss9CDPvbJtkaS9X2SvtmjNd6vjH3OWO77AmMiNuJi+FRhiY8+roxfJPcXrSaL5CZfV3H7WwzC0XviSU3ybdu56ttmjgUmw6YlIc5YPu2xomzZJU2GJX5pCGrTEoupIa5BGoJfqeJonyF5syPGAp16JiMNFhhMS1jiMQYLZPrROaYKS+GOCsy2odZguUfZJfXNwi7U2PdLdc4phkyKC+ezmT5sDEJB9NWk5J0dkE6/Z61wf5bvbemPJKAoYc2xfQXBlDsvb+p6QvXDZYGJlUlxh/8P1ou8SslwUiBtTZs8YTm/v72/u53f/PIwu/vw4fa+wHXk1giW6II83GFxBOuCUE2MfV+gONFg1PZ87Vz1+Vja6BtX38kK9ur7fg1gco7WGaEKXpw0Q39e+8VgAlCbZAeHXOCGFjKBy2CsjV2Qs0C3oXAKx77Au//YgUDsLBy40AckJpEdtJ1tgDbEOyDmyP9oR0s5m5ouO3I8eLcpQyY4uhQX4/VK+Mfxnz/F84lOl8GFjfGugquRVAYfQ00M0pgANw9gG8P5Wqm7n93+76nTwijrcJ5mzWQIUcAa26g5VPBC8KITqWaz8gQSQeVtGEldDfjdbQgWf3yCKzZC4F3rNOd0CMkkXbo+1GjqPGzzKm6VgEs9kOPeDJpg4EymWpImqnrWJIMqSoMlTjfzqaabatR0f/TvscBMvDmKZsceS2xEUi6nU5PcpKZdJm7tJLJm3xh2Cm7QaxW6TLZjJzssn5aqoOs4KOLI8kHBYZGcxhLnA4SbyWwy1+FKMUtrhgkaBfdf0L2h4qS8QluZJm9c0KQDiP2I/AmHy2GgssBR78pTxmWBTcyifvv9ymT6k33fq/lHRzyiOoI+3Csu63uF5dr4TBclnRYFrz6P83wNP3X9vAtmNJqwG9j3nX5hgc+0O7+e+mVfYEOmIh6qPBwvrKUkZ4EXq6stPE3M48cv2Pd/Az1Anao=
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: api/global/global-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"}
|
||||
>
|
||||
Get the xuid from a gamertag
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/v2/xbox/xuid/{gamertag}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get the xuid from a gamertag
|
||||
|
||||
## 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={{"description":"The gamertag of the Bedrock player","in":"path","name":"gamertag","required":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
The xuid associated with the gamertag or an empty object if there is account with the given gamertag
|
||||
|
||||
|
||||
</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={"xuid"}
|
||||
required={true}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The xuid","example":2535432196048835,"format":"int64","type":"integer"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"xuid\": 2535432196048835\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
The gamertag is invalid (empty or longer than 16 chars)
|
||||
|
||||
|
||||
</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={"message"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The error message","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"message\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"503"}
|
||||
value={"503"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
The requested account was not cached and we were not able to call the Xbox Live API (rate limited / not setup)
|
||||
|
||||
|
||||
</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={"message"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"description":"The error message","type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"message\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: global-api
|
||||
title: "Global 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.2
|
||||
</span>
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
Global Api
|
||||
</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
+30
-3
@@ -39,6 +39,7 @@ const config: Config = {
|
||||
'https://github.com/GeyserMC/Geyser/tree/main/',
|
||||
|
||||
routeBasePath: '/', // Serve the docs at the site's root
|
||||
docItemComponent: "@theme/ApiItem",
|
||||
},
|
||||
blog: {},
|
||||
theme: {
|
||||
@@ -48,6 +49,27 @@ const config: Config = {
|
||||
],
|
||||
],
|
||||
|
||||
plugins: [
|
||||
[
|
||||
'docusaurus-plugin-openapi-docs',
|
||||
{
|
||||
id: "api",
|
||||
docsPluginId: "classic",
|
||||
config: {
|
||||
downloads: {
|
||||
specPath: "openapi/downloads.yaml",
|
||||
outputDir: "docs/api/downloads",
|
||||
},
|
||||
global: {
|
||||
specPath: "openapi/global.yaml",
|
||||
outputDir: "docs/api/global",
|
||||
}
|
||||
}
|
||||
},
|
||||
]
|
||||
],
|
||||
themes: ["docusaurus-theme-openapi-docs"],
|
||||
|
||||
themeConfig: {
|
||||
image: 'img/site/geyser.png',
|
||||
navbar: {
|
||||
@@ -74,6 +96,11 @@ const config: Config = {
|
||||
docId: 'floodgate/setup',
|
||||
label: 'Floodgate',
|
||||
},
|
||||
{
|
||||
type: 'doc',
|
||||
docId: 'api/downloads/downloads-api',
|
||||
label: 'REST APIs',
|
||||
},
|
||||
{
|
||||
type: 'doc',
|
||||
docId: 'other/geyseroptionalpack',
|
||||
@@ -82,8 +109,8 @@ const config: Config = {
|
||||
]
|
||||
},
|
||||
{
|
||||
to: 'blog',
|
||||
label: 'Blog',
|
||||
to: 'blog',
|
||||
label: 'Blog',
|
||||
position: 'left',
|
||||
className: 'header-blog-link'
|
||||
},
|
||||
@@ -130,7 +157,7 @@ const config: Config = {
|
||||
},
|
||||
algolia: {
|
||||
appId: '0DTHI9QFCH',
|
||||
apiKey: '3cc0567f76d2ed3ffdb4cc94f0ac9815',
|
||||
apiKey: '3cc0567f76d2ed3ffdb4cc94f0ac9815',
|
||||
indexName: 'geysermc',
|
||||
contextualSearch: true,
|
||||
searchPagePath: 'search',
|
||||
|
||||
@@ -0,0 +1,407 @@
|
||||
openapi: 3.0.1
|
||||
info: {
|
||||
title: 'Downloads API',
|
||||
version: 1.0.0
|
||||
}
|
||||
servers:
|
||||
- url: https://download.geysermc.org
|
||||
paths:
|
||||
/v2/projects:
|
||||
get:
|
||||
tags:
|
||||
- projects-controller
|
||||
summary: Gets a list of all available projects.
|
||||
operationId: projects
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ProjectsResponse'
|
||||
/v2/projects/{project}:
|
||||
get:
|
||||
tags:
|
||||
- project-controller
|
||||
summary: Gets information about a project.
|
||||
operationId: project
|
||||
parameters:
|
||||
- name: project
|
||||
in: path
|
||||
description: The project identifier.
|
||||
required: true
|
||||
schema:
|
||||
pattern: '[a-z]+'
|
||||
type: string
|
||||
example: geyser
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ProjectResponse'
|
||||
/v2/projects/{project}/versions/{version}:
|
||||
get:
|
||||
tags:
|
||||
- version-controller
|
||||
summary: Gets information about a version.
|
||||
operationId: version
|
||||
parameters:
|
||||
- name: project
|
||||
in: path
|
||||
description: The project identifier.
|
||||
required: true
|
||||
schema:
|
||||
pattern: '[a-z]+'
|
||||
type: string
|
||||
example: geyser
|
||||
- name: version
|
||||
in: path
|
||||
description: A version of the project.
|
||||
required: true
|
||||
schema:
|
||||
pattern: (?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/VersionResponse'
|
||||
/v2/projects/{project}/versions/{version}/builds:
|
||||
get:
|
||||
tags:
|
||||
- version-builds-controller
|
||||
summary: Gets all available builds for a project's version.
|
||||
operationId: builds
|
||||
parameters:
|
||||
- name: project
|
||||
in: path
|
||||
description: The project identifier.
|
||||
required: true
|
||||
schema:
|
||||
pattern: '[a-z]+'
|
||||
type: string
|
||||
example: geyser
|
||||
- name: version
|
||||
in: path
|
||||
description: A version of the project.
|
||||
required: true
|
||||
schema:
|
||||
pattern: (?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/BuildsResponse'
|
||||
/v2/projects/{project}/versions/{version}/builds/{build}:
|
||||
get:
|
||||
tags:
|
||||
- version-build-controller
|
||||
summary: Gets information related to a specific build.
|
||||
operationId: buildSpecific
|
||||
parameters:
|
||||
- name: project
|
||||
in: path
|
||||
description: The project identifier.
|
||||
required: true
|
||||
schema:
|
||||
pattern: '[a-z]+'
|
||||
type: string
|
||||
example: geyser
|
||||
- name: version
|
||||
in: path
|
||||
description: A version of the project.
|
||||
required: true
|
||||
schema:
|
||||
pattern: (?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?
|
||||
type: string
|
||||
- name: build
|
||||
in: path
|
||||
description: A build of the version.
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int32
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/BuildResponse'
|
||||
/v2/projects/{project}/versions/{version}/builds/{build}/downloads/{download}:
|
||||
get:
|
||||
tags:
|
||||
- download-controller
|
||||
summary: Downloads the given file from a build's data.
|
||||
operationId: downloadSpecific
|
||||
parameters:
|
||||
- name: project
|
||||
in: path
|
||||
description: The project identifier.
|
||||
required: true
|
||||
schema:
|
||||
pattern: '[a-z]+'
|
||||
type: string
|
||||
example: geyser
|
||||
- name: version
|
||||
in: path
|
||||
description: A version of the project.
|
||||
required: true
|
||||
schema:
|
||||
pattern: (?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?
|
||||
type: string
|
||||
- name: build
|
||||
in: path
|
||||
description: A build of the version.
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int32
|
||||
- name: download
|
||||
in: path
|
||||
description: A download of the build.
|
||||
required: true
|
||||
schema:
|
||||
pattern: '[a-zA-Z0-9._-]+'
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
headers:
|
||||
ETag:
|
||||
description: 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.
|
||||
style: simple
|
||||
schema:
|
||||
type: string
|
||||
Content-Disposition:
|
||||
description: A header indicating that the content is expected to be displayed as an attachment, that is downloaded and saved locally.
|
||||
style: simple
|
||||
schema:
|
||||
type: string
|
||||
Last-Modified:
|
||||
description: The date and time at which the origin server believes the resource was last modified.
|
||||
style: simple
|
||||
schema:
|
||||
type: string
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
'*/*':
|
||||
schema:
|
||||
type: object
|
||||
/v2/projects/{project}/versions/{version}/builds/latest:
|
||||
get:
|
||||
tags:
|
||||
- version-build-controller
|
||||
summary: Gets information related to a specific build.
|
||||
operationId: buildLatest
|
||||
parameters:
|
||||
- name: project
|
||||
in: path
|
||||
description: The project identifier.
|
||||
required: true
|
||||
schema:
|
||||
pattern: '[a-z]+'
|
||||
type: string
|
||||
example: geyser
|
||||
- name: version
|
||||
in: path
|
||||
description: A version of the project.
|
||||
required: true
|
||||
schema:
|
||||
pattern: (?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?
|
||||
type: string
|
||||
responses:
|
||||
'302':
|
||||
description: Found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
/v2/projects/{project}/versions/{version}/builds/latest/downloads/{download}:
|
||||
get:
|
||||
tags:
|
||||
- download-controller
|
||||
summary: Downloads the given file from a build's data.
|
||||
operationId: downloadLatest
|
||||
parameters:
|
||||
- name: project
|
||||
in: path
|
||||
description: The project identifier.
|
||||
required: true
|
||||
schema:
|
||||
pattern: '[a-z]+'
|
||||
type: string
|
||||
example: geyser
|
||||
- name: version
|
||||
in: path
|
||||
description: A version of the project.
|
||||
required: true
|
||||
schema:
|
||||
pattern: (?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?
|
||||
type: string
|
||||
- name: download
|
||||
in: path
|
||||
description: A download of the build.
|
||||
required: true
|
||||
schema:
|
||||
pattern: '[a-zA-Z0-9._-]+'
|
||||
type: string
|
||||
responses:
|
||||
'302':
|
||||
description: Found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
components:
|
||||
schemas:
|
||||
BuildResponse:
|
||||
type: object
|
||||
properties:
|
||||
project_id:
|
||||
pattern: '[a-z]+'
|
||||
type: string
|
||||
example: geyser
|
||||
project_name:
|
||||
type: string
|
||||
example: Geyser
|
||||
version:
|
||||
pattern: (?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?
|
||||
type: string
|
||||
example: 2.1.0
|
||||
build:
|
||||
pattern: \d+
|
||||
type: integer
|
||||
format: int32
|
||||
example: 30
|
||||
time:
|
||||
type: string
|
||||
format: date-time
|
||||
channel:
|
||||
type: string
|
||||
enum:
|
||||
- default
|
||||
- experimental
|
||||
promoted:
|
||||
type: boolean
|
||||
changes:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Change'
|
||||
downloads:
|
||||
type: object
|
||||
additionalProperties:
|
||||
$ref: '#/components/schemas/Download'
|
||||
BuildsResponse:
|
||||
type: object
|
||||
properties:
|
||||
project_id:
|
||||
pattern: '[a-z]+'
|
||||
type: string
|
||||
example: geyser
|
||||
project_name:
|
||||
type: string
|
||||
example: Geyser
|
||||
version:
|
||||
pattern: (?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?
|
||||
type: string
|
||||
example: 2.1.0
|
||||
builds:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/VersionBuild'
|
||||
Change:
|
||||
type: object
|
||||
properties:
|
||||
commit:
|
||||
type: string
|
||||
summary:
|
||||
type: string
|
||||
message:
|
||||
type: string
|
||||
Download:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
pattern: '[a-z0-9._-]+'
|
||||
type: string
|
||||
example: Geyser-Spigot.jar
|
||||
sha256:
|
||||
pattern: '[a-f0-9]{64}'
|
||||
type: string
|
||||
example: 9ecc7374c2110a077f6c288fa4ad53a6812c09d5690dae0bc96508f939d4cb8a
|
||||
ProjectResponse:
|
||||
type: object
|
||||
properties:
|
||||
project_id:
|
||||
pattern: '[a-z]+'
|
||||
type: string
|
||||
example: geyser
|
||||
project_name:
|
||||
type: string
|
||||
example: Geyser
|
||||
versions:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
ProjectsResponse:
|
||||
type: object
|
||||
properties:
|
||||
projects:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
VersionBuild:
|
||||
type: object
|
||||
properties:
|
||||
build:
|
||||
pattern: \d+
|
||||
type: integer
|
||||
format: int32
|
||||
example: 30
|
||||
time:
|
||||
type: string
|
||||
format: date-time
|
||||
channel:
|
||||
type: string
|
||||
enum:
|
||||
- default
|
||||
- experimental
|
||||
promoted:
|
||||
type: boolean
|
||||
changes:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Change'
|
||||
downloads:
|
||||
type: object
|
||||
additionalProperties:
|
||||
$ref: '#/components/schemas/Download'
|
||||
VersionResponse:
|
||||
type: object
|
||||
properties:
|
||||
project_id:
|
||||
pattern: '[a-z]+'
|
||||
type: string
|
||||
example: geyser
|
||||
project_name:
|
||||
type: string
|
||||
example: Geyser
|
||||
version:
|
||||
pattern: (?:latest|[0-9.]+-?(?:pre|SNAPSHOT)?(?:[0-9.]+)?)?
|
||||
type: string
|
||||
example: 2.1.0
|
||||
builds:
|
||||
type: array
|
||||
items:
|
||||
type: integer
|
||||
format: int32
|
||||
@@ -0,0 +1,572 @@
|
||||
components:
|
||||
responses: {}
|
||||
schemas:
|
||||
ConvertedSkin:
|
||||
description: Data representing a skin that has been converted and uploaded to Java Edition
|
||||
properties:
|
||||
hash:
|
||||
description: The hash of the skin bytes
|
||||
type: string
|
||||
is_steve:
|
||||
description: If the skin is a Steve or an Alex
|
||||
type: boolean
|
||||
signature:
|
||||
description: The signature of the skin data used by Minecraft
|
||||
type: string
|
||||
texture_id:
|
||||
description: The texture id used by Minecraft
|
||||
type: string
|
||||
value:
|
||||
description: The value of the skin data used by Minecraft
|
||||
type: string
|
||||
required:
|
||||
- hash
|
||||
- texture_id
|
||||
- value
|
||||
- singature
|
||||
- is_steve
|
||||
title: ConvertedSkin
|
||||
type: object
|
||||
Error:
|
||||
description: Generic format for pretty much every error
|
||||
required:
|
||||
- message
|
||||
properties:
|
||||
message:
|
||||
description: The error message
|
||||
type: string
|
||||
title: Error
|
||||
type: object
|
||||
Link:
|
||||
description: A link between a Java and a Bedrock account
|
||||
properties:
|
||||
bedrock_id:
|
||||
description: xuid of the Bedrock player
|
||||
example: 2535432196048835
|
||||
format: int64
|
||||
type: integer
|
||||
java_id:
|
||||
description: UUID of the Java player
|
||||
example: d34eb447-6e90-4c78-9281-600df88aef1d
|
||||
format: uuid
|
||||
type: string
|
||||
java_name:
|
||||
description: Username of the Java player
|
||||
example: Tim203
|
||||
type: string
|
||||
last_name_update:
|
||||
description: Unix millis of the last Java name update check
|
||||
format: int64
|
||||
type: integer
|
||||
required:
|
||||
- bedrock_id
|
||||
- java_id
|
||||
- java_name
|
||||
- last_name_update
|
||||
title: Link
|
||||
type: object
|
||||
LinkList:
|
||||
description: Response schema for a list of links
|
||||
items:
|
||||
$ref: '#/components/schemas/Link'
|
||||
title: LinkList
|
||||
type: array
|
||||
RecentConvertedSkinList:
|
||||
description: List of most recently converted skins. Ordered by most recently converted
|
||||
properties:
|
||||
data:
|
||||
items:
|
||||
$ref: '#/components/schemas/RecentConvertedSkinReference'
|
||||
type: array
|
||||
total_pages:
|
||||
description: The amount of pages available
|
||||
type: integer
|
||||
title: RecentConvertedSkinList
|
||||
type: object
|
||||
RecentConvertedSkinReference:
|
||||
description: The most basic info required to show a Java skin on the site
|
||||
properties:
|
||||
id:
|
||||
description: The converted skin id
|
||||
type: integer
|
||||
texture_id:
|
||||
description: The texture id used by Minecraft
|
||||
type: string
|
||||
required:
|
||||
- id
|
||||
- texture_id
|
||||
title: RecentConvertedSkinReference
|
||||
type: object
|
||||
Statistics:
|
||||
description: All publicly available statistics
|
||||
properties:
|
||||
pre_upload_queue:
|
||||
properties:
|
||||
length:
|
||||
description: The amount of skins in the pre-upload queue
|
||||
type: integer
|
||||
type: object
|
||||
upload_queue:
|
||||
properties:
|
||||
estimated_duration:
|
||||
description: Estimated duration to upload 'length' amount of skins
|
||||
format: decimal
|
||||
type: number
|
||||
length:
|
||||
description: The amount of skins in the upload queue
|
||||
type: integer
|
||||
type: object
|
||||
title: Statistics
|
||||
type: object
|
||||
UsernameProfile:
|
||||
description: Username to Floodgate UUID in Mojang Minecraft profile format
|
||||
properties:
|
||||
id:
|
||||
description: The Floodgate UUID of the Bedrock player
|
||||
example: 0000000000000000000901f64f65c7c3
|
||||
format: uuid
|
||||
type: string
|
||||
name:
|
||||
description: The Floodgate username
|
||||
example: .Tim203
|
||||
type: string
|
||||
required:
|
||||
- id
|
||||
- name
|
||||
title: UsernameProfile
|
||||
type: object
|
||||
XboxGamertagResult:
|
||||
description: Get gamertag from xuid result
|
||||
required:
|
||||
- gamertag
|
||||
properties:
|
||||
gamertag:
|
||||
description: The gamertag
|
||||
example: Tim203
|
||||
type: string
|
||||
title: XboxGamertagResult
|
||||
type: object
|
||||
XboxXuidResult:
|
||||
description: Get xuid from gamertag result
|
||||
required:
|
||||
- xuid
|
||||
properties:
|
||||
xuid:
|
||||
description: The xuid
|
||||
example: 2535432196048835
|
||||
format: int64
|
||||
type: integer
|
||||
title: XboxXuidResult
|
||||
type: object
|
||||
info:
|
||||
title: Global Api
|
||||
version: 1.0.2
|
||||
openapi: 3.0.0
|
||||
paths:
|
||||
/health:
|
||||
get:
|
||||
callbacks: {}
|
||||
operationId: GlobalApiWeb.Api.HealthController.health
|
||||
parameters: []
|
||||
responses:
|
||||
'204':
|
||||
description: The server is online
|
||||
summary: Simple server online check
|
||||
tags:
|
||||
- health
|
||||
/render/front/{texture_id}:
|
||||
get:
|
||||
operationId: GlobalApiWeb.Api.RenderController.get_front_texture
|
||||
parameters:
|
||||
- description: Java texture id
|
||||
example: 'a90790c57e181ed13aded14c47ee2f7c8de3533e017ba957af7bdf9df1bde94f'
|
||||
in: path
|
||||
name: texture_id
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses: {
|
||||
'200': {
|
||||
description: ok
|
||||
}
|
||||
}
|
||||
/render/raw/{texture_id}:
|
||||
get:
|
||||
operationId: GlobalApiWeb.Api.RenderController.get_raw_texture
|
||||
parameters:
|
||||
- description: Java texture id
|
||||
example: 'a90790c57e181ed13aded14c47ee2f7c8de3533e017ba957af7bdf9df1bde94f'
|
||||
in: path
|
||||
name: texture_id
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses: {
|
||||
'200': {
|
||||
description: ok
|
||||
}
|
||||
}
|
||||
/v1/link/bedrock/{xuid}:
|
||||
get:
|
||||
callbacks: {}
|
||||
deprecated: true
|
||||
operationId: GlobalApiWeb.Api.LinkController.get_bedrock_link_v1
|
||||
parameters:
|
||||
- description: Bedrock xuid
|
||||
example: '2535432196048835'
|
||||
in: path
|
||||
name: xuid
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses: {
|
||||
'400': {
|
||||
description: Deprecated
|
||||
}
|
||||
}
|
||||
tags:
|
||||
- link
|
||||
/v1/link/java/{uuid}:
|
||||
get:
|
||||
callbacks: {}
|
||||
deprecated: true
|
||||
operationId: GlobalApiWeb.Api.LinkController.get_java_link_v1
|
||||
parameters:
|
||||
- description: Java UUID
|
||||
example: d34eb447-6e90-4c78-9281-600df88aef1d
|
||||
in: path
|
||||
name: uuid
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses: {
|
||||
'400': {
|
||||
description: Deprecated
|
||||
}
|
||||
}
|
||||
tags:
|
||||
- link
|
||||
/v1/stats:
|
||||
get:
|
||||
callbacks: {}
|
||||
operationId: GlobalApiWeb.Api.StatsController.get_all_stats
|
||||
parameters: []
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Statistics'
|
||||
description: Statistics
|
||||
summary: Get all publicly available Global Api statistics
|
||||
tags:
|
||||
- stats
|
||||
/v1/xbox/gamertag/{xuid}:
|
||||
get:
|
||||
callbacks: {}
|
||||
deprecated: true
|
||||
operationId: GlobalApiWeb.Api.XboxController.get_gamertag_v1
|
||||
parameters:
|
||||
- description: Bedrock xuid
|
||||
example: '2535432196048835'
|
||||
in: path
|
||||
name: xuid
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses: {
|
||||
'400': {
|
||||
description: Deprecated
|
||||
}
|
||||
}
|
||||
tags:
|
||||
- xbox
|
||||
/v1/xbox/xuid/{gamertag}:
|
||||
get:
|
||||
callbacks: {}
|
||||
deprecated: true
|
||||
operationId: GlobalApiWeb.Api.XboxController.get_xuid_v1
|
||||
parameters:
|
||||
- description: The gamertag of the Bedrock player
|
||||
in: path
|
||||
name: gamertag
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses: {
|
||||
'400': {
|
||||
description: Deprecated
|
||||
}
|
||||
}
|
||||
tags:
|
||||
- xbox
|
||||
/v2/admin/xbox/token: {}
|
||||
/v2/link/bedrock/{xuid}:
|
||||
get:
|
||||
callbacks: {}
|
||||
operationId: GlobalApiWeb.Api.LinkController.get_bedrock_link_v2
|
||||
parameters:
|
||||
- description: Bedrock xuid
|
||||
example: '2535432196048835'
|
||||
in: path
|
||||
name: xuid
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Link'
|
||||
description: Linked accounts or an empty object if there is no account linked
|
||||
'400':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
description: No xuid provided or invalid
|
||||
summary: Get linked Java account from Bedrock xuid
|
||||
tags:
|
||||
- link
|
||||
/v2/link/java/{uuid}:
|
||||
get:
|
||||
callbacks: {}
|
||||
operationId: GlobalApiWeb.Api.LinkController.get_java_link_v2
|
||||
parameters:
|
||||
- description: Java UUID
|
||||
example: d34eb447-6e90-4c78-9281-600df88aef1d
|
||||
in: path
|
||||
name: uuid
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/LinkList'
|
||||
description: Linked account or an empty object if there is no account linked
|
||||
'400':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
description: No UUID provided or invalid
|
||||
summary: Get linked Bedrock account from Java UUID
|
||||
tags:
|
||||
- link
|
||||
/v2/link/online: {}
|
||||
/v2/skin/bedrock/recent/{page}:
|
||||
get:
|
||||
callbacks: {}
|
||||
operationId: GlobalApiWeb.Api.SkinController.get_recent_uploads.page
|
||||
parameters:
|
||||
- description: Number between 1 - page limit. Defaults to 1
|
||||
example: 1
|
||||
in: path
|
||||
name: page
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/RecentConvertedSkinList'
|
||||
description: The most recently uploaded skins. First element has been uploaded most recently etc.
|
||||
'400':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
description: Invalid page number (e.g. negative, decimal, too large)
|
||||
summary: Get a list of the most recently uploaded skins
|
||||
tags:
|
||||
- skin
|
||||
/v2/skin/bedrock/recent:
|
||||
get:
|
||||
callbacks: {}
|
||||
operationId: GlobalApiWeb.Api.SkinController.get_recent_uploads
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/RecentConvertedSkinList'
|
||||
description: The most recently uploaded skins. First element has been uploaded most recently etc.
|
||||
'400':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
description: Invalid page number (e.g. negative, decimal, too large)
|
||||
summary: Get a list of the most recently uploaded skins
|
||||
tags:
|
||||
- skin
|
||||
/v2/skin/{xuid}:
|
||||
get:
|
||||
callbacks: {}
|
||||
operationId: GlobalApiWeb.Api.SkinController.get_skin
|
||||
parameters:
|
||||
- description: Bedrock xuid
|
||||
example: '2535432196048835'
|
||||
in: path
|
||||
name: xuid
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ConvertedSkin'
|
||||
description: Converted skin or an empty object if there is no skin stored for that player
|
||||
'400':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
description: Invalid xuid (not an int)
|
||||
summary: Get the most recently converted skin of a Bedrock player
|
||||
tags:
|
||||
- skin
|
||||
/v2/stats:
|
||||
get:
|
||||
callbacks: {}
|
||||
operationId: GlobalApiWeb.Api.StatsController.get_all_stats (2)
|
||||
parameters: []
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Statistics'
|
||||
description: Statistics
|
||||
summary: Get all publicly available Global Api statistics
|
||||
tags:
|
||||
- stats
|
||||
/v2/utils/uuid/bedrock_or_java/{username}:
|
||||
get:
|
||||
callbacks: {}
|
||||
operationId: GlobalApiWeb.Api.UtilsController.get_bedrock_or_java_uuid
|
||||
parameters:
|
||||
- description: The username of the Minecraft player
|
||||
examples:
|
||||
bedrock:
|
||||
value: .Tim203
|
||||
java:
|
||||
value: Tim203
|
||||
in: path
|
||||
name: username
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- description: The prefix used in your Floodgate config
|
||||
example: .
|
||||
in: query
|
||||
name: prefix
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/UsernameProfile'
|
||||
description: The Bedrock xuid in Floodgate UUID format and username. Response made to be identical to the Mojang endpoint
|
||||
'204':
|
||||
description: Either the gamertag is too long or too short once the prefix was removed or there is no Xbox account registered to the gamertag
|
||||
'302':
|
||||
description: The player is a Java player and we'll redirect you to the Mojang endpoint for that username
|
||||
'400':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
description: Invalid prefix (no prefix, empty or too long)
|
||||
'503':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
description: The requested account was not cached and we were not able to call the Xbox Live API (rate limited / not setup)
|
||||
summary: Utility endpoint to get either a Java UUID or a Bedrock xuid
|
||||
tags:
|
||||
- utils
|
||||
/v2/xbox/batch/gamertag: {}
|
||||
/v2/xbox/gamertag/{xuid}:
|
||||
get:
|
||||
callbacks: {}
|
||||
operationId: GlobalApiWeb.Api.XboxController.get_gamertag_v2
|
||||
parameters:
|
||||
- description: The xuid of the Bedrock player
|
||||
in: path
|
||||
name: xuid
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/XboxGamertagResult'
|
||||
description: The gamertag associated with the xuid or an empty object if there is account with the given xuid
|
||||
'400':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
description: The xuid is invalid (not an int)
|
||||
'503':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
description: The requested account was not cached and we were not able to call the Xbox Live API (rate limited / not setup)
|
||||
summary: Get the gamertag from a xuid
|
||||
tags:
|
||||
- xbox
|
||||
/v2/xbox/xuid/{gamertag}:
|
||||
get:
|
||||
callbacks: {}
|
||||
operationId: GlobalApiWeb.Api.XboxController.get_xuid_v2
|
||||
parameters:
|
||||
- description: The gamertag of the Bedrock player
|
||||
in: path
|
||||
name: gamertag
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/XboxXuidResult'
|
||||
description: The xuid associated with the gamertag or an empty object if there is account with the given gamertag
|
||||
'400':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
description: The gamertag is invalid (empty or longer than 16 chars)
|
||||
'503':
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
description: The requested account was not cached and we were not able to call the Xbox Live API (rate limited / not setup)
|
||||
summary: Get the xuid from a gamertag
|
||||
tags:
|
||||
- xbox
|
||||
security: []
|
||||
servers:
|
||||
- url: https://api.geysermc.org
|
||||
variables: {}
|
||||
tags: []
|
||||
@@ -25,6 +25,8 @@
|
||||
"@fortawesome/react-fontawesome": "^0.2.0",
|
||||
"@mdx-js/react": "^3.0.0",
|
||||
"clsx": "^1.2.1",
|
||||
"docusaurus-plugin-openapi-docs": "^3.0.0-beta.5",
|
||||
"docusaurus-theme-openapi-docs": "^3.0.0-beta.5",
|
||||
"prism-react-renderer": "^2.1.0",
|
||||
"react": "^18.0.0",
|
||||
"react-dom": "^18.0.0",
|
||||
|
||||
+1
-2
@@ -12,8 +12,7 @@ import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
|
||||
*/
|
||||
const sidebars: SidebarsConfig = {
|
||||
// By default, Docusaurus generates a sidebar from the docs folder structure
|
||||
tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
|
||||
|
||||
apiSidebar: [{ type: 'autogenerated', dirName: 'api' }],
|
||||
geyserSidebar: [
|
||||
'geyser/index',
|
||||
{
|
||||
|
||||
Reference in new issue
Block a user