From: Thomas Lamprecht <t.lamprecht@proxmox.com>
To: Dennis Klochko <dennis.klochko@nakivo.com>
Cc: pve-devel@lists.proxmox.com
Subject: Re: [pve-devel] Proxmox Backup API
Date: Tue, 8 Jul 2025 08:33:06 +0200 [thread overview]
Message-ID: <f0b440b2-aabb-4d16-8647-9b1137e346b1@proxmox.com> (raw)
In-Reply-To: <CAPmH9Rw9sy7EiLUMEKcjWogV5xOVenKJXwERUyW9Tb_vLyci8w@mail.gmail.com>
Hi Dennis,
Am 08.07.25 um 05:07 schrieb Dennis Klochko:
> Thank you for the extra information, that's very helpful.
> Another question is about versioning of a plugin vs new Proxmox versions -
> in what cases should the plugin be updated?
We had a short section about [api versioning] in the storage plugin
development wiki article already, I extended it slightly to provide
some more information.
[api versioning]: https://pve.proxmox.com/wiki/Storage_Plugin_Development#API_Versioning
In general, we do not try to make hard breaks if anyhow avoidable.
That means that we normally bump the API age alongside the API version,
especially for updates during a stable release series.
On new major releases, which are due roughly every two years, we might
reduce some technical debt and make bigger changes, but even there we
try hard to not fully reset the API age to zero, but rather try to still
support the last previous major version to make updates easier for our
users and also third-party integrations.
There is a link to an [example] for how one can handle returning the
API version inside a plugin such that it can be used for a broad range
of versions, and we got an [API changelog] file tracking historic API
changes in the pve-storage git repository, if you want to see what such
bumps can entail in practice.
[example]: https://git.proxmox.com/?p=pve-storage-plugin-examples.git;a=blob;f=backup-provider-directory/src/PVE/Storage/Custom/BackupProviderDirExamplePlugin.pm;h=57df944c0475d914e2171c5b29744376eb057a5c;hb=HEAD#l37
[API changelog]: https://git.proxmox.com/?p=pve-storage.git;a=blob;f=ApiChangeLog
- Thomas
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
next prev parent reply other threads:[~2025-07-08 6:33 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <CAPmH9Rybf23f1WP0gOKUR7US32DeEwTXfmKEG_+br4VSV_bfpg@mail.gmail.com>
2025-07-02 20:17 ` Thomas Lamprecht
2025-07-08 3:07 ` Dennis Klochko via pve-devel
[not found] ` <CAPmH9Rw9sy7EiLUMEKcjWogV5xOVenKJXwERUyW9Tb_vLyci8w@mail.gmail.com>
2025-07-08 6:33 ` Thomas Lamprecht [this message]
2025-06-25 2:57 Dennis Klochko via pve-devel
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=f0b440b2-aabb-4d16-8647-9b1137e346b1@proxmox.com \
--to=t.lamprecht@proxmox.com \
--cc=dennis.klochko@nakivo.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