class InstalledVersions(BaseSchema):
site = fields.String(
description="The site where this API call was made on.", example="production"
)
group = fields.String(
description="The Apache WSGI application group this call was made on.", example="de"
)
rest_api = fields.Dict(description="The REST-API version", example={"revision": "1.0.0"})
versions = fields.Dict(description="Some version numbers", example={"checkmk": "1.8.0p1"})
edition = fields.String(description="The Checkmk edition.", example="raw")
demo = fields.Bool(description="Whether this is a demo version or not.", example=False)
class Parameter(Linkable):
id = fields.String(
description=(
"the Id of this action parameter (typically a concatenation of the parent "
"action Id with the parameter name)"
),
required=True,
example="folder-move",
)
number = fields.Integer(
description="the number of the parameter (starting from 0)", required=True, example=0
)
name = fields.String(
description="the name of the parameter", required=True, example="destination"
)
friendlyName = fields.String(
description="the action parameter name, formatted for rendering in a UI.",
required=True,
example="The destination folder id",
)
description = fields.String(
description="a description of the action parameter, e.g. to render as a tooltip.",
required=False,
example="The destination",
)
optional = fields.Bool(
description="indicates whether the action parameter is optional",
required=False,
example=False,
)
# for string only
format = fields.String(
description=(
"for action parameters requiring a string or number value, indicates how to"
" interpret that value A2.5."
),
required=False,
)
maxLength = fields.Integer(
description=(
"for string action parameters, indicates the maximum allowable length. A "
"value of 0 means unlimited."
),
required=False,
)
pattern = fields.String(
description=(
"for string action parameters, indicates a regular expression for the "
"property to match."
),
required=False,
)
class VersionCapabilities(BaseSchema):
blobsClobs = fields.Bool(
required=False,
description="attachment support",
)
deleteObjects = fields.Bool(
required=False,
description=
("deletion of persisted objects through the DELETE Object resource C14.3,"
" see A3.5"),
)
domainModel = fields.Str(
required=False,
description=
('different domain metadata representations. A value of "selectable" means '
"that the reserved x-domain-model query parameter is supported, see A3.1"
),
)
protoPersistentObjects = fields.Bool()
validateOnly = fields.Bool(
required=False,
description="the reserved x-ro-validate-only query parameter, see A3.2",
)
