public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: n.frey@proxmox.com
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH pve-manager 4/5] api: add service state return schema
Date: Fri, 19 Sep 2025 11:33:31 +0200	[thread overview]
Message-ID: <20250919093915.21641-5-n.frey@proxmox.com> (raw)
In-Reply-To: <20250919093915.21641-1-n.frey@proxmox.com>

From: Nicolas Frey <n.frey@proxmox.com>

Signed-off-by: Nicolas Frey <n.frey@proxmox.com>
---
 PVE/API2/Services.pm | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/PVE/API2/Services.pm b/PVE/API2/Services.pm
index 708b6613..c8e3e933 100644
--- a/PVE/API2/Services.pm
+++ b/PVE/API2/Services.pm
@@ -241,7 +241,35 @@ __PACKAGE__->register_method({
     },
     returns => {
         type => "object",
-        properties => {},
+        properties => {
+            'active-state' => {
+                type => 'string',
+                enum => ['active', 'inactive', 'unknown'],
+                description => 'Current active state of the service process.',
+            },
+            'state' => {
+                type => 'string',
+                enum => ['running', 'dead', 'unknown'],
+                description => 'Execution status of the service.',
+            },
+            'unit-state' => {
+                type => 'string',
+                enum => ['enabled', 'disabled', 'not-found'],
+                description => 'Whether the service is enabled to start at boot.',
+            },
+            'service' => {
+                type => 'string',
+                description => 'Systemd unit name (e.g., pveproxy).',
+            },
+            'name' => {
+                type => 'string',
+                description => 'Short identifier for the service (e.g., "pveproxy").',
+            },
+            'desc' => {
+                type => 'string',
+                description => 'Human-readable description of the service.',
+            },
+        },
     },
     code => sub {
         my ($param) = @_;
-- 
2.47.3


_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel


  parent reply	other threads:[~2025-09-19  9:40 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-19  9:33 [pve-devel] [PATCH pve-manager 0/5] api: add return schemas and fix grammar in ifupdown2 error message n.frey
2025-09-19  9:33 ` [pve-devel] [PATCH pve-manager 1/5] Fix grammar in ifupdown2 version " n.frey
2025-09-19  9:33 ` [pve-devel] [PATCH pve-manager 2/5] api: add ACME plugin return schema n.frey
2025-09-19  9:33 ` [pve-devel] [PATCH pve-manager 3/5] api: add APT versions " n.frey
2025-09-19  9:33 ` n.frey [this message]
2025-09-19  9:33 ` [pve-devel] [PATCH pve-manager 5/5] api: add replication config read " n.frey

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250919093915.21641-5-n.frey@proxmox.com \
    --to=n.frey@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal