Understanding ENUM type in API

[Analepse]

Hello everybody,

I'm trying to understand some stuff about the API and I'm struggling using certain API options that are ENUM type...
As an example, the subnet "type" option in the SDN field (https://pve.proxmox.com/pve-docs/api-viewer/#/cluster/sdn/vnets/%7Bvnet%7D/subnets)

Maybe this topic has already been covered, but I didn't find anything relevant on where to find documentation nor examples on this data type.

Many thanks in advance for all your answers !

 

[bbgeek17]

Hi @Analepse , you didn't actually specify what your struggle is. There are quite a few sites that give an explanation to what an ENUM is in API, ie:
https://appwrite.io/blog/post/enums-api-design

In short, unlike general strings, ENUM has a predefined set of possibile options. In this particular case it has to be a network subnet
Not sure if both long and short formats are accepted.

good luck

---

Blockbridge : Ultra low latency all-NVME shared storage for Proxmox - https://www.blockbridge.com/proxmox

 

[Analepse]

Hi @bbgeek17, thanks for your answer. Sorry, I indeed wasn't very clear about my question. Probably because all of this wasn't very clear in my head too... I looked for what ENUM types were, and after thinking more about all of that it's more like "where can I find all the possible options", because if I understood correctly what I learned they should be defined somewhere ?

 

[bbgeek17]

"where can I find all the possible options", because if I understood correctly what I learned they should be defined somewhere ?

probably something along these lines:
https://github.com/proxmox/pve-netw...2ae7f/src/PVE/Network/SDN/SubnetPlugin.pm#L39

I don't know if more specific documentation exists beyond - "its a CIDR compliant value".
good luck

---

Blockbridge : Ultra low latency all-NVME shared storage for Proxmox - https://www.blockbridge.com/proxmox