Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

API v1 Fetch Information About A Specific Feature

Darren Oakley edited this page Oct 18, 2021 · 1 revision

PLEASE NOTE: This API interface is now deprecated and will be removed at some point in the future.


GET /v1/groups/{group_name}/features/{feature_name}

http://bandiera.example.com/api/v1/groups/{group_name}/features/{feature_name}

This endpoint returns the deatils of a given feature. Please note the special use case of this endpoint detailed after the initial examples.

Example Request:

curl 'http://bandiera.example.com/api/v1/groups/pubserv/features/show-article-metrics'

Example Response:

{
    "feature": {
        "description": "Show article level metrics?",
        "enabled": true,
        "group": "pubserv",
        "name": "show-article-metrics"
    }
}

When a Group or Feature Does Not Exist...

Unlike all the other Bandiera API endpoints, this endpoint will NEVER return a not found (404) response. If you request information for groups or features that do not exist, Bandiera will return a default feature object that is disabled along with a warning.

This is an example response for a group that does not exist:

{
    "feature": {
        "description": null,
        "enabled": false,
        "group": "i-do-not-exist",
        "name": "my-new-feature"
    },
    "warning": "This group does not exist in the bandiera database."
}

This is an example response for a feature that does not exist:

{
    "feature": {
        "description": null,
        "enabled": false,
        "group": "pubserv",
        "name": "my-new-feature"
    },
    "warning": "This feature does not exist in the bandiera database."
}