Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update OpenAPI Spec and Docs #151

Closed
wants to merge 1 commit into from
Closed

Update OpenAPI Spec and Docs #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions website/docs/api/get-role.api.mdx
View file
Open in desktop
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
13 changes: 11 additions & 2 deletions website/docs/api/list-assignable-roles.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: list-assignable-roles
title: "List Assignable Roles"
description: "Description of list_assignable_roles"
api: eJzNVk2P2zgM/SsCz2o9mKNv6TSzSDE7CZLMLnbTIFBsJlYrS64kJw0M//cFZSfO58ws0ENPtuUnkiLfI1WBF2sH8QzG6ExpE2QjtLl0ThoNcw6mQCu8NHqQQgxP0vmec3KtxVLh2Ch0wCFFl1hZEApi+Nx9MbNiSjq/EIc9C9tucpiUVvodxLMKPqGwaHulzyCezes5B4s/SnT+k0l3EFeQGO1Re3oVRaFkEmKKvjlyWYFLMswFvXnpFV6PdNyYBA5+VxDGLL9hQt+FpWN6iY5M2DYTzyLHYLJBO2+lXkPNYSWVR+ve5+6xBb/l9UeJdnfp7jy7DoVNMhbQzJXLBsZy4ZOMrYxlmqKuOVCep8HUpUnUZR5qPnzqL6b/jPqLl+fJqP8weBz0PwM/Xp/0xycLw/EfvefBv73pYPh88mM0Hn7pP0yJM/ukjPchnB/CIoWSeOYN85l0jIJlB3hd13XDAGkxpUBPSjI/N/doLBPMFZjIlcSU7dE8kI8JpYIDR+62mUwy5jNkG4lbtGxrSpWyJTIqHPPmq2YNWw9mWHFQhDvE5gqjXVO5+7s7epzGNCmTBJ1blYodJAT8F/G4cf42kYPUuvoLa8UOOEiP+Ql7yeyb1mR6ZEpqj2u0RDR9Sya/EwPbcF7cXrfvyAiB/19WbmiWDDGZBnkS80r3aubOuC9TaKFz+rW2QntMp4ZCHKSvn+asWLdNH1XrOFNX3M0vxRloRuv0J0efGZoVhQm9thDU1CEShYzuI1F6s8CNUNFeXYtOXdHtWWE3oXCzCkqrIIbM+8LFUaSE87lUKOTHFDcXmR9Zk5ZJGEWNDfaBPQnn/5QKWW8ANGn2g2hC2muKejyODlkklxRLgEEMywAC3r48GpsLDzF8+XsaakiaHndTrP9T5IXCywHTseZorrTToPvXiemGZsil1Ctz0jy6o7LeaMD+ur/I0CUkZg8mL4xG7Sn3lPgGev/xjlhLdc1FaFcNgUOPYl2TYlfvBUcz/L1XhDbxHn/6qFBCanIf6l+1tJqBKCRwoHMdqAUcrpALOFz3M+eQEVXjGVTVUjh8saquabktwmzOYSOspD3hesIhQ5GiDXz8jlSnh+ZsH1oFbYQqgyLPe3zN9zt6SYKFfxU7P1LTaDiZEtfa+1BuUtpjxZZOK7YQA9BlzYchRRyjtQqU0OtSrAnb2CSaiFNinxE5nGrfUfTuKMKqahBT8x11XQNvj+LpG2rqAP8BBdiN8Q==
api: eJzNVk2P4kYQ/SutOnuW0Rx9Y2eZhNVkQMAkSghChV3g3m13e7vbsMjyf4+qbb5hZiLlkBPGfl1f71VVV+Bx5SCewoicKW1CYkg2l85Jo2EWgSnIopdG91OI4Vk633VOrjQuFI2MIgcRpOQSKwtGQQxfDv+EWQolnZ/j/szctoccJaWVfgvxtILPhJZst/QZxNNZPYvA0o+SnP9s0i3EFSRGe9KeH7EolExCTJ1vjl1W4JKMcuQnL72i65GOGpMQgd8WjDGLb5Tw/8Jyml6SYxO2rcQL5hRMNmjnrdQrqCNYSuXJuo+5e2rB73n9UZLdXro7r64jtEkmAlq4ctHARI4+ycTSWKE56joCrvMkmLo0SbrMA+eD59588uewN399GQ97j/2nfu8LRMfvx73RyYvB6JfuS/+v7qQ/eDn5MBwNvvYeJ6yZXVFGuxDOk7DEoSReeCN8Jp3gYMUeXtd13ShAWko50BNKZufmnowVKFxBiVxKSsUOHQXxCVQqOHDsbpPJJBM+I7GWtCErNqZUqViQYOKEN39r0ah1b0YU+45w+9hcYbRrmHu4v+ef05jGZZKQc8tSiX0LQfQf6bhx/r6QQ6sd+EdrcQsRSE/5iXrZ7LvWZHpkSmpPK7IsNH2rTVLpCoXb6210zuGvZY76zhKmgYf2bFBzkDUzxvn836TdhvPqdgPhA6Vm8L8r942isSEh032BSvcmJWdNJVNooTP+tLKoPaUTwyH207ezOVPBbdOnMjji7rhuV5zPLmdAUDO/5y85+czwSipMGOkF8u6ADhay89DB0ps5rVF1dk08PzRx5/ZKsutA47SC0iqIIfO+cHGno9D5XCpC+Sml9QUPQ2vSMgkbr7Eh7sQzOv+bVCS6feCFttt3Y27xhuLjrbevKbvkWAIMYlgEEETtw5OxOXqI4esfk8Aoj47RYVn2fmJeKLrcYwcNHa2vdukcvh1a60YHsUupl+ZkRh1SFd1hX/z+cFGhS0gsHk1eGE3ac+258A304dM9a5h5zTFMxUbOYRSKwywUV68fR1eFj95E2sJ7+uk7hUKp2X3gv2plNQUsJETAee2lBRFcERdEcN3PLIKMpRpPoaoW6OjVqrrm1y0J01kEa7SSz4RbUAQZYUo26PE7MU+PTW53bQetUZWhP89XSR3tTnSThAr/JnZ21E3DwXjCWmuvXblJ+YzFDWeLG4gB+E7owy5kjfG7ChTqVYkrxjY2WSZ4KuwzIYesdvNFb48irKoGMTHfSdc1RG0qnv9DzRPgH8nHsmU=
sidebar_class_name: "post api-method"
info_path: api/lastmile-ai-api-v-2
custom_edit_url: null
Expand Down Expand Up @@ -250,6 +250,15 @@ Description of list_assignable_roles
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 @@ -353,7 +362,7 @@ Description of list_assignable_roles
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"roles\": [\n {\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 ]\n}"}
responseExample={"{\n \"roles\": [\n {\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 ]\n}"}
language={"json"}
>

Expand Down
Loading