OAPI: change worker 'nickname' to just 'name'

There was no need to have the extra four letters 'nick', and some parts
of the code were already using just 'name' for the workers. This simplifies
and unifies things.
This commit is contained in:
Sybren A. Stüvel 2022-06-16 11:01:27 +02:00
parent 12f0a605a4
commit 55676b000e

View File

@ -744,20 +744,20 @@ components:
WorkerRegistration: WorkerRegistration:
type: object type: object
required: [secret, platform, supported_task_types, nickname] required: [secret, platform, supported_task_types, name]
properties: properties:
secret: { type: string } secret: { type: string }
platform: { type: string } platform: { type: string }
supported_task_types: supported_task_types:
type: array type: array
items: { type: string } items: { type: string }
nickname: { type: string } name: { type: string }
RegisteredWorker: RegisteredWorker:
type: object type: object
properties: properties:
uuid: { type: string, format: uuid } uuid: { type: string, format: uuid }
nickname: { type: string } name: { type: string }
address: { type: string } address: { type: string }
status: { $ref: "#/components/schemas/WorkerStatus" } status: { $ref: "#/components/schemas/WorkerStatus" }
platform: { type: string } platform: { type: string }
@ -767,7 +767,7 @@ components:
items: { type: string } items: { type: string }
required: required:
- uuid - uuid
- nickname - name
- address - address
- status - status
- platform - platform
@ -782,12 +782,12 @@ components:
WorkerSignOn: WorkerSignOn:
type: object type: object
properties: properties:
nickname: { type: string } name: { type: string }
supported_task_types: supported_task_types:
type: array type: array
items: { type: string } items: { type: string }
software_version: { type: string } software_version: { type: string }
required: [nickname, supported_task_types, software_version] required: [name, supported_task_types, software_version]
WorkerStateChange: WorkerStateChange:
type: object type: object
@ -1389,7 +1389,7 @@ components:
type: string type: string
format: uuid format: uuid
description: UUID of the Worker description: UUID of the Worker
"nickname": { type: string, description: "Name of the worker" } "name": { type: string, description: "Name of the worker" }
"updated": "updated":
type: string type: string
format: date-time format: date-time
@ -1399,7 +1399,7 @@ components:
"status_change": "status_change":
$ref: "#/components/schemas/WorkerStatusChangeRequest" $ref: "#/components/schemas/WorkerStatusChangeRequest"
"version": { type: string } "version": { type: string }
required: [id, nickname, updated, status, version] required: [id, name, updated, status, version]
SocketIOSubscription: SocketIOSubscription:
type: object type: object
@ -1443,7 +1443,7 @@ components:
description: Basic information about a Worker. description: Basic information about a Worker.
properties: properties:
"id": { type: string, format: uuid } "id": { type: string, format: uuid }
"nickname": { type: string } "name": { type: string }
"status": { $ref: "#/components/schemas/WorkerStatus" } "status": { $ref: "#/components/schemas/WorkerStatus" }
"status_change": "status_change":
$ref: "#/components/schemas/WorkerStatusChangeRequest" $ref: "#/components/schemas/WorkerStatusChangeRequest"
@ -1459,7 +1459,7 @@ components:
"version": "version":
type: string type: string
description: Version of Flamenco this Worker is running description: Version of Flamenco this Worker is running
required: [id, nickname, status, version] required: [id, name, status, version]
Worker: Worker:
description: All information about a Worker description: All information about a Worker
@ -1477,7 +1477,7 @@ components:
items: { type: string } items: { type: string }
required: required:
- id - id
- nickname - name
- status - status
- ip_address - ip_address
- platform - platform