Skip to content

Commit 845b2c9

Browse files
committed
Add missing totem APIs
1 parent c90187e commit 845b2c9

File tree

1 file changed

+86
-4
lines changed

1 file changed

+86
-4
lines changed

openapi.yaml

Lines changed: 86 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1767,7 +1767,7 @@ paths:
17671767
$ref: '#/components/responses/ForbiddenError'
17681768
security: []
17691769

1770-
/totems/register:
1770+
/totems:
17711771
post:
17721772
tags:
17731773
- totem
@@ -1803,18 +1803,76 @@ paths:
18031803
'404':
18041804
$ref: '#/components/responses/NotFoundError'
18051805
security: []
1806+
1807+
get:
1808+
tags:
1809+
- totem
1810+
summary: Get all totems
1811+
description: Get all registered totems
1812+
operationId: getAllTotems
1813+
parameters:
1814+
- name: limit
1815+
in: query
1816+
description: Maximum number of items to return
1817+
required: false
1818+
schema:
1819+
type: integer
1820+
minimum: 1
1821+
maximum: 100
1822+
default: 20
1823+
- name: offset
1824+
in: query
1825+
description: Number of items to skip
1826+
required: false
1827+
schema:
1828+
type: integer
1829+
minimum: 0
1830+
default: 0
1831+
responses:
1832+
'200':
1833+
description: Successful operation
1834+
content:
1835+
application/json:
1836+
schema:
1837+
type: array
1838+
items:
1839+
$ref: '#/components/schemas/TotemResponse'
1840+
'400':
1841+
$ref: '#/components/responses/InvalidInputError'
1842+
'422':
1843+
$ref: '#/components/responses/ValidationError'
1844+
'500':
1845+
$ref: '#/components/responses/InternalServerError'
1846+
'503':
1847+
$ref: '#/components/responses/UnexpectedError'
1848+
'401':
1849+
$ref: '#/components/responses/UnauthorizedError'
1850+
'403':
1851+
$ref: '#/components/responses/ForbiddenError'
1852+
'404':
1853+
$ref: '#/components/responses/NotFoundError'
1854+
security: []
1855+
1856+
/totems/{id}:
1857+
parameters:
1858+
- name: id
1859+
in: path
1860+
description: MAC address of the totem to return
1861+
required: true
1862+
schema:
1863+
type: string
1864+
example: "AA:BB:CC:DD:EE:FF"
18061865

1807-
/totems/config:
18081866
get:
18091867
tags:
18101868
- totem
18111869
summary: Get totem configuration
1812-
description: Returns the configuration for a specific totem based on its MAC address
1870+
description: Get the configuration of a specific totem by its ID
18131871
operationId: getTotemConfig
18141872
parameters:
18151873
- name: id
18161874
in: query
1817-
description: MAC address of the totem
1875+
description: ID of the totem to retrieve
18181876
required: true
18191877
schema:
18201878
type: string
@@ -1842,6 +1900,30 @@ paths:
18421900
$ref: '#/components/responses/NotFoundError'
18431901
security: []
18441902

1903+
delete:
1904+
tags:
1905+
- totem
1906+
summary: Delete a totem by ID
1907+
description: Delete a totem by its ID
1908+
operationId: deleteTotemById
1909+
responses:
1910+
'204':
1911+
description: Totem deleted successfully
1912+
'400':
1913+
$ref: '#/components/responses/InvalidInputError'
1914+
'422':
1915+
$ref: '#/components/responses/ValidationError'
1916+
'500':
1917+
$ref: '#/components/responses/InternalServerError'
1918+
'503':
1919+
$ref: '#/components/responses/UnexpectedError'
1920+
'401':
1921+
$ref: '#/components/responses/UnauthorizedError'
1922+
'403':
1923+
$ref: '#/components/responses/ForbiddenError'
1924+
'404':
1925+
$ref: '#/components/responses/NotFoundError'
1926+
18451927
components:
18461928
schemas:
18471929

0 commit comments

Comments
 (0)