Skip to content
Snippets Groups Projects

Improve openapi.yaml

Merged Daniele Dal Santo requested to merge improve-openapi-endpoints into master
Files
12
@@ -12,6 +12,7 @@ servers:
description: This is a dummy value describing the base URL for the API.
paths:
/health:
get:
tags:
@@ -50,7 +51,7 @@ paths:
get:
tags:
- Default
summary: Check if optoboard service is unavailable
summary: Check if optoboard service is unavailable, emulates a long task
x-openapi-router-controller: itk_demo_optoboard.api.routes
operationId: longTaskCelery
responses:
@@ -96,7 +97,7 @@ paths:
/modifyOptoGUIConf:
post:
summary: Get the json file for the Configuration of the GUI
summary: Get the json file for the configuration of the GUI
x-openapi-router-controller: itk_demo_optoboard.api.routes
operationId: modifyOptoGUIConf
requestBody:
@@ -122,7 +123,7 @@ paths:
/initOptoList:
post:
summary: Endpoint which defines the list of optoboards
summary: Endpoint which defines the list of optoboards and purges all queues
x-openapi-router-controller: itk_demo_optoboard.api.routes
operationId: initOptoList
requestBody:
@@ -154,7 +155,7 @@ paths:
/statuscheck:
post:
summary: Endpoint which provides information about the status of the optoboard
summary: Endpoint that provides information about the status of the optoboard
x-openapi-router-controller: itk_demo_optoboard.api.routes
operationId: statuscheck
requestBody:
@@ -178,12 +179,12 @@ paths:
schema:
type: object
/sendWriteRequest:
/writeRegister:
post:
summary: Write register from name or hexadecimal address
description: Write register from name or hexadecimal address
x-openapi-router-controller: itk_demo_optoboard.api.routes
operationId: write_read_wrapper
operationId: writeRegister
requestBody:
description: json object with register name/address and new value
content:
@@ -194,12 +195,12 @@ paths:
200:
$ref: "#/components/responses/config_response"
/sendReadRequest:
/readRegister:
post:
summary: Read register from name or hexadecimal address
description: Read register from name or hexadecimal address
x-openapi-router-controller: itk_demo_optoboard.api.routes
operationId: read_wrapper
operationId: readRegister
requestBody:
description: json object with register name/address
content:
@@ -215,7 +216,7 @@ paths:
summary: Does a configuration of the Optoboard based on a json file in server
description: Configure the Optoboard
x-openapi-router-controller: itk_demo_optoboard.api.routes
operationId: configure_wrapper
operationId: configure
requestBody:
description: json serialized object containing the parameters of the configure script
content:
@@ -231,7 +232,7 @@ paths:
summary: Does a configuration of the Optoboard based on a json file in server
description: Configure the Optoboard
x-openapi-router-controller: itk_demo_optoboard.api.routes
operationId: configureAll_wrapper
operationId: configureAll
requestBody:
description: json serialized object containing the parameters of the configure script
content:
@@ -247,12 +248,12 @@ paths:
200:
$ref: "#/components/responses/config_response"
/BERT_wrapper:
/BERTScan:
post:
summary: Does a BER Test
description: Does a BER Test
summary: Performs a BER Test
description: Performs a BER Test on the indicated lpgbt channel
x-openapi-router-controller: itk_demo_optoboard.api.routes
operationId: BERT_wrapper
operationId: BERTScan
requestBody:
description: json serialized object containing the parameters of the bert script
content:
@@ -284,12 +285,12 @@ paths:
200:
$ref: "#/components/responses/BERT_response"
/swapPolarity_wrapper:
/swapPolarity:
post:
summary: Swaps polarities of uplinks (tx)/downlinks (rx)
description: Swaps polarities of uplinks (tx)/downlinks (rx)
x-openapi-router-controller: itk_demo_optoboard.api.routes
operationId: swapPolarity_wrapper
operationId: swapPolarity
requestBody:
description: json serialized object containing the link number, rx/tx, device, position
content:
@@ -323,12 +324,12 @@ paths:
allOf:
- $ref: "#/components/schemas/standard_model"
/setEqualizer_wrapper:
/setGBCREqualization:
post:
summary: Changes or monitors GBCR equalization settings
description: Changes or monitors GBCR equalization settings
x-openapi-router-controller: itk_demo_optoboard.api.routes
operationId: setEqualizer_wrapper
operationId: setGBCREqualization
requestBody:
description: json serialized object containing the channel number, med frequency, high frequency, device, position
content:
@@ -366,12 +367,12 @@ paths:
allOf:
- $ref: "#/components/schemas/standard_model"
/setLpgbtPhase_wrapper:
/setLpgbtPhase:
post:
summary: Change phase mode of lpGBT
description: Change phase mode of lpGBT and in case of fixed phase mode set phase
x-openapi-router-controller: itk_demo_optoboard.api.routes
operationId: setLpgbtPhase_wrapper
operationId: setLpgbtPhase
requestBody:
description: json serialised object containing phase mode, group, phase
content:
@@ -408,70 +409,6 @@ paths:
type: object
allOf:
- $ref: "#/components/schemas/standard_model"
/configDbUnavailable_wrapper:
post:
summary: Check if the configuration database is unavailable
description: Check availability of configdb
x-openapi-router-controller: itk_demo_optoboard.api.routes
operationId: configDbUnavailable_wrapper
requestBody:
description: Config DB address
content:
application/json:
schema:
type: object
properties:
CONFIGDB_ADDRESS:
type: string
example: "https://localhost:5000"
description: Config DB address
responses:
200:
description: Returns a value that signals if the configuration was successful
content:
application/json:
schema:
type: integer
example: 0
/checkAvailableDatasetInDB:
post:
summary: Check if file in DB is available
description: Check if file in DB is available
x-openapi-router-controller: itk_demo_optoboard.api.routes
operationId: checkAvailableDatasetInDB_wrapper
requestBody:
description: json serialized object containing a boolean signaling if the serial number exists and the parameters of the optoboard
content:
application/json:
schema:
type: object
properties:
path:
type: string
example: "itk_demo_optoboard/optoboard_felix/configs/00000000_test_v1.json"
description: response-text
inDB:
type: boolean
example: false
CONFIGDB_ADDRESS:
type: string
example: "https://localhost:5000"
description: Config DB address
required:
- path
- inDB
- CONFIGDB_ADDRESS
responses:
200:
description: Returns a value that signals if the configuration was successful
content:
application/json:
schema:
type: integer
example: 0
/readLog:
get:
@@ -479,7 +416,7 @@ paths:
- Default
summary: Read log file
x-openapi-router-controller: itk_demo_optoboard.api.routes
operationId: readLog_wrapper
operationId: readLog
responses:
200:
description: json serialized object containing the worker log file for the optoboard microservice
@@ -517,7 +454,7 @@ components:
- activeLpgbt
- activeGbcr
sendWriteRequest:
writeRegister:
type: object
properties:
optoboardPosition:
@@ -542,7 +479,7 @@ components:
- device
- newValue
sendReadRequest:
readRegister:
type: object
properties:
optoboardPosition:
Loading