Skip to content

Add API development guidelines for Verify

Frédéric Caplette requested to merge fc-add-graphql-as-default-to-verify-stage into master

Why is this change being made?

The directive to be graphQL first was removed from the handbook not so long ago due to confusion mostly around third party integration usually prefering REST over graphQL. However, the problem is that we did remove being graphQL first, but we aren't REST first either 😅 So this creates a status Quo that made it harder for engineers in PA to move forward with new feature developments. During our team meeting, we decided we could perhaps make a MR for our group/stage to clarify how we work while the working group around API figures out the direction of the whole engineering department.

Given what I know and have seen for all Verify teams, we tend to develop new user facing features in the API with GraphQL. Therefore, I am proposing adding some guidelines around this at the Verify level. If we disagree or other teams would rather not have this, then we can apply these changes for PA only but I think it could be beneficial for all of us in Verify.

Author Checklist

  • Provided a concise title for this Merge Request (MR)
  • Added a description to this MR explaining the reasons for the proposed change, per say why, not just what
    • Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added.
  • Assign reviewers for this MR to the correct Directly Responsible Individual/s (DRI)
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the Maintained by section on the page being edited
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies
  • If the changes affect team members, or warrant an announcement in another way, please consider posting an update in #whats-happening-at-gitlab linking to this MR
    • If this is a change that directly impacts the majority of global team members, it should be a candidate for #company-fyi. Please work with internal communications and check the handbook for examples.
Edited by Frédéric Caplette

Merge request reports