-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update OpenAPI spec and generate new API docs
- Loading branch information
1 parent
bb6450c
commit df2f738
Showing
64 changed files
with
2,034 additions
and
411 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| --- | ||
| id: archive-dataset | ||
| title: "Archive Dataset" | ||
| description: "Archive a dataset" | ||
| api: eJylVMtu2zAQ/BVhz0wU+Kibk7RAihYNErc9GEKxljYWE4pkSMqNIfDfiyVlR6n7OPRii+LsY2ZnNULArYdqDdcY0FOAWoCx5DBIo29aqGDpmk7u6HAvoCXfOGkZ8HpdYNEeEZ6awcmwh2o9wiWhI7ccQgfVuo61AEfPA/lwado9VCM0RgfSgR/RWiWbVLt89Jx/BN901CM/BRkUnXR0l7OBgLC3fG02j9Tw2TpmEiR5jpZtypExPjiptxBj7kY6alkE2TL/twSvSVGY84sxh3lrtM+5FxcX/Pc28H5oGvL+YVDFUVEQ/0831/0nX5/Lz0hvjFGE+oT1AVnHTK2n0BkevTVJV4s8OyjRynJR4hDMd9qhKidBSswNpsG7HTmf5j44BRV0IVhflaVCH3qpCOV5S7sTF9060w4NH4qcozgrPqIPn6SiYnkDbJuDq+5Zocxx7q0jTS7JvSQY004gENPDe+N6DFDBh2+rJAUrf/dqyXcv2FsWPlvmaBUBUj+Y+WBmDRbL25vi6+KE1ymkKq5Mb40mHTwIYLkydHF+wUVY8x6TFTT2s/kXf9jA2QL9dhknVQK9hNIqlJqrpOGM02TXgFaCAG7/OF0uc8xxmHAtoGNPVGsYxw16+uJUjPz6eSDH+14L2KGTuGGF1nUU0BG25JIlnmgPFVzlds9W3BjD1cANnixDFIeIZdOQDX/F1jPb3n6+X/G4p+9Lb1qOcfgDRPqtAPgjx9HJRendCAr1dsAtY3NONge+9dYvXkqspivU+1mH45gRK/NEOkYQE5XAZ4i8aj8BQS3hmw== | ||
| sidebar_class_name: "post api-method" | ||
| info_path: api/lastmile-ai-api-v-2 | ||
| custom_edit_url: null | ||
| show_extensions: true | ||
| --- | ||
|
|
||
| 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 Heading from "@theme/Heading"; | ||
| import OperationTabs from "@theme/OperationTabs"; | ||
| import TabItem from "@theme/TabItem"; | ||
|
|
||
| <Heading | ||
| as={"h1"} | ||
| className={"openapi__heading"} | ||
| children={"Archive Dataset"} | ||
| > | ||
| </Heading> | ||
|
|
||
| <MethodEndpoint | ||
| method={"post"} | ||
| path={"/api/2/auto_eval/dataset/archive"} | ||
| context={"endpoint"} | ||
| > | ||
|
|
||
| </MethodEndpoint> | ||
|
|
||
|
|
||
|
|
||
| Archive a dataset | ||
|
|
||
| <Heading | ||
| id={"request"} | ||
| as={"h2"} | ||
| className={"openapi-tabs__heading"} | ||
| children={"Request"} | ||
| > | ||
| </Heading> | ||
|
|
||
| <MimeTabs | ||
| className={"openapi-tabs__mime"} | ||
| > | ||
| <TabItem | ||
| label={"application/json"} | ||
| value={"application/json-schema"} | ||
| > | ||
| <details | ||
| style={{}} | ||
| className={"openapi-markdown__details mime"} | ||
| data-collapsed={false} | ||
| open={true} | ||
| > | ||
| <summary | ||
| style={{}} | ||
| className={"openapi-markdown__details-summary-mime"} | ||
| > | ||
| <h3 | ||
| className={"openapi-markdown__details-summary-header-body"} | ||
| > | ||
| Body | ||
| </h3> | ||
| </summary><div | ||
| style={{"textAlign":"left","marginLeft":"1rem"}} | ||
| > | ||
|
|
||
| </div><ul | ||
| style={{"marginLeft":"1rem"}} | ||
| > | ||
| <SchemaItem | ||
| collapsible={false} | ||
| name={"id"} | ||
| required={true} | ||
| schemaName={"string"} | ||
| qualifierMessage={undefined} | ||
| schema={{"type":"string"}} | ||
| > | ||
|
|
||
| </SchemaItem> | ||
| </ul> | ||
| </details> | ||
| </TabItem> | ||
| </MimeTabs><div> | ||
| <div> | ||
| <ApiTabs | ||
| label={undefined} | ||
| id={undefined} | ||
| > | ||
| <TabItem | ||
| label={"200"} | ||
| value={"200"} | ||
| > | ||
| <div> | ||
|
|
||
|
|
||
| Successful operation | ||
|
|
||
|
|
||
| </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={"success"} | ||
| required={true} | ||
| schemaName={"boolean"} | ||
| qualifierMessage={undefined} | ||
| schema={{"type":"boolean"}} | ||
| > | ||
|
|
||
| </SchemaItem> | ||
| </ul> | ||
| </details> | ||
| </TabItem><TabItem | ||
| label={"Example (from schema)"} | ||
| value={"Example (from schema)"} | ||
| > | ||
| <ResponseSamples | ||
| responseExample={"{\n \"success\": true\n}"} | ||
| language={"json"} | ||
| > | ||
|
|
||
| </ResponseSamples> | ||
| </TabItem> | ||
| </SchemaTabs> | ||
| </TabItem> | ||
| </MimeTabs> | ||
| </div> | ||
| </TabItem> | ||
| </ApiTabs> | ||
| </div> | ||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.