Skip to content
GitLab
Commit 3c7ea3b3 authored by Stefan Dähling's avatar Stefan Dähling
Browse files

indicate required fields in openapi specs

parent a264c724
Pipeline #419460 passed with stages
in 3 minutes and 23 seconds
Hide whitespace changes
Inline Side-by-side
api/agency/openapi.yaml
View file @ 3c7ea3b3
......@@ -172,6 +172,14 @@ components:
status:
description: status of agency
$ref: '#/components/schemas/Status'
required:
- masid
- name
- id
- imid
- logger
- agents
- status
AgentInfo:
description: detailed information about agent
properties:
......@@ -196,6 +204,14 @@ components:
status:
description: status of agent
$ref: '#/components/schemas/Status'
required:
- spec
- masid
- agencyid
- imid
- id
- address
- status
ACLMessage:
description: message for agent communication
properties:
......@@ -256,6 +272,15 @@ components:
description: Denotes a time and/or date expression which indicates the latest
time by which the sending agent would like to receive a reply
type: string
required:
- ts
- perf
- sender
- agencys
- receiver
- agencyr
- content
- prot
Status:
description: information about an agent's or agency's status
properties:
......@@ -265,6 +290,9 @@ components:
lastupdate:
description: time of last update
type: string
required:
- code
- lastupdate
LoggerConfig:
description: contains information about agency
properties:
......@@ -283,12 +311,16 @@ components:
debug:
description: activation of debug log topic
type: boolean
required:
- active
Address:
description: holds the address information of an agent
properties:
agency:
description: name of the agency
type: string
required:
- agency
AgentSpec:
description: contains information about a agent running in a MAS
properties:
......@@ -306,4 +338,7 @@ components:
type: string
custom:
description: custom agent specification
type: string
\ No newline at end of file
type: string
required:
- nodeid
- name
\ No newline at end of file
api/ams/openapi.yaml
View file @ 3c7ea3b3
......@@ -309,6 +309,12 @@ components:
uptime:
description: uptime of MAS
type: string
required:
- id
- config
- numagents
- uptime
- status
MASInfo:
description: detailed information about MAS
properties:
......@@ -333,6 +339,14 @@ components:
uptime:
description: uptime of MAS
type: string
required:
- id
- config
- imagegroups
- agents
- uptime
- status
- graph
MASSpec:
description: contains information about a MAS running in clonemap
properties:
......@@ -347,6 +361,10 @@ components:
graph:
description: graph of MAS
$ref: '#/components/schemas/Graph'
required:
- config
- imagegroups
- graph
MASConfig:
description: contains information about mas to be started
properties:
......@@ -365,6 +383,12 @@ components:
logger:
description: configuration of logging module
$ref: '#/components/schemas/LoggerConfig'
required:
- name
- agentsperagency
- mqtt
- df
- logger
ImageGroupInfo:
description: information about an image groups
properties:
......@@ -388,6 +412,9 @@ components:
type: array
items:
$ref: '#/components/schemas/AgentSpec'
required:
- config
- agents
ImageGroupConfig:
description: configuration of image groups
properties:
......@@ -397,6 +424,9 @@ components:
secret:
description: pull secret to be used for image
type: string
required:
- image
- secret
AgencyInfoFull:
description: information about agency
properties:
......@@ -423,6 +453,14 @@ components:
type: array
items:
$ref: '#/components/schemas/AgentInfo'
required:
- masid
- name
- id
- imid
- logger
- agents
- status
MASs:
description: contains informaton about how many MASs are running
properties:
......@@ -434,6 +472,9 @@ components:
type: array
items:
$ref: '#/components/schemas/MASInfo'
required:
- counter
- instances
Agents:
description: contains informaton about how many agents are running
properties:
......@@ -445,6 +486,9 @@ components:
type: array
items:
$ref: '#/components/schemas/AgentInfo'
required:
- counter
- instances
Agencies:
description: contains informaton about how many agencies are running
properties:
......@@ -456,6 +500,9 @@ components:
type: array
items:
$ref: '#/components/schemas/AgencyInfo'
required:
- counter
- instances
ImageGroups:
description: contains informaton about all image groups of a mas
properties:
......@@ -467,6 +514,9 @@ components:
type: array
items:
$ref: '#/components/schemas/ImageGroupInfo'
required:
- counter
- instances
LoggerConfig:
description: contains information about agency
properties:
......@@ -485,18 +535,24 @@ components:
debug:
description: activation of debug log topic
type: boolean
required:
- active
DFConfig:
description: contains config of DF module
properties:
active:
description: indicates if df module is active and/or usable
type: boolean
required:
- active
MQTTConfig:
description: contains config of mqtt module
properties:
active:
description: indicates if mqtt module is active and/or usable
type: boolean
required:
- active
Graph:
description: stores one mas graph for topological search
properties:
......@@ -510,6 +566,9 @@ components:
type: array
items:
$ref: '#/components/schemas/Edge'
required:
- node
- edge
Node:
description: graph node
properties:
......@@ -521,6 +580,8 @@ components:
type: array
items:
type: integer
required:
- id
Edge:
description: one edge of graph
properties:
......@@ -533,6 +594,10 @@ components:
weight:
description: weight of edge
type: number
required:
- n1
- n2
- weight
AgencyInfo:
description: information about agency
properties:
......@@ -559,6 +624,14 @@ components:
status:
description: status of agency
$ref: '#/components/schemas/Status'
required:
- masid
- name
- id
- imid
- logger
- agents
- status
Status:
description: information about an agent's or agency's status
properties:
......@@ -568,6 +641,9 @@ components:
lastupdate:
description: time of last update
type: string
required:
- code
- lastupdate
AgentInfo:
description: detailed information about agent
properties:
......@@ -592,6 +668,14 @@ components:
status:
description: status of agent
$ref: '#/components/schemas/Status'
required:
- spec
- masid
- agencyid
- imid
- id
- address
- status
AgentSpec:
description: contains information about a agent running in a MAS
properties:
......@@ -610,9 +694,14 @@ components:
custom:
description: custom agent specification
type: string
required:
- nodeid
- name
Address:
description: holds the address information of an agent
properties:
agency:
description: name of the agency
type: string
\ No newline at end of file
type: string
required:
- address
\ No newline at end of file
api/df/openapi.yaml
View file @ 3c7ea3b3
......@@ -226,6 +226,9 @@ components:
type: array
items:
$ref: '#/components/schemas/Edge'
required:
- node
- edge
Node:
description: graph node
properties:
......@@ -237,6 +240,8 @@ components:
type: array
items:
type: integer
required:
- id
Edge:
description: one edge of graph
properties:
......@@ -249,6 +254,10 @@ components:
weight:
description: weight of edge
type: number
required:
- n1
- n2
- weight
Service:
description: DF service
properties:
......@@ -275,4 +284,13 @@ components:
type: string
dist:
description: distance
type: number
\ No newline at end of file
type: number
required:
- id
- agentid
- nodeid
- masid
- createdat
- changedat
- desc
- dist
\ No newline at end of file
api/logger/openapi.yaml
View file @ 3c7ea3b3
......@@ -262,6 +262,12 @@ components:
data:
description: additional data
type: string
required:
- masid
- agentid
- topic
- timestamp
- msg
State:
description: state of agent
properties:
......@@ -277,6 +283,11 @@ components:
state:
description: state of agent
type: string
required:
- masid
- agentid
- timestamp
- state
Communication:
description: communication data
properties:
......@@ -288,4 +299,8 @@ components:
type: integer
numrecv:
description: number of messages recived from this agent
type: integer
\ No newline at end of file
type: integer
required:
- id
- numsent
- numrecv
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment