Skip to content

Commit 0c5ee56

Browse files
committed
fix: various REST Core-API documentation corrections
- ActivityGroupOverview description - Correct tags for activities button endpoints - Correct ActivityGroup response for POST /activity_groups - Activities summary for GET /activities/{entityId}/ui/pages/{pageId} - Correct 200 response code for PATCH /docks/devices/{dockId}/ports/{portId} and PATCH /entities/{entityId} - POST /macros description - Remote.options.bt.dev_profle_id data type - GET /remotes operationId - DELETE /system/wifi/scan description
1 parent ee07f49 commit 0c5ee56

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

core-api/rest/UCR-core-openapi.yaml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ openapi: 3.1.1
22
info:
33
title: Remote Two/3 REST Core-API
44
summary: REST Core-API for Remote Two/3
5-
version: 0.45.3
5+
version: 0.45.4
66
contact:
77
name: API Support
88
url: https://github.com/unfoldedcircle/core-api/issues
@@ -2776,7 +2776,7 @@ paths:
27762776
$ref: '#/components/schemas/EntityUpdateRequest'
27772777
required: true
27782778
responses:
2779-
'201':
2779+
'200':
27802780
description: Successful operation returning the configured entity in the response.
27812781
content:
27822782
application/json:
@@ -3503,7 +3503,7 @@ paths:
35033503
/activities/{entityId}/buttons/{buttonId}/{buttonPress}:
35043504
get:
35053505
tags:
3506-
- remotes
3506+
- activities
35073507
summary: Get a button press mapping.
35083508
operationId: getActivityButtonPressMapping
35093509
parameters:
@@ -3531,7 +3531,7 @@ paths:
35313531
$ref: '#/components/responses/Err404NotFound'
35323532
delete:
35333533
tags:
3534-
- remotes
3534+
- activities
35353535
summary: Remove a button press mapping.
35363536
operationId: deleteActivityButtonPressMapping
35373537
parameters:
@@ -3725,7 +3725,7 @@ paths:
37253725
get:
37263726
tags:
37273727
- activities
3728-
summary: Get the user interface page definition of a remote-entity.
3728+
summary: Get the user interface page definition of an activity-entity.
37293729
operationId: getActivityUiPage
37303730
parameters:
37313731
- $ref: '#/components/parameters/entity_id'
@@ -3881,7 +3881,7 @@ paths:
38813881
content:
38823882
application/json:
38833883
schema:
3884-
$ref: '#/components/schemas/Activity'
3884+
$ref: '#/components/schemas/ActivityGroup'
38853885
'400':
38863886
$ref: '#/components/responses/Err400BadRequest'
38873887
'401':
@@ -4058,15 +4058,15 @@ paths:
40584058
integration driver.
40594059

40604060
To create a new macro at least a name must be provided. The `icon`, `description` and `options.entity_ids`
4061-
are optional and can be set later with the `PUT` update operation.
4061+
are optional and can be set later with the `PATCH` update operation.
40624062

40634063
When setting a text in a multilingual field, like name or description, the default `en` identifier should always be
40644064
included.
40654065

40664066
The new macro can be cloned from another macro-entity identifier in `clone_from`. All applicable configuration will
40674067
be copied, except a new macro name must be specified. The `icon` and `description` fields can still be specified and
40684068
will override the copied data. The `options.entity_ids` is not allowed when cloning data, additional entities
4069-
can be added later with the `PUT` update operation.
4069+
can be added later with the `PATCH` update operation.
40704070

40714071
The `entity_ids` may be omitted when creating a new macro and specified later when updating the macro.
40724072
operationId: createMacro
@@ -5341,7 +5341,7 @@ paths:
53415341
with `/remotes/{entityId}`.
53425342

53435343
Only the IR-entity count is returned if no remote-`kind` query parameter is specified.
5344-
operationId: getInfraredEntities
5344+
operationId: getRemotes
53455345
parameters:
53465346
- name: kind
53475347
in: query
@@ -9591,7 +9591,7 @@ paths:
95919591
Once a port has been reconfigured, the WebSocket event `dock_port_mode` is sent in the `docks` channel.
95929592

95939593
Response codes:
9594-
- `201`: port configuration has been accepted. Depending on the mode, this operation might take a few seconds.
9594+
- `200`: port configuration has been accepted. Depending on the mode, this operation might take a few seconds.
95959595
- `400`: bad request, for example an unsupported or unknown mode.
95969596
- `404`: either the dock identifier or port number is not valid.
95979597
- `503`: dock connection is not available, configuration cannot be changed at the moment.
@@ -9607,7 +9607,7 @@ paths:
96079607
$ref: '#/components/schemas/ExternalPortConfigurationRequest'
96089608
required: true
96099609
responses:
9610-
'201':
9610+
'200':
96119611
description: Successful operation returning the configured port in the response.
96129612
content:
96139613
application/json:
@@ -11059,7 +11059,7 @@ paths:
1105911059
operationId: stopWifiScan
1106011060
responses:
1106111061
'200':
11062-
description: Dock discovery status
11062+
description: WiFi scan status
1106311063
content:
1106411064
application/json:
1106511065
schema:
@@ -13665,7 +13665,7 @@ components:
1366513665
- ERROR
1366613666
ActivityGroupOverview:
1366713667
description: |
13668-
Minimal activity group object intended for an overview page, which is returned when retrieving all activities.
13668+
Minimal activity group object intended for an overview page, which is returned when retrieving all activity groups.
1366913669
type: object
1367013670
properties:
1367113671
group_id:
@@ -14407,7 +14407,7 @@ components:
1440714407
properties:
1440814408
dev_profile_id:
1440914409
description: BT device profile identifier
14410-
type: boolean
14410+
type: string
1441114411
peripherals:
1441214412
$ref: '#/components/schemas/BtDevicePeripherals'
1441314413
profile:

0 commit comments

Comments
 (0)