Add flags autocomplete blueprint

getsentry · Jan 22, 2025 · ebcc1f3 · ebcc1f3
1 parent cdaa79c
commit ebcc1f3
Showing 1 changed file with 100 additions and 0 deletions.
diff --git a/src/sentry/flags/docs/api.md b/src/sentry/flags/docs/api.md
@@ -205,3 +205,103 @@ Any request content-type is acceptable (JSON, XML, binary-formats) so long as th
 - Request
 
 - Response 201
+
+## Flag Keys [/organizations/<organization_id_or_slug>/flags/keys/]
+
+- Parameters
+  - end (optional, string) - ISO 8601 format. Required if `start` is set.
+  - project (number) - The project to search.
+  - sort (string) - A field to sort by. Optionally prepended with a hyphen to indicate descending order.
+  - start (optional, string) - ISO 8601 format (`YYYY-MM-DDTHH:mm:ss.sssZ`)
+  - statsPeriod (optional, string) - A positive integer suffixed with a unit type.
+  - useCache (number) - Boolean number which determines if we should use the cache or not. 0 for false; 1 for true.
+  - cursor (optional, string)
+  - per_page (optional, number)
+    Default: 10
+  - offset (optional, number)
+    Default: 0
+
+**Attributes**
+
+| Column      | Type   | Description |
+| ----------- | ------ | ----------- |
+| key         | string |             |
+| name        | string |             |
+| totalValues | number |             |
+
+### Browse Flag Keys [GET]
+
+Retrieve a collection of flag keys.
+
+- Response 200
+
+  ```json
+  [
+    {
+      "key": "sdk_name",
+      "name": "Sdk Name",
+      "totalValues": 2444
+    }
+  ]
+  ```
+
+## Flag Key [/organizations/<organization_id_or_slug>/flags/keys/<key>/]
+
+### Fetch Flag Key [GET]
+
+Fetch a flag key.
+
+- Response 200
+
+  ```json
+  {
+    "key": "sdk_name",
+    "name": "Sdk Name",
+    "totalValues": 2444
+  }
+  ```
+
+## Flag Values [/organizations/<organization_id_or_slug>/flags/keys/<key>/values/]
+
+- Parameters
+  - end (optional, string) - ISO 8601 format. Required if `start` is set.
+  - project (number) - The project to search.
+  - sort (string) - A field to sort by. Optionally prepended with a hyphen to indicate descending order.
+  - start (optional, string) - ISO 8601 format (`YYYY-MM-DDTHH:mm:ss.sssZ`)
+  - statsPeriod (optional, string) - A positive integer suffixed with a unit type.
+  - useCache (number) - Boolean number which determines if we should use the cache or not. 0 for false; 1 for true.
+  - cursor (optional, string)
+  - per_page (optional, number)
+    Default: 10
+  - offset (optional, number)
+    Default: 0
+
+**Attributes**
+
+| Column    | Type   | Description |
+| --------- | ------ | ----------- |
+| key       | string |             |
+| name      | string |             |
+| value     | string |             |
+| count     | number |             |
+| lastSeen  | string |             |
+| firstSeen | string |             |
+
+### Browse Flag Values [GET]
+
+Retrieve a collection of flag values.
+
+- Response 200
+
+  ```json
+  [
+    {
+      "key": "isCustomerDomain",
+      "name": "yes",
+      "value": "yes",
+      "count": 15525,
+      "lastSeen": "2025-01-22T15:59:13Z",
+      "firstSeen": "2025-01-21T15:59:02Z"
+    }
+  ]
+  ```