Fix incorrect attribute documentation in Deployments API
Problem
The status
attribute is listed as not required for one of the resources in Deployments API documentation.
However, when trying to create deployment by sending a request to the resource without passing this attribute, we receive the following error:
{"error":"status is missing, status does not have a valid value"}
This seems to be a documentation error, as the implementation clearly shows status
is required.
Additionally, the description for that same attribute have created
documented as one of the values you could use to filter deployments, but the implementation does not. This can be confirmed by passing status=created
in the request, which results in the following error:
{"error":"status does not have a valid value"}
Proposal
Fix the documentation to ensure:
-
status
is listed as required for this API resource. -
created
is removed from the list of allowed values in the attribute description.
Edited by Ahmed Hemdan