Network Labels and API Access (Error in documentation)
The self-hosted documentation for network labels appears to be inaccurate. https://{{ MY_DOMAIN }}/ovirt-engine/apidoc/#/services/network_labels/methods/add The documentation asks the user to post to the following URI: POST /ovirt-engine/api/networks/123/labels However that results in a 404. The following URL should be posted to instead for a successful response: POST /ovirt-engine/api/networks/123/networklabels I discovered the discrepancy when trying to curl loop automate adding networks to my cluster, and resulted in 404s. The 'links' section of the specific network label actually do contain the right URI to hit to get the proper label tagging: "link": [ { "href": "/ovirt-engine/api/networks/929fec34-7a34-4c1b-9451-e6abf6733ac6/networklabels", "rel": "networklabels" }, { "href": "/ovirt-engine/api/networks/929fec34-7a34-4c1b-9451-e6abf6733ac6/permissions", "rel": "permissions" }, { "href": "/ovirt-engine/api/networks/929fec34-7a34-4c1b-9451-e6abf6733ac6/vnicprofiles", "rel": "vnicprofiles" } ] The hosted documentation also has confusing information with networklabels being used in the results of some requests, but this section here also just says 'labels': https://ovirt.github.io/ovirt-engine-api-model/4.1/#services/network_labels/...
On Mon, 08 Apr 2019 17:37:24 -0000 jorr@streamguys.com wrote:
The self-hosted documentation for network labels appears to be inaccurate. https://{{ MY_DOMAIN }}/ovirt-engine/apidoc/#/services/network_labels/methods/add
The documentation asks the user to post to the following URI: POST /ovirt-engine/api/networks/123/labels
However that results in a 404. The following URL should be posted to instead for a successful response: POST /ovirt-engine/api/networks/123/networklabels
I discovered the discrepancy when trying to curl loop automate adding networks to my cluster, and resulted in 404s. The 'links' section of the specific network label actually do contain the right URI to hit to get the proper label tagging: "link": [ { "href": "/ovirt-engine/api/networks/929fec34-7a34-4c1b-9451-e6abf6733ac6/networklabels", "rel": "networklabels" }, { "href": "/ovirt-engine/api/networks/929fec34-7a34-4c1b-9451-e6abf6733ac6/permissions", "rel": "permissions" }, { "href": "/ovirt-engine/api/networks/929fec34-7a34-4c1b-9451-e6abf6733ac6/vnicprofiles", "rel": "vnicprofiles" } ]
The hosted documentation also has confusing information with networklabels being used in the results of some requests, but this section here also just says 'labels': https://ovirt.github.io/ovirt-engine-api-model/4.1/#services/network_labels/...
Thanks, does https://gerrit.ovirt.org/#/c/99271/ correct all wrong occurrences you noticed?
The self-hosted documentation for network labels appears to be inaccurate. https://{{ MY_DOMAIN }}/ovirt-engine/apidoc/#/services/network_labels/methods/add
The documentation asks the user to post to the following URI: POST /ovirt-engine/api/networks/123/labels
However that results in a 404. The following URL should be posted to instead for a successful response: POST /ovirt-engine/api/networks/123/networklabels
I discovered the discrepancy when trying to curl loop automate adding networks to my cluster, and resulted in 404s. The 'links' section of the specific network label actually do contain the right URI to hit to get the
Hello Dominik, That looks like it would work. Thank you for the proposed patch! Sincerely, Jesse -----Original Message----- From: Dominik Holler <dholler@redhat.com> Sent: Monday, April 8, 2019 12:03 PM To: jorr@streamguys.com Cc: devel@ovirt.org; Ondra Machacek <omachace@redhat.com> Subject: Re: [ovirt-devel] Network Labels and API Access (Error in documentation) On Mon, 08 Apr 2019 17:37:24 -0000 jorr@streamguys.com wrote: proper label tagging:
"link": [ { "href": "/ovirt-engine/api/networks/929fec34-7a34-4c1b-9451-e6abf6733ac6/networklabe ls", "rel": "networklabels" }, { "href": "/ovirt-engine/api/networks/929fec34-7a34-4c1b-9451-e6abf6733ac6/permissions ", "rel": "permissions" }, { "href": "/ovirt-engine/api/networks/929fec34-7a34-4c1b-9451-e6abf6733ac6/vnicprofile s", "rel": "vnicprofiles" } ]
The hosted documentation also has confusing information with networklabels being used in the results of some requests, but this section here also just says 'labels':
https://ovirt.github.io/ovirt-engine-api-model/4.1/#services/network_labels/ methods/add Thanks, does https://gerrit.ovirt.org/#/c/99271/ correct all wrong occurrences you noticed?
participants (2)
-
Dominik Holler -
jorr＠streamguys.com