Skip to content

Commit

Permalink
Update OpenAPI Spec and Docs (#153)
Browse files Browse the repository at this point in the history
This PR updates the [OpenAPI spec with lmai commit e6a1f8f](https://github.com/lastmile-ai/lmai/blob/e6a1f8f/www/swagger/models/2/model.json) and regenerates the API documentation.
  • Loading branch information
rholinshead authored Feb 25, 2025
2 parents f1804d3 + 65b21e7 commit 0a44031
Show file tree
Hide file tree
Showing 30 changed files with 2,913 additions and 138 deletions.
185 changes: 185 additions & 0 deletions website/docs/api/add-project-members.api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
---
id: add-project-members
title: "Add Project Members"
description: "Description of add_members"
api: eJytlMFu2zAQRH9F2DMTGT7q5qQt4KJBjcRtD4YQrKWNzYQiGZJyYgj892Ip2VacNr30JEoakjuzj+wg4MZDsYKFM49UBSgFGEsOgzR6XkMBs7oe/t1QsybnQUBNvnLSsgYK+HR6y8xDhnV93xylnqrWybCHYtXBFaEjN2vDFopVGUsBjp5b8uHK1HsoOqiMDqQDD9FaJatUR/7oeaMOfLWlBnkUZFD0p+pu+wVBQNhbVph18iXAOjYWJHlewPaz2GJ3kPrgpN5AFOCMonntR//QOdyDABmoGX+XOtCGHMQYezfSUc2BnjY4LVfGQeat0b4vZDqZ8ONtpHdtVZH3D63Kjt0A8V/i6bf+Zz6+r2DkdG2MItRwbvSgTOaigIbC1jA51qQ+WOR2Q45W5tMc22DuaYcqHwLKz3lxOx4xLq1TUMA2BOuLPFfoQyMVobysafeOwoUzdVslCPs1sovsG/pwIxVlszkwbQcY7zio3ucYyaNV3pJrSTK2nkQghsEX4xoMUMDXX8sUBzfg9kTy51dsLOf/BrMDXiO6VpMyCpD6wYybNqo6my3m2c/pO7PvJUV2bRprNOnAMXKGvXR6OWGiuRkNJkw0NgMb2QBH9pejPTqQH5/yIbdAryG3CqXmLVP7uqH/K0ArQQB7OTLQUzfwN16xFLBleooVdN0aPf1wKkb+/NyS48ukFLBDJ3HNka04xi1hTS6B80R7KOC6r/1iycWxXLXpJJ+fnCgOM2ZVRTZ8qC1HgC++3y0ZiuHyakzNcxy+cI/xBQoAvk15dmItfetAod60uGFtvyYjhG8JPCMuuTrcRHo/qrDresXSPJGOEcRgJfA7RD6UvwFnegg9
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={"Add Project Members"}
>
</Heading>

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

</MethodEndpoint>



Description of add_members

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

</SchemaItem><SchemaItem
collapsible={false}
name={"roleIds"}
required={true}
schemaName={"integer[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"integer"}}}
>

</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>
13 changes: 11 additions & 2 deletions website/docs/api/get-role.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: get-role
title: "Get Role"
description: "Description of get_role"
api: eJylVd9v2jAQ/leie3YbxGPeKGUVVVcQ0E0bipBJDnCb2K7t0KIo//t0TqABOqZtT7HP9/u++1KC42sL0RwmaFVhEgzGaHJhrVASYgZKo+FOKDlMIYI7dBOVITBI0SZGaHqBCG4/boFaBWt0C1PrWUwKI9wOonkJN8gNml7hNhDN4ypmYPC1QOtuVLqDqIRESYfS0ZFrnYnEhw6fLUUpwSYbzDmdnHAZfiQ0qd0AA7fTJFfLZ0zorg1V4ARaMhOpN651hHS4RgNVVechDKbUCZFCXFW11GolbW3b7XToc1z4tEgStHZVZMGhU8D+o4464B8L8d1t2TdT+ZfqGUieY+vFOiPkmh4oyswLTx8ZoCxyj5vRw2Ax+zEeLJ4ep+NBf/hlOLgF1pZPB5MjwWhy13sc/uzNhqPHo4fxZHQ/6M8Id+3CfApNOk8WjW3lw43hO2AgHOb2tCOk/HddOZR3PGZyFIg0WCkTuA0Ghb3YuXNANaoxPa0Nlw7TmaIUh+nlak6h+lvXrWm1O/VJuPjUiQeTh3zFIEe3UbTrWvmF0py2FUKuRdgNeeHUArc8C03DFwt94IvwaO/N1k9qXkJhMohg45y2URhm3LpcZMjFdYrbs1aPjUqLxDNJ7SO4Ch64dV9FhkFvCMQae1KZ0h7VU2xTy6FtFJJy8WoQwdIrAWsOX5TJuYMI7r/P/NBoPycfjDR457mu94xA0qkYCLlSbZS1Mgt642HwrXtW0LlKFPRVrpVE6WhA1KdatXvdIVRR53PumaIGGNFD8BnxthjzAgc33XD47kKdcSEpiB9K2Yx3DlwLYEDZH0YMngBPh0yI2ruOGWwIJdEcynLJLT6ZrKpI/FqgIc6PGWy5EXxJ3ZrHFYMN8hSNx8UL7iCCfl3BVQPdLc8KvwqnvFmxvUUvSVC7i7pxC8jj0XRGM2/+MblKycbwNyqQv0EEQP85sq65lWQlZFyuC74m3donIYQfA+wEUL6q/SrLXSvDsqw1ZuoFZVUBa0pxdIeKlu8XuKCROg==
api: eJylVVFv0zAQ/ivWPXtk2mPeyihQBGvVdiCoouqW3FpDYhvbKVRR/js6J+vSdgwBT3Hsu/Pdd999biDgxkO6gjl5U7ucxIxcpbxXRkMmwVhyGJTRkwJSeENhbkoCCQX53CnLJ5DCq8c/Ye7FhsLadXae8tqpsId01cBLQkduVIctpKuszSQ4+l6TDy9NsYe0gdzoQDrwEq0tVR6vTr56vqUBn2+pQl4FFUp6TGjehQEJYW9539x9pZz/reMKgiLPbqqIzp2N0oE25KBtuzyUo4KRUAVkbdvtemu073yvLi/5c1z4os5z8v6+LsUBKZD/UUd34R8LiegO/Puu/Ev1EjRWNDjxwSm94YNCeVvi/ubJ81MOvK0r1BeOsMC7kkTvKzi4uDdOhC2JmDYDa0paxmjnUUnXVSTk9P14vfw8G69vbxaz8fXk9WT8CuRwfzGeH21M529GN5Mvo+VkenN0MJtP342vl0zoIWIxhT6dW0/OD/JB53APElSgyp9CzcZ/B/dvQONAQhUHgGr/bEvOmdqbZny0cagDFUvDKU6K56s5nYHfhj6mwaB3Q9yeuDw7DRmbHyerlVBR2BqWFGvi3FpkUYAErUquEqyDWdMOy8T1srS2B1lKjuTF7WLfVg3UroQUtiFYnyZJiT5UqiRULwranQE/c6ao8yhYXQxxId6jDx9USWI0ARanB+1a8Lh2PR0q2AFEvpJziWaQwl00AtkvXhtXYYAU3n1axhayDMwfhW/8EyvbjTNT5rKVoPS9GXJukJkYzSbi49VZQecmqbg2lTWadOAGMU6d6dWLS+YYI19hFKSObqxC4il9HwjzM1LfoxHoZ0hsiUrzJbEpTd/eFaBVIIGzP7QYos6eNpkZ9RA6k7BllqQraJo79HTryrbl7e81OX5aMgk7dIqFJ74sEraEBbnIi2+0hxSuuwoueurusKzjYJzKcysfPEZ5TjY8a5sNiDybLpbc8/4pq0zBPg5/cIH4A1IAfk7Zu5Nw3mugRL2pccO2XUxmCB4T7IRQsaqHwdb7QYZN01kszTfSbQuyLyXwP7Q8fL8Ampa1rg==
sidebar_class_name: "post api-method"
info_path: api/lastmile-ai-api-v-2
custom_edit_url: null
Expand Down Expand Up @@ -196,6 +196,15 @@ Description of get_role
schema={{"type":"string"}}
>

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

</SchemaItem><SchemaItem
collapsible={false}
name={"roleType"}
Expand Down Expand Up @@ -293,7 +302,7 @@ Description of get_role
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"role\": {\n \"id\": 0,\n \"name\": \"string\",\n \"roleType\": \"ROLE_TYPE_UNSPECIFIED\",\n \"roleUsers\": [\n {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n ],\n \"grantedToRoleIds\": [\n 0\n ]\n }\n}"}
responseExample={"{\n \"role\": {\n \"id\": 0,\n \"name\": \"string\",\n \"displayName\": \"string\",\n \"roleType\": \"ROLE_TYPE_UNSPECIFIED\",\n \"roleUsers\": [\n {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n ],\n \"grantedToRoleIds\": [\n 0\n ]\n }\n}"}
language={"json"}
>

Expand Down
Loading

0 comments on commit 0a44031

Please sign in to comment.