Skip to content

chore: update Web Console API spec with tsoa-generated endpoints #263

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

Merged
calthejuggler merged 2 commits into from
May 12, 2026
Merged

chore: update Web Console API spec with tsoa-generated endpoints #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2c6dec
chore: update Web Console API spec with tsoa-generated endpoints
calthejuggler May 12, 2026
9ca33de
chore: rename API endpoints and fix Examples sidebar
calthejuggler May 12, 2026
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
4 changes: 4 additions & 0 deletions docs/APIs-and-SDKs/Web-Console-API/Examples/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position": 2,
"label": "Examples"
}
6 changes: 3 additions & 3 deletions docs/APIs-and-SDKs/Web-Console-API/api-key-get.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ description: "**Required Permissions**: `ApiKey Get` or `ApiKey Admin`"
sidebar_label: "API Key GET"
hide_title: true
hide_table_of_contents: true
api: eJy1VkuT4zQQ/iuqvgDBmwdHnwgLRS3UMlM7O8VhMmQ6difWjixppXYmJuX/TkmyM54nsBS5xLa6v35/rSOU5AsnLUujIYfJ5AN9bqSjUpyTq6X30mg/meTiZmnlr9SKn4lvhHGn92VZS30DGVh0WBOT85BfHUFjTZADRql3JWQggwGLXEEGrrcCObuGMvBFRTVCfgRubdCTmmlHDrrskYcfKxKyFGYruCKxPH8nghdcIYvWNOJO+kqwETtiUSKj2DpTT6G7Dja9NdqTD2a+m8/D30Pspfjl4uw3cbb5RAULFBYdy6JR6KKhW2q/8hF1ChkURjNpDihorZIFBpTZJx+gjk8jMhE1JMoZS45lcgStXN9S+/eCsnw+PSnRpxPPTuodZEAHrK0Kn5ZKibcfLn8csvUkqa8q6yF2cSe5EqiUsPetEbAeun/C2BpXI0MOTSPLIDdWe0beIjO5UIfCETJlVErOSlLElDnCiNF4KtcYs64bpXATnEw99KL9EpnesKwpACTsAePf6WzadePJrV8qRWPLEfaX+TdgPLT1AtbI9r2P/6DnXFHJPY2j2BijCPW49FtUnroMcI+M7jnUh16dRNdbqWjdWGWwXDdOvd5gs8IZe+nUbDGfHxbz+WwxtXr3v5Yqg1pqWTc15Is4C2HQ636YX/b0PbpbYpmcoxrls5Gd/EoSXZcBS44Alz7UavQhcSh06ZdBTVyZEnLYEaeJqEKGeo7ws+NApx1k4MntB7aNWYaK2fp8NvOoy405THHja3Ss2mlh6tl+EWnQU9E4yW3UCx71TuRX1+Pji8BfqV3GQqd4kycDrVeEZUzsY0INuieW3pr0jA1Xxsk/I2NOxWTyvvEsNiSkjqyeUihWIT9vgmJrGpfq2adiBZMJDNwHyzEe9NskHPzRA6xWfrW6+DbmXuqtiXEMNfihT5L4nTbirdHeqLhYIIOQ3xTJYjqfzp/Gp8WZJR1iurBUyG2/BdI+SrIb8mlVnewE8ZCKO+Nupd4lXg0hCjpYcjJ0ohfWmZ3DukaWBSrVDjsHi8QufejBdGOtcaFh+qYMxfn+QfFDxypZkPY0Uj53xjpJjK6NqbHGc436EXzc+j99fBz88X4D/pdrQ99OTAeeWYVSRxJMpJH6/2rYkR4yyE8XiusMKuM5nB+PG/R06VTXhc+fG3KxnzPYo5OJoa6OUEofnsue2l6J5+shnG/El903XohrmB0dBmePqglv0G/Q+7tSd91lw0gFx9PxsijI8kjxybUjzO+JQkLJuu4vEdJgBw==
api: eJy1Vk1z2zYQ/SuYvbRVGX30yJuadDJpJ7Unjk+WK6/IlYgIBBBgaZvV8L93AJAy/SG3Tae6iCQWb/ftLt7iACX5wknL0mjIYTL5RF8b6agU5+Rq6b002k8mubhZWvkbteI98Y0w7vi+LGupbyADiw5rYnIe8qsDaKwJcsBo9aGEDGRwYJEryMD1XiBn11AGvqioRsgPwK0N+6Rm2pGDLnsS4eeKhCyF2QquSCzPP4gQBVfIojWNuJO+EmzEjliUyCi2ztRT6K6DT2+N9uSDm5/m8/D3GHspfr04+12cbb5QwQKFRceyaBS66GhP7Xc+ok4hg8JoJs0BBa1VssCAMvviA9ThOSMTUUOinLHkWKZA0Mr1ntq/N5Tly+lJiT6ueHZS7yADusfaqvBpqZR4++ny3ZCtZ0l9dbMeuIs7yZVApYR9aI2A9Tj8I8bWuBoZcmgaWQa78bYX7C0ykwt1KBwhU0al5KwkRUyZI4wYjadyjTHrulEKNyHI1EMn/ZfI9IZlTQEgYQ8Y/27Ppl03ntz6VCkaW46wvy2+AeOxrxNYI98PMf6DnnNFJW9pzGJjjCLU49JvUXnqMsBbZHQvoT6O6mi63kpF68Yqg+W6cer1BpsVzthLp2aL+fx+MZ/PFlOrd/9rqTKopZZ1U0O+iGchHPS6P8ynI/2Ibk8sU3BUo3yR2TGuZNF1GbDkCHDpQ61GH5KGQpd+GdTElSkhhx1xOhFVyFCvEX52GOS0gww8udtBbWOWoWK2Pp/NPOpyY+6nuPE1OlbttDB11EBPReMkt3FTCKePIL+6Hi9fBPFKvTI2OpJNYQyaXhGWMatP1TTsPUr01qRnbLgyTv4Z5XIqJpOPjWexISF1lPSUP7EKyXkTNramcamYfR5WMJnAIHywHONBP0rCwh89wGrlV6uLH2Pipd6ayKMvwAaLPekwnUIqU9yL6Xw6f85GizNLOjC4sFTIbS/4afQk2w35NJV+7vMeCQfid8btpd4lCQ2EBN1bcjI0nRfWmZ3DukaWBSrVDuMFi9CRXQZKFqR9lPme9bkz1klidG0kZo3nGvXIYsj7+18+PyVzeBhe/2Xi983AdM8zq1DqqF/pvKfWvRrGm4cM8uNd4DqDyngO64fDBj1dOtV14fPXhlzsxgxu0ckkLlcHKKUPz2WvSq/w+X6g84P4tqvCCV5D5+vQ9reomvAG/fB7uOZ01102HIgQeFpeFgVZHm18dmMIp+94+kPJuu4vlaJJOQ==
sidebar_class_name: "get api-method"
info_path: docs/APIs-and-SDKs/Web-Console-API/absmartly-web-console-api
info_path: docs/APIs-and-SDKs/Web-Console-API/backend
custom_edit_url: null
---

