Skip to content

Commit

Permalink
Add parameter documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cmanallen committed Jun 12, 2024
1 parent 9714e59 commit 5f2343b
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions src/sentry/remote_config/docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,15 @@ Fetch a project's configuration. Responses should be proxied exactly to the SDK.

## Configurations [/projects/<organization_id_or_slug>/<project_id_or_slug>/configurations/]

**Parameters**

- offset (optional, number)
Default: 0
- per_page (optional, number)
Default: 10

**Attributes**

| Field | Type | Description |
| ------------------ | ---------------- | ----------------------------------------------------------------------------- |
| environment | optional[string] | The environment the configuration is associated with. |
Expand Down Expand Up @@ -171,6 +180,23 @@ Delete a configuration.

## Features [/projects/<organization_id_or_slug>/<project_id_or_slug>/configuration/<configuration_id>/features/]

**Parameters**

- offset (optional, number)
Default: 0
- per_page (optional, number)
Default: 10

**Attributes**

| Field | Type | Description |
| ----------- | ------ | ----------------------------------------------------- |
| description | string | The environment the configuration is associated with. |
| id | string | A server generated unique identifier. |
| is_enabled | bool | Disabled features are not visible to clients. |
| key | string | A unique, per-config feature identifier. |
| value | any | The value associated to the key. |

### Get Features [GET]

Retrieve configuration features.
Expand Down

0 comments on commit 5f2343b

Please sign in to comment.