ITQC/pydase
24
0
Fork 0
mirror of https://github.com/tiqi-group/pydase.git synced 2025-04-21 00:40:01 +02:00
Code Issues Packages Projects Releases Wiki Activity

reflecting changes in openapi.yaml

Browse Source
This commit is contained in:
Mose Müller 2024-07-30 09:18:32 +02:00
parent d45d2dba7d
commit 940f7039d3
1 changed files with 78 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
docs/user-guide/interaction/openapi.yaml
View File

@ -44,24 +44,24 @@ paths:
schema: schema:
$ref: '#/components/schemas/SerializedException' $ref: '#/components/schemas/SerializedException'
examples: examples:
List:
summary: List out of index
value:
docs: null
full_access_path: ""
name: SerializationPathError
readonly: false
type: Exception
value: "Index '2': list index out of range"
Attribute: Attribute:
summary: Attribute or dict key does not exist summary: Attribute does not exist
value: value:
docs: null docs: null
full_access_path: "" full_access_path: ""
name: SerializationPathError name: AttributeError
readonly: false readonly: true
type: Exception type: Exception
value: "Key 'invalid_attribute': 'invalid_attribute'." value: "'MyService' object has no attribute 'invalid_attribute'"
List:
summary: List index out of range
value:
docs: null
full_access_path: ""
name: IndexError
readonly: true
type: Exception
value: "list index out of range"
/api/v1/update_value: /api/v1/update_value:
put: put:
tags: tags:
@ -86,24 +86,33 @@ paths:
schema: schema:
$ref: '#/components/schemas/SerializedException' $ref: '#/components/schemas/SerializedException'
examples: examples:
List:
summary: List out of index
value:
docs: null
full_access_path: ""
name: SerializationPathError
readonly: false
type: Exception
value: "Index '2': list index out of range"
Attribute: Attribute:
summary: Attribute does not exist summary: Attribute does not exist
value: value:
docs: null docs: null
full_access_path: "" full_access_path: ""
name: SerializationPathError name: AttributeError
readonly: false readonly: true
type: Exception type: Exception
value: "Key 'invalid_attribute': 'invalid_attribute'." value: "'MyService' object has no attribute 'invalid_attribute'"
ReadOnly:
summary: Attribute is read-only
value:
docs: null
full_access_path: ""
name: AttributeError
readonly: true
type: Exception
value: "property 'readonly_property' of 'MyService' object has no setter"
List:
summary: List index out of range
value:
docs: null
full_access_path: ""
name: IndexError
readonly: true
type: Exception
value: "list index out of range"
/api/v1/trigger_method: /api/v1/trigger_method:
put: put:
tags: tags:
@ -142,6 +151,49 @@ paths:
readonly: false readonly: false
type: "float" type: "float"
value: 23.2 value: 23.2
'400':
description: Method does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/SerializedException'
examples:
Args:
summary: Wrong number of arguments
value:
docs: null
full_access_path: ""
name: TypeError
readonly: true
type: Exception
value: "MyService.some_function() takes 1 positional argument but 2 were given"
Attribute:
summary: Attribute does not exist
value:
docs: null
full_access_path: ""
name: AttributeError
readonly: true
type: Exception
value: "'MyService' object has no attribute 'invalid_method'"
List:
summary: List index out of range
value:
docs: null
full_access_path: ""
name: IndexError
readonly: true
type: Exception
value: "list index out of range"
Dict:
summary: Dictionary key does not exist
value:
docs: null
full_access_path: ""
name: KeyError
readonly: true
type: Exception
value: "invalid_key"
components: components:
schemas: schemas:
UpdateValue: UpdateValue:
@ -261,7 +313,7 @@ components:
example: SerializationPathError example: SerializationPathError
readonly: readonly:
type: boolean type: boolean
example: false example: true
type: type:
type: string type: string
example: Exception example: Exception