Expand Down Expand Up @@ -38,5 +38,5 @@ import TabItem from "@theme/TabItem";

A JSON Object a particular API key's data.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix missing word in response description.

Line 39 should read “A JSON Object containing a particular API key’s data.”

🧰 Tools
🪛 LanguageTool

[uncategorized] ~39-~39: Possible missing comma found.
Context: ...bel={"200"} value={"200"}>

A JSON Object a particular API key's data.
<di...

(AI_HYDRA_LEO_MISSING_COMMA)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/APIs-and-SDKs/Web-Console-API/api-key-get.api.mdx` at line 39, Update
the response description text in the API doc so it reads "A JSON Object
containing a particular API key's data." — locate the sentence "A JSON Object a
particular API key's data." in the Web-Console-API file (api-key-get.api.mdx)
and insert the missing word "containing" to correct the description.


</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"}>api_key</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"All CRUD API Key"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"An API key with all permissions"}}></SchemaItem><SchemaItem collapsible={false} name={"key"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"permissions"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `create,edit,delete,read`"} schema={{"type":"string","pattern":"create,edit,delete,read"}}></SchemaItem><SchemaItem collapsible={false} name={"used_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"created_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"created_by_user_id"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"updated_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"updated_by_user_id"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"nullable":true,"type":"integer"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>created_by</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"archived"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"avatar"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"avatar_file_upload_url"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/cropUrl/100x100/1.png"}}></SchemaItem><SchemaItem collapsible={false} name={"created_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"created_by_user_id"} required={false} schemaName={"integer"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","minimum":1}}></SchemaItem><SchemaItem collapsible={false} name={"department"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Marketing"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"email"} qualifierMessage={undefined} schema={{"type":"string","format":"email"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"api_key\": {\n \"id\": 0,\n \"name\": \"All CRUD API Key\",\n \"description\": \"An API key with all permissions\",\n \"key\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"permissions\": \"string\",\n \"used_at\": \"2026-01-14T09:35:17.583Z\",\n \"created_at\": \"2026-01-14T09:35:17.583Z\",\n \"created_by_user_id\": 0,\n \"updated_at\": \"2026-01-14T09:35:17.583Z\",\n \"updated_by_user_id\": 0,\n \"created_by\": {\n \"archived\": false,\n \"avatar\": {},\n \"avatar_file_upload_url\": \"/cropUrl/100x100/1.png\",\n \"created_at\": \"2026-01-14T09:35:17.583Z\",\n \"created_by_user_id\": 0,\n \"department\": \"Marketing\",\n \"email\": \"user@example.com\"\n }\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
</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"}>api_key</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"All CRUD API Key"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"An API key with all permissions"}}></SchemaItem><SchemaItem collapsible={false} name={"key"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"permissions"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `create,edit,delete,read`"} schema={{"type":"string","pattern":"create,edit,delete,read"}}></SchemaItem><SchemaItem collapsible={false} name={"used_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"created_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"created_by_user_id"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"updated_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"updated_by_user_id"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"nullable":true,"type":"integer"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>created_by</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"archived"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"avatar"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"avatar_file_upload_url"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/cropUrl/100x100/1.png"}}></SchemaItem><SchemaItem collapsible={false} name={"created_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"created_by_user_id"} required={false} schemaName={"integer"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","minimum":1}}></SchemaItem><SchemaItem collapsible={false} name={"department"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Marketing"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"email"} qualifierMessage={undefined} schema={{"type":"string","format":"email"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"api_key\": {\n \"id\": 0,\n \"name\": \"All CRUD API Key\",\n \"description\": \"An API key with all permissions\",\n \"key\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"permissions\": \"string\",\n \"used_at\": \"2026-05-12T11:04:55.950Z\",\n \"created_at\": \"2026-05-12T11:04:55.950Z\",\n \"created_by_user_id\": 0,\n \"updated_at\": \"2026-05-12T11:04:55.950Z\",\n \"updated_by_user_id\": 0,\n \"created_by\": {\n \"archived\": false,\n \"avatar\": {},\n \"avatar_file_upload_url\": \"/cropUrl/100x100/1.png\",\n \"created_at\": \"2026-05-12T11:04:55.950Z\",\n \"created_by_user_id\": 0,\n \"department\": \"Marketing\",\n \"email\": \"user@example.com\"\n }\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>

Loading
Loading