The "run" URL violate the OpenStack API guide
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| Zun |
Fix Released
|
Medium
|
prameswar | ||
Bug Description
This is the "run" API:
POST /v1/containers/run
This violates the OpenStack API design guide: http://
It is often the case that an API will have URIs that represent collections for resources and individual members of that collection in a hierarchy.
Per my understanding, it means the following:
* /v1/containers represent collections of resources
* /v1/containers/<ID or NAME> represent individual members of that collection
However, the URL /v1/containers/run might be interpreted as an individual member with name "run". This is not an effective URL design. According to the guide, it suggested to change it as following
POST /v1/containers?
| Changed in zun: | |
| assignee: | nobody → prameswar (prameswar) |
| Changed in zun: | |
| status: | New → Triaged |
| importance: | Undecided → Medium |
| Changed in zun: | |
| status: | Triaged → In Progress |
| Changed in zun: | |
| status: | In Progress → Fix Committed |
| status: | Fix Committed → In Progress |
| OpenStack Infra (hudson-openstack) wrote Fix merged to zun (master) | #1 |
| Changed in zun: | |
| status: | In Progress → Fix Released |
Reviewed: https:/
Committed: https:/
Submitter: Jenkins
Branch: master
commit ec216e57d66db2f
Author: prameswar <email address hidden>
Date: Mon Dec 26 21:24:53 2016 +0530
zun run URL changed to /v1/containers?
The "run" URL violating the OpenStack API guide.
This is the "run" API:
POST /v1/containers/run
In particular, the guide said:
It is often the case that an API will have URIs that represent collections
for resources and individual members of that collection in a hierarchy.
Per my understanding, it means the following:
* /v1/containers represent collections of resources
* /v1/containers/<ID or NAME> represent individual members of that collection
However, the URL /v1/containers/run might be interpreted as an individual member
with name "run". This is not an effective URL design. According to the guide, it
suggested to change it as following
POST /v1/containers?
Closes-Bug: #1650820
Change-Id: I058a947afd4d46