docs: fix milestones date fields in API responses (!69614) · Merge requests · GitLab.org / GitLab

Jaime Martinez requested to merge release-cli-121-update-milestone-sample into master Sep 06, 2021

What does this MR do?

The Releases API sample responses show the fields start_date and due_date of milestones as dates with timestamps. However, those fields are only used as raw dates. This causes some clients to break when trying to read the API response, for example release-cli#121 (closed).

This MR updates the examples to only show dates and not dates with timestamps.

FTR the milestones APIs (project and group milestones) show those fields as dates correctly.

Screenshots or Screencasts (strongly suggested)

How to setup and validate locally (strongly suggested)

Create a release with an existing milestone attached to it.
Get the release using the API
Verify the milestone fields start_date and due_date are only dates without timestamps.

$ curl -s --header "PRIVATE-TOKEN: $GITLAB_PRIVATE_TOKKEN" "https://gitlab.com/api/v4/projects/18239424/releases/v1.34.0-rc3" | jq .milestones

[
  {
    "id": 2208710,
    "iid": 5,
    "project_id": 18239424,
    "title": "m34",
    "description": "testing milestone dates",
    "state": "active",
    "created_at": "2021-08-30T23:59:36.764Z",
    "updated_at": "2021-08-30T23:59:36.764Z",
    "due_date": "2021-09-06",
    "start_date": "2021-08-24",
    "expired": false,
    "web_url": "https://gitlab.com/jaime/hello/-/milestones/5",
    "issue_stats": {
      "total": 0,
      "closed": 0
    }
  }
]

Does this MR meet the acceptance criteria?

Conformity

I have included changelog trailers, or none are needed. (Does this MR need a changelog?)
I have added/updated documentation, or it's not needed. (Is documentation required?)
I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?)
I have added information for database reviewers in the MR description, or it's not needed. (Does this MR have database related changes?)
I have self-reviewed this MR per code review guidelines.
This MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines)
I have followed the style guides.
This change is backwards compatible across updates, or this does not apply.

Availability and Testing

I have added/updated tests following the Testing Guide, or it's not needed. (Consider all test levels. See the Test Planning Process.)
I have tested this MR in all supported browsers, or it's not needed.
I have informed the Infrastructure department of a default or new setting change per definition of done, or it's not needed.

Security

Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.

Label as security and @ mention @gitlab-com/gl-security/appsec
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
Security reports checked/validated by a reviewer from the AppSec team

docs: fix milestones date fields in API responses