Skip to content

Explain status field correctly in Deployments API

Manuel Grabowski requested to merge mg-deploymentsapistatusfield-20230705 into master

What does this MR do and why?

It seems that the status description was copy&pasted from the list API endpoint over to the create one – filtering for a status doesn't really make sense when creating a new one, and I verified that the endpoint works just like you'd expect: The value provided for status is used for the newly created environment, there's no filtering happening.

Also confirmed here on Slack:

image

This is almost just a Docs MR, but the description is also present in the deployments.rb file. No actual code is changed, though, just a comment.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports