Skip to content

Commit

Permalink
Update OpenAPI spec and generate new API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Feb 20, 2025
1 parent d5ad168 commit 1f05c75
Show file tree
Hide file tree
Showing 14 changed files with 1,280 additions and 29 deletions.
283 changes: 283 additions & 0 deletions website/docs/api/list-applicable-permissions.api.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,283 @@
---
id: list-applicable-permissions
title: "List Applicable Permissions"
description: "Description of list_applicable_permissions"
api: eJytVU1v2zgQ/SvEnJUqyFE39yPYLLq7QZK2B68RjKWxxZYiGXKU1hD03xdDyZFsBw4K7MmS/GaGM+/NYweM2wjFEu4oujaUpG4pNDpG7SysMnCeArJ29qaCAj7ryAvvjS5xbWhCRsigolgG7QULBXyc3pTbKKMjP+JL5KM/CI1UtkHzDoplB+8JA4VFyzUUy1W/yiDQU0uR37tqB0UHpbNMluVxzChV8u9RCncQy5oalCfWbOjcqe+GxJAB77wg3fo7lfLugzTOmqIkCuNs/saGUuIBHTlou4U+g402TCH+TtHrMeSt2k8thd1p0eN5R8JQ1iqhVWzXA0w1yGWtNi4oK2fv+74f5qkDVUL7QWur46zXLihU0VOpN5oqtUdniVCFxqgZk4prZIWBlLSs2Kk1KYxRby1V/1r5gCo4M50jemfj0OfV5aX8HNa/b8uSYty0Rr0IEbL/VQHDEd6kYS7YiQwMAXeQgWZqDtifLdFbme2rojpm4ovVTy2Z3YWuyLLe7IRdCU3kck0zIkSRlY7e4O51xR4n/6Nt0F4EwioRN8aeTT+PP1mII42lDg+PdJhhdSLL+bjlX/m/Ia6duJB3aWc9ikVAjl7nVzm27B7pGU2+F+nMZPK3/Cc8p/VddtAGAwXUzD4WeW4wcqMNoX5X0fPJ4G6Dq9oymdyQQ12ozxj5L21ILW5A3GtvbveiyoHyucW9DE9KylkSDApYJxBk48O1Cw0yFPDnt4c0YVH73eSMn35h4w2d2tVE+sylRleZM6btxh3szNSHWtzeqK9XJ+2fQgr1wTXeWbIsg5WpDtCrd5eiG6GuQTvpPq2mmnZTnblUZtb/e/fLOGGmX5x7gzpJOBHdjSpaAnoNGUiPL0qCDF7REmRwrtoqg1r0WSyh69YY6UswfS+fx5kvVxk8Y9ASmW64DGrCikKS3w8SWj4MfV48yMEFbtpkN8dm12f7iEVZkuez2NVshW7/uX8QaY1XauMqiQn4U3rGn1AAyN3Pe79L3zowaLctbgU75BTh4KGOj3Sbutrbpd3NTth1A+LB/SDb95CNrbC8Qy9r/x8J2g4q
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={"List Applicable Permissions"}
>
</Heading>

<MethodEndpoint
method={"post"}
path={"/api/2/auto_eval/resource_permission/list_applicable_permissions"}
context={"endpoint"}
>

</MethodEndpoint>



Description of list_applicable_permissions

<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={"resourceName"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>

</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
filters
</strong><span
className={"openapi-schema__name"}
>
object
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"query"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"search query substring match for name"}}
>

</SchemaItem>
</div>
</details>
</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={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
permissions
</strong><span
className={"openapi-schema__name"}
>
object[]
</span><span
className={"openapi-schema__divider"}
>

</span><span
className={"openapi-schema__required"}
>
required
</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={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Uniquely-identifying name for the permission"}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"displayName"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Human-readable display name for the permission"}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"description"}
required={true}
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>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"permissions\": [\n {\n \"name\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\"\n }\n ]\n}"}
language={"json"}
>

</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>
Loading

0 comments on commit 1f05c75

Please sign in to comment.