Bug #10358
closed
API doc for /api/v2/locations does not mention parents
Description
Cloned from https://bugzilla.redhat.com/show_bug.cgi?id=1216232
Description of problem:
The API documentation for /api/v2/locations (at https://sat.example.com/apidoc/v2/locations.html) does not make any mention of parent locations. This is problematic because it is, in fact, possible to associate a location with a parent organization by POSTing to /api/v2/locations, and also presumably by PUTting to /api/v2/locations/:id.
Version-Release number of selected component (if applicable):
Tested against Satellite-6.1.0-RHEL-6-20150424.0 and Satellite-6.1.0-RHEL-7-20150424.0.
How reproducible:
100%
Steps to Reproduce:
1.Go to https://sat.example.com/apidoc/v2/locations.html. Search for "parent".
Actual results:
No mention of parents.
Expected results:
Mention of the fact that one can associate a location with zero or more parents.
Additional info:
Updated by Dominic Cleal almost 9 years ago
- Category set to Organizations and Locations
Updated by Dominic Cleal almost 9 years ago
- Related to Feature #3912: Add ability for locations / organizations to inherit from a parent location / organization added
Updated by
Updated by Oleh Fedorenko almost 5 years ago
- Status changed from New to Closed
Closing, since parent assignment to a location/organization is mentioned in POST/PUT API documentation (which makes sense to have it there).
Parent assignment was introduced by commit: https://github.com/theforeman/foreman/commit/5c028a17ad427dc606cf45be05fc026d5435aadb
apidocs:
https://theforeman.org/api/1.22/apidoc/v2/locations/create.html
https://theforeman.org/api/1.22/apidoc/v2/locations/update.html
https://theforeman.org/api/1.22/apidoc/v2/organizations/create.html
https://theforeman.org/api/1.22/apidoc/v2/organizations/update.html