What switching a feature would do

GET

/api/v1/features/{id}/impact

curl --request GET \
  --url 'http://localhost:3000/api/v1/features/example/impact?context=organization&state=on' \
  --header 'Authorization: Bearer <token>'

A dry run of PUT /api/v1/features/{id}: the projects it would turn on or off and, for what reaches outside the admin’s view (API keys in use, share links, portals and sites, public BrandHub listings, counting that can’t be made up later, the server’s own warning), what will happen, counted. Nothing changes. Admin there.

Any caller; the scope needed is checked on what it acts on.

Authorizations

• bearer
• session
• None

Parameters

Path Parameters

id

required

string

E.g. portals

Query Parameters

context

string

default: organization

Allowed values: organization project

Where

state

string

Allowed values: on off projects

The change to weigh (required)

Responses

200

What it would do

Media typeapplication/json

object

data

required

object

changes

required

How many projects it turns on or off

integer

>= -9007199254740991 <= 9007199254740991

confirm

required

Whether to ask before doing it: what it does reaches outside, or overrides projects’ own choice

boolean

title

required

The question to ask, e.g. Turn off Portals and sites?

string

says

required

What will happen, a sentence each: the projects it changes, and what reaches outside, counted

Array<string>

action

required

The confirming button’s label

string

Example^generated

{
  "data": {
    "changes": 1,
    "confirm": true,
    "title": "example",
    "says": [
      "example"
    ],
    "action": "example"
  }
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}