Unleash / unleash / 21243272306

86%

master: 91%

Build Type

push

github

Committed by web-flow

Commit Message

feat: add include query param to context api to allow different combinations (#11234)

Lets the context API return:
- all context fields
- only root context fields
- only fields belonging to a queried project
- all "assignable" fields within a project (project-specific + root)

Uses an "include" query parameter to control this. The parameter can
either be "project" or "root", e.g. "GET
api/admin/context?include=project".

Including "project" on the root level, will give all root fields AND all
project-specific fields (for all projects).
Likewise, including "root" on the project level will give the
project-specific fields for that project and all root fields.

Without the includes, the top-level context API only returns root
fields, and the project level API only returns project fields.

Tests to be added in a later PR.

## Root vs global

As [described in the
docs](https://docs.getunleash.io/concepts#the-root-level), Unleash calls
the top level the "root level". The root level includes things like
users, tokens, roles, and **context fields**. As such, I think that the
include keyword should be `root` instead of `global`.

Run Details

1687 of 1900 branches covered (88.79%)

1 of 12 new or added lines in 3 files covered. (8.33%)

2 existing lines in 2 files now uncovered.

14264 of 16559 relevant lines covered (86.14%)

850.85 hits per line