From: Aaron Lauterer <a.lauterer@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH manager 3/3] api: ceph: update return value definitions
Date: Wed, 21 Dec 2022 14:30:26 +0100 [thread overview]
Message-ID: <20221221133026.4155850-4-a.lauterer@proxmox.com> (raw)
In-Reply-To: <20221221133026.4155850-1-a.lauterer@proxmox.com>
to have at either a more accurate description or some description at
all. For objects returning a lot of data, for example individual Ceph
services, a full description has been omitted as I think that this would
be a bit much.
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
---
PVE/API2/Ceph.pm | 7 ++++++-
PVE/API2/Ceph/MON.pm | 14 +++++++++++---
PVE/API2/Ceph/OSD.pm | 13 +++++++++++++
PVE/API2/Cluster/Ceph.pm | 23 ++++++++++++++++++++++-
4 files changed, 52 insertions(+), 5 deletions(-)
diff --git a/PVE/API2/Ceph.pm b/PVE/API2/Ceph.pm
index 55220324..cc8720b2 100644
--- a/PVE/API2/Ceph.pm
+++ b/PVE/API2/Ceph.pm
@@ -622,7 +622,12 @@ __PACKAGE__->register_method ({
type => 'array',
items => {
type => "object",
- properties => {},
+ properties => {
+ name => {
+ description => "Name of the CRUSH rule.",
+ type => "string",
+ }
+ },
},
links => [ { rel => 'child', href => "{name}" } ],
},
diff --git a/PVE/API2/Ceph/MON.pm b/PVE/API2/Ceph/MON.pm
index 5771bb46..b452045c 100644
--- a/PVE/API2/Ceph/MON.pm
+++ b/PVE/API2/Ceph/MON.pm
@@ -212,9 +212,17 @@ __PACKAGE__->register_method ({
items => {
type => "object",
properties => {
- name => { type => 'string' },
- addr => { type => 'string', optional => 1 },
- host => { type => 'string', optional => 1 },
+ name => { type => 'string' },
+ addr => { type => 'string', optional => 1 },
+ host => { type => 'boolean', optional => 1 },
+ direxists => { type => 'string', optional => 1 },
+ quorum => { type => 'boolean', optional => 1 },
+ host => { type => 'string', optional => 1 },
+ rank => { type => 'integer', optional => 1 },
+ service => { type => 'integer', optional => 1 },
+ state => { type => 'string', optional => 1 },
+ ceph_version => { type => 'string', optional => 1 },
+ ceph_version_short => { type => 'string', optional => 1 },
},
},
links => [ { rel => 'child', href => "{name}" } ],
diff --git a/PVE/API2/Ceph/OSD.pm b/PVE/API2/Ceph/OSD.pm
index 93433b3a..ce1281d9 100644
--- a/PVE/API2/Ceph/OSD.pm
+++ b/PVE/API2/Ceph/OSD.pm
@@ -88,6 +88,19 @@ __PACKAGE__->register_method ({
# fixme: return a list instead of extjs tree format ?
returns => {
type => "object",
+ items => {
+ type => "object",
+ properties => {
+ flags => { type => "string" },
+ root => {
+ type => "object",
+ description => "extjs formatted grid tree",
+ },
+ },
+ },
+
+
+ }
},
code => sub {
my ($param) = @_;
diff --git a/PVE/API2/Cluster/Ceph.pm b/PVE/API2/Cluster/Ceph.pm
index 7f825003..49f84b24 100644
--- a/PVE/API2/Cluster/Ceph.pm
+++ b/PVE/API2/Cluster/Ceph.pm
@@ -68,7 +68,20 @@ __PACKAGE__->register_method ({
},
},
},
- returns => { type => 'object' },
+ returns => {
+ type => 'object'
+ description => "Items for each type of service containing objects for each instance.",
+ items => {
+ type => "object",
+ properties => {
+ mds => { type => "object" },
+ mgr => { type => "object" },
+ mon => { type => "object" },
+ node => { type => "object" },
+ osd => { type => "object" },
+ }
+ },
+ },
code => sub {
my ($param) = @_;
@@ -181,6 +194,14 @@ __PACKAGE__->register_method ({
description => "Flag name.",
type => 'string', enum => $possible_flags_list,
},
+ description => {
+ description => "Flag description.",
+ type => 'string',
+ },
+ value => {
+ description => "Flag value.",
+ type => 'boolean',
+ },
},
},
links => [ { rel => 'child', href => "{name}" } ],
--
2.30.2
next prev parent reply other threads:[~2022-12-21 13:30 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-21 13:30 [pve-devel] [PATCH manager 0/3] Ceph API fixes/updates Aaron Lauterer
2022-12-21 13:30 ` [pve-devel] [PATCH manager 1/3] ceph api: fix descriptions Aaron Lauterer
2022-12-21 13:56 ` [pve-devel] applied: " Thomas Lamprecht
2022-12-21 13:30 ` [pve-devel] [PATCH manager 2/3] api: ceph: update index list Aaron Lauterer
2022-12-21 13:56 ` [pve-devel] applied: " Thomas Lamprecht
2022-12-21 13:30 ` Aaron Lauterer [this message]
2022-12-21 14:06 ` [pve-devel] [PATCH manager 3/3] api: ceph: update return value definitions Thomas Lamprecht
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=20221221133026.4155850-4-a.lauterer@proxmox.com \
--to=a.lauterer@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