From 6392520e06799f413ea5d1f2e97fc78ff408b64a Mon Sep 17 00:00:00 2001 From: Evgenii Alekseev Date: Sun, 13 Jul 2025 15:34:22 +0300 Subject: [PATCH] style: reorder schemas properties to alphabet order --- src/ahriman/web/schemas/aur_package_schema.py | 8 +++---- src/ahriman/web/schemas/changes_schema.py | 6 ++--- src/ahriman/web/schemas/counters_schema.py | 24 +++++++++---------- src/ahriman/web/schemas/event_schema.py | 12 +++++----- .../web/schemas/event_search_schema.py | 8 +++---- src/ahriman/web/schemas/log_schema.py | 6 ++--- src/ahriman/web/schemas/login_schema.py | 8 +++---- src/ahriman/web/schemas/logs_search_schema.py | 6 ++--- .../web/schemas/package_properties_schema.py | 24 +++++++++---------- src/ahriman/web/schemas/package_schema.py | 18 +++++++------- .../web/schemas/repository_stats_schema.py | 16 ++++++------- src/ahriman/web/schemas/search_schema.py | 2 +- 12 files changed, 69 insertions(+), 69 deletions(-) diff --git a/src/ahriman/web/schemas/aur_package_schema.py b/src/ahriman/web/schemas/aur_package_schema.py index 3c06228d..b31ae388 100644 --- a/src/ahriman/web/schemas/aur_package_schema.py +++ b/src/ahriman/web/schemas/aur_package_schema.py @@ -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", + }) diff --git a/src/ahriman/web/schemas/changes_schema.py b/src/ahriman/web/schemas/changes_schema.py index 621aa2b5..92455bc7 100644 --- a/src/ahriman/web/schemas/changes_schema.py +++ b/src/ahriman/web/schemas/changes_schema.py @@ -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", - }) diff --git a/src/ahriman/web/schemas/counters_schema.py b/src/ahriman/web/schemas/counters_schema.py index d2b89449..553de0d1 100644 --- a/src/ahriman/web/schemas/counters_schema.py +++ b/src/ahriman/web/schemas/counters_schema.py @@ -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, + }) diff --git a/src/ahriman/web/schemas/event_schema.py b/src/ahriman/web/schemas/event_schema.py index 0a2f3079..81e46bd5 100644 --- a/src/ahriman/web/schemas/event_schema.py +++ b/src/ahriman/web/schemas/event_schema.py @@ -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", - }) diff --git a/src/ahriman/web/schemas/event_search_schema.py b/src/ahriman/web/schemas/event_search_schema.py index d3e0fff5..257ac03f 100644 --- a/src/ahriman/web/schemas/event_search_schema.py +++ b/src/ahriman/web/schemas/event_search_schema.py @@ -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, diff --git a/src/ahriman/web/schemas/log_schema.py b/src/ahriman/web/schemas/log_schema.py index 5a4bd49f..2d00c532 100644 --- a/src/ahriman/web/schemas/log_schema.py +++ b/src/ahriman/web/schemas/log_schema.py @@ -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", - }) diff --git a/src/ahriman/web/schemas/login_schema.py b/src/ahriman/web/schemas/login_schema.py index a1401543..1b5c6c28 100644 --- a/src/ahriman/web/schemas/login_schema.py +++ b/src/ahriman/web/schemas/login_schema.py @@ -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", + }) diff --git a/src/ahriman/web/schemas/logs_search_schema.py b/src/ahriman/web/schemas/logs_search_schema.py index 4dc293a9..777cc76d 100644 --- a/src/ahriman/web/schemas/logs_search_schema.py +++ b/src/ahriman/web/schemas/logs_search_schema.py @@ -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", - }) diff --git a/src/ahriman/web/schemas/package_properties_schema.py b/src/ahriman/web/schemas/package_properties_schema.py index cad9fb67..487093a3 100644 --- a/src/ahriman/web/schemas/package_properties_schema.py +++ b/src/ahriman/web/schemas/package_properties_schema.py @@ -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"], diff --git a/src/ahriman/web/schemas/package_schema.py b/src/ahriman/web/schemas/package_schema.py index 7573956d..9aa3cbd4 100644 --- a/src/ahriman/web/schemas/package_schema.py +++ b/src/ahriman/web/schemas/package_schema.py @@ -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 ", }) 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 ", + remote = fields.Nested(RemoteSchema(), required=True, metadata={ + "description": "Package remote properties", + }) + version = fields.String(required=True, metadata={ + "description": "Package version", + "example": __version__, }) diff --git a/src/ahriman/web/schemas/repository_stats_schema.py b/src/ahriman/web/schemas/repository_stats_schema.py index bb5b5a7d..8221f05b 100644 --- a/src/ahriman/web/schemas/repository_stats_schema.py +++ b/src/ahriman/web/schemas/repository_stats_schema.py @@ -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, + }) diff --git a/src/ahriman/web/schemas/search_schema.py b/src/ahriman/web/schemas/search_schema.py index 5a5b82fa..f6bb46ca 100644 --- a/src/ahriman/web/schemas/search_schema.py +++ b/src/ahriman/web/schemas/search_schema.py @@ -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"], })