Skip to content

Improve explanation of on-call participants creation

Sarah Yasonik requested to merge sy-graphql-docs-edit-for-participants into master

What does this MR do?

Addresses a minor fix for #323875 (comment 525195923).

The color corresponding to a participant's shifts in an on-call schedule is saved with the participant and can be set via the API. The frontend sets these values when saving a new on-call schedule.

The expected colors for the frontend are https://design.gitlab.com/data-visualization/color/#categorical-data, but the backend accepts more weights than the frontend can render. If an improper weight is used in the API, it will show up as white in the UI.

This is an edge case for sure, so we're limiting the solution to documenting the caveat for the graphql endpoint for the time being, as this really isn't a priority. The feature is still behind a feature flag.

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • 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

Merge request reports

Loading