mirror of
https://github.com/arcan1s/ahriman.git
synced 2025-07-14 14:35:47 +00:00
style: reorder schemas properties to alphabet order
This commit is contained in:
@ -25,11 +25,11 @@ class AURPackageSchema(Schema):
|
||||
response AUR package schema
|
||||
"""
|
||||
|
||||
package = fields.String(required=True, metadata={
|
||||
"description": "Package base",
|
||||
"example": "ahriman",
|
||||
})
|
||||
description = fields.String(required=True, metadata={
|
||||
"description": "Package description",
|
||||
"example": "ArcH linux ReposItory MANager",
|
||||
})
|
||||
package = fields.String(required=True, metadata={
|
||||
"description": "Package base",
|
||||
"example": "ahriman",
|
||||
})
|
||||
|
@ -25,10 +25,10 @@ class ChangesSchema(Schema):
|
||||
response package changes schema
|
||||
"""
|
||||
|
||||
changes = fields.String(metadata={
|
||||
"description": "Package changes in patch format",
|
||||
})
|
||||
last_commit_sha = fields.String(metadata={
|
||||
"description": "Last recorded commit hash",
|
||||
"example": "f1875edca1eb8fc0e55c41d1cae5fa05b6b7c6",
|
||||
})
|
||||
changes = fields.String(metadata={
|
||||
"description": "Package changes in patch format",
|
||||
})
|
||||
|
@ -25,18 +25,6 @@ class CountersSchema(Schema):
|
||||
response package counters schema
|
||||
"""
|
||||
|
||||
total = fields.Integer(required=True, metadata={
|
||||
"description": "Total amount of packages",
|
||||
"example": 6,
|
||||
})
|
||||
_unknown = fields.Integer(data_key="unknown", required=True, metadata={
|
||||
"description": "Amount of packages in unknown state",
|
||||
"example": 0,
|
||||
})
|
||||
pending = fields.Integer(required=True, metadata={
|
||||
"description": "Amount of packages in pending state",
|
||||
"example": 2,
|
||||
})
|
||||
building = fields.Integer(required=True, metadata={
|
||||
"description": "Amount of packages in building state",
|
||||
"example": 1,
|
||||
@ -45,7 +33,19 @@ class CountersSchema(Schema):
|
||||
"description": "Amount of packages in failed state",
|
||||
"example": 1,
|
||||
})
|
||||
pending = fields.Integer(required=True, metadata={
|
||||
"description": "Amount of packages in pending state",
|
||||
"example": 2,
|
||||
})
|
||||
success = fields.Integer(required=True, metadata={
|
||||
"description": "Amount of packages in success state",
|
||||
"example": 3,
|
||||
})
|
||||
total = fields.Integer(required=True, metadata={
|
||||
"description": "Total amount of packages",
|
||||
"example": 6,
|
||||
})
|
||||
unknown_ = fields.Integer(data_key="unknown", required=True, metadata={
|
||||
"description": "Amount of packages in unknown state",
|
||||
"example": 0,
|
||||
})
|
||||
|
@ -30,17 +30,17 @@ class EventSchema(Schema):
|
||||
"description": "Event creation timestamp",
|
||||
"example": 1680537091,
|
||||
})
|
||||
data = fields.Dict(keys=fields.String(), metadata={
|
||||
"description": "Event metadata if available",
|
||||
})
|
||||
event = fields.String(required=True, metadata={
|
||||
"description": "Event type",
|
||||
"example": EventType.PackageUpdated,
|
||||
})
|
||||
message = fields.String(metadata={
|
||||
"description": "Event message if available",
|
||||
})
|
||||
object_id = fields.String(required=True, metadata={
|
||||
"description": "Event object identifier",
|
||||
"example": "ahriman",
|
||||
})
|
||||
message = fields.String(metadata={
|
||||
"description": "Event message if available",
|
||||
})
|
||||
data = fields.Dict(keys=fields.String(), metadata={
|
||||
"description": "Event metadata if available",
|
||||
})
|
||||
|
@ -31,14 +31,14 @@ class EventSearchSchema(PaginationSchema):
|
||||
"description": "Event type",
|
||||
"example": EventType.PackageUpdated,
|
||||
})
|
||||
object_id = fields.String(metadata={
|
||||
"description": "Event object identifier",
|
||||
"example": "ahriman",
|
||||
})
|
||||
from_date = fields.Integer(metadata={
|
||||
"description": "Minimal creation timestamp, inclusive",
|
||||
"example": 1680537091,
|
||||
})
|
||||
object_id = fields.String(metadata={
|
||||
"description": "Event object identifier",
|
||||
"example": "ahriman",
|
||||
})
|
||||
to_date = fields.Integer(metadata={
|
||||
"description": "Maximal creation timestamp, exclusive",
|
||||
"example": 1680537091,
|
||||
|
@ -33,10 +33,10 @@ class LogSchema(Schema):
|
||||
message = fields.String(required=True, metadata={
|
||||
"description": "Log message",
|
||||
})
|
||||
process_id = fields.String(metadata={
|
||||
"description": "Process unique identifier",
|
||||
})
|
||||
version = fields.String(required=True, metadata={
|
||||
"description": "Package version to tag",
|
||||
"example": __version__,
|
||||
})
|
||||
process_id = fields.String(metadata={
|
||||
"description": "Process unique identifier",
|
||||
})
|
||||
|
@ -25,11 +25,11 @@ class LoginSchema(Schema):
|
||||
request login schema
|
||||
"""
|
||||
|
||||
username = fields.String(required=True, metadata={
|
||||
"description": "Login username",
|
||||
"example": "user",
|
||||
})
|
||||
password = fields.String(required=True, metadata={
|
||||
"description": "Login password",
|
||||
"example": "pa55w0rd",
|
||||
})
|
||||
username = fields.String(required=True, metadata={
|
||||
"description": "Login username",
|
||||
"example": "user",
|
||||
})
|
||||
|
@ -30,10 +30,10 @@ class LogsSearchSchema(PaginationSchema):
|
||||
head = fields.Boolean(metadata={
|
||||
"description": "Return versions only without fetching logs themselves",
|
||||
})
|
||||
process_id = fields.String(metadata={
|
||||
"description": "Process unique identifier to search",
|
||||
})
|
||||
version = fields.String(metadata={
|
||||
"description": "Package version to search",
|
||||
"example": __version__,
|
||||
})
|
||||
process_id = fields.String(metadata={
|
||||
"description": "Process unique identifier to search",
|
||||
})
|
||||
|
@ -37,22 +37,14 @@ class PackagePropertiesSchema(Schema):
|
||||
"description": "Package build timestamp",
|
||||
"example": 1680537091,
|
||||
})
|
||||
depends = fields.List(fields.String(), metadata={
|
||||
"description": "Package dependencies list",
|
||||
"example": ["devtools"],
|
||||
})
|
||||
make_depends = fields.List(fields.String(), metadata={
|
||||
"description": "Package make dependencies list",
|
||||
"example": ["python-build"],
|
||||
})
|
||||
opt_depends = fields.List(fields.String(), metadata={
|
||||
"description": "Package optional dependencies list",
|
||||
"example": ["python-aiohttp"],
|
||||
})
|
||||
check_depends = fields.List(fields.String(), metadata={
|
||||
"description": "Package test dependencies list",
|
||||
"example": ["python-pytest"],
|
||||
})
|
||||
depends = fields.List(fields.String(), metadata={
|
||||
"description": "Package dependencies list",
|
||||
"example": ["devtools"],
|
||||
})
|
||||
description = fields.String(metadata={
|
||||
"description": "Package description",
|
||||
"example": "ArcH linux ReposItory MANager",
|
||||
@ -73,6 +65,14 @@ class PackagePropertiesSchema(Schema):
|
||||
"description": "Package licenses",
|
||||
"example": ["GPL3"],
|
||||
})
|
||||
make_depends = fields.List(fields.String(), metadata={
|
||||
"description": "Package make dependencies list",
|
||||
"example": ["python-build"],
|
||||
})
|
||||
opt_depends = fields.List(fields.String(), metadata={
|
||||
"description": "Package optional dependencies list",
|
||||
"example": ["python-aiohttp"],
|
||||
})
|
||||
provides = fields.List(fields.String(), metadata={
|
||||
"description": "Package provides list",
|
||||
"example": ["ahriman-git"],
|
||||
|
@ -32,18 +32,18 @@ class PackageSchema(Schema):
|
||||
"description": "Package base",
|
||||
"example": "ahriman",
|
||||
})
|
||||
version = fields.String(required=True, metadata={
|
||||
"description": "Package version",
|
||||
"example": __version__,
|
||||
})
|
||||
remote = fields.Nested(RemoteSchema(), required=True, metadata={
|
||||
"description": "Package remote properties",
|
||||
packager = fields.String(metadata={
|
||||
"description": "packager for the last success package build",
|
||||
"example": "ahriman bot <ahriman@example.com>",
|
||||
})
|
||||
packages = fields.Dict(
|
||||
keys=fields.String(), values=fields.Nested(PackagePropertiesSchema()), required=True, metadata={
|
||||
"description": "Packages which belong to this base",
|
||||
})
|
||||
packager = fields.String(metadata={
|
||||
"description": "packager for the last success package build",
|
||||
"example": "ahriman bot <ahriman@example.com>",
|
||||
remote = fields.Nested(RemoteSchema(), required=True, metadata={
|
||||
"description": "Package remote properties",
|
||||
})
|
||||
version = fields.String(required=True, metadata={
|
||||
"description": "Package version",
|
||||
"example": __version__,
|
||||
})
|
||||
|
@ -25,19 +25,19 @@ class RepositoryStatsSchema(Schema):
|
||||
response repository stats schema
|
||||
"""
|
||||
|
||||
bases = fields.Int(metadata={
|
||||
"description": "Amount of unique packages bases",
|
||||
"example": 2,
|
||||
})
|
||||
packages = fields.Int(metadata={
|
||||
"description": "Amount of unique packages",
|
||||
"example": 4,
|
||||
})
|
||||
archive_size = fields.Int(metadata={
|
||||
"description": "Total archive size of the packages in bytes",
|
||||
"example": 42000,
|
||||
})
|
||||
bases = fields.Int(metadata={
|
||||
"description": "Amount of unique packages bases",
|
||||
"example": 2,
|
||||
})
|
||||
installed_size = fields.Int(metadata={
|
||||
"description": "Total installed size of the packages in bytes",
|
||||
"example": 42000000,
|
||||
})
|
||||
packages = fields.Int(metadata={
|
||||
"description": "Amount of unique packages",
|
||||
"example": 4,
|
||||
})
|
||||
|
@ -25,7 +25,7 @@ class SearchSchema(Schema):
|
||||
request package search schema
|
||||
"""
|
||||
|
||||
_for = fields.List(fields.String(), data_key="for", required=True, metadata={
|
||||
for_ = fields.List(fields.String(), data_key="for", required=True, metadata={
|
||||
"description": "Keyword for search",
|
||||
"example": ["ahriman"],
|
||||
})
|
||||
|
Reference in New Issue
Block a user