Files
GeyserWebsite/wiki/api/downloads.geysermc.org/project.api.mdx
T
2024-07-18 10:38:53 +01:00

179 lines
5.8 KiB
Plaintext

---
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: wiki/api/downloads.geysermc.org/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 Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Gets information about a project."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v2/projects/{project}"}
>
</MethodEndpoint>
Gets information about a project.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<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>