The API docs appear incomplete

Bug #1704113 reported by Brad P. Crochet
12
This bug affects 2 people
Affects Status Importance Assigned to Milestone
Mistral
Triaged
High
Unassigned

Bug Description

The docs seem to be missing parts of the API. It shows the GETs, but there is no detail about what can be POSTed, and what needs to be passed.

See: https://docs.openstack.org/mistral/latest/api/v2.html#action-executions
and
https://docs.openstack.org/mistral/latest/api/v2.html#executions

Tags: docs
Ryan Brady (rbrady)
tags: added: docs
Revision history for this message
Nirav Khandhedia (khandhedia) wrote :

Hi,

It would be a great help if documentation provides the following information:

ReST URI
JSON Request Template
JSON Request Sample
JSON Response Template
JSON Response Sample
Response codes and meanings thereof
Headers/Authentication information if need be

Reference documentation:
https://developer.openstack.org/api-ref/compute/

Thank you very much!

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on mistral (master)

Change abandoned by Brad P. Crochet (<email address hidden>) on branch: master
Review: https://review.openstack.org/483320

Dougal Matthews (d0ugal)
Changed in mistral:
status: New → Triaged
importance: Undecided → High
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.