Skip to content
Snippets Groups Projects

Add API for reordering child epics

Merged Heinrich Lee Yu requested to merge 7328-reorder-epics-api into master
All threads resolved!

What does this MR do?

Add API for reordering child epics

Also makes the listing API return an ordered list of child epics

What are the relevant issue numbers?

Closes #7328 (closed)

Does this MR meet the acceptance criteria?

Edited by Heinrich Lee Yu

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Heinrich Lee Yu
  • Heinrich Lee Yu
  • Author Maintainer

    @mikelewis Can you review the docs changes here? Thanks

  • Author Maintainer

    @jarka Can you take a look? This is a follow-up MR to add an API for reordering. Thanks

  • assigned to @jarka

  • 1 Warning
    :warning: This merge request is missing the ~Documentation label.
    1 Message
    :book: This merge request adds or changes files that require a review from the Technical Writing team whether before or after merging.

    Documentation review

    The following files will require a review from the Technical Writing team:

    • doc/api/epic_links.md

    Per the documentation workflows, the review may occur prior to merging this MR or after a maintainer has agreed to review and merge this MR without a tech writer review. (Meanwhile, you are welcome to involve a technical writer at any time if you have questions about writing or updating the documentation. GitLabbers are also welcome to use the #docs channel on Slack.)

    The technical writer who, by default, will review this content or collaborate as needed is dependent on the DevOps stage to which the content applies:

    Tech writer Stage(s)
    @marcia ~Create ~Release + development guidelines
    @axil ~Distribution ~Gitaly ~Gitter ~Monitor ~Package ~Secure
    @eread ~Manage ~Configure ~Geo ~Verify
    @mikelewis ~Plan

    To request a review prior to merging

    • Assign the MR to the applicable technical writer, above. If you are not sure which category the change falls within, or the change is not part of one of these categories, mention one of the usernames above.

    To request a review to commence after merging

    Reviewer roulette

    Changes that require review have been detected! A merge request is normally reviewed by both a reviewer and a maintainer in its primary category (e.g. frontend or backend), and by a maintainer in all other categories.

    To spread load more evenly across eligible reviewers, Danger has randomly picked a candidate for each review slot. Feel free to override this selection if you think someone else would be better-suited, or the chosen person is unavailable.

    Once you've decided who will review this merge request, mention them as you normally would! Danger does not (yet?) automatically notify them for you.

    Category Reviewer Maintainer
    ~Documentation Mike Lewis (@mikelewis)
    backend Bob Van Landuyt (@reprazent) Rémy Coutable (@rymai)

    Generated by :no_entry_sign: Danger

    Edited by 🤖 GitLab Bot 🤖
  • Heinrich Lee Yu added 8 commits

    added 8 commits

    Compare with previous version

  • Thanks @engwan , looks good

  • assigned to @engwan

  • Author Maintainer

    @dbalexandre can you review / merge? Thanks

    Edited by Heinrich Lee Yu
  • @engwan Please note Douglas is OOO.

  • Author Maintainer

    Yeah, I just noticed too when I checked his Slack profile. GitLab status wasn't updated.

    Thanks @mkozono.

    @godfat Can you review / merge this? Thanks

  • assigned to @godfat

  • Lin Jen-Shin
  • @engwan Thanks! Just one typo. The way move_before_id and move_after_id work surprised me a lot. I thought it's moving the child before that, not put that before the child. But surely what's done is done, not relevant here.

  • assigned to @engwan

  • I'll apply and squash merge later if you're ok with that. I am moving out, will get back later.

  • added 1 commit

    • 0bc9af09 - Apply suggestion to doc/api/epic_links.md

    Compare with previous version

  • Author Maintainer

    Thanks @godfat. Applied the code suggestion.

    The way move_before_id and move_after_id work surprised me a lot. I thought it's moving the child before that, not put that before the child. But surely what's done is done, not relevant here.

    That confused me at first too. It's hard to change the param names now because we also want it to be consistent with the API for ordering of Issues within Epics.

    I thought of improving the description of the params in the docs to make this clearer. But I'm not sure how.

    move_before_id: The global ID of a sibling epic that should be placed before the child epic. makes it seem like we're moving the move_before_id epic but in reality we're moving the child epic to be after that epic.

    I didn't want to use something like: The child epic will be moved after this child epic, because we'd have before and after on the same line and I thought that would confuse users more.

  • Heinrich Lee Yu added 423 commits

    added 423 commits

    Compare with previous version

  • Lin Jen-Shin approved this merge request

    approved this merge request

  • @engwan Yeah, I think the current description is actually pretty clear. The problem is that the name move_before_id and move_after_id. I think it's probably more clear if they're just before_id and after_id. That "move" is pretty confusing. Anyway, we should certainly be consistent and the decision was already made.

    The errors were coming from master: https://gitlab.com/gitlab-org/gitlab-ee/issues/10211 so I am approving. We might want to wait for master to become green before merging this though.

  • Heinrich Lee Yu added 130 commits

    added 130 commits

    Compare with previous version

  • Author Maintainer

    @godfat Pipeline is now :green_heart:

  • assigned to @godfat

  • @engwan Awesome, thanks!

  • Lin Jen-Shin resolved all discussions

    resolved all discussions

  • merged

  • Lin Jen-Shin mentioned in commit 43bcc1bf

    mentioned in commit 43bcc1bf

  • Please register or sign in to reply
    Loading