From 3440b4f42a0edbd523e42f5c0457970d23775f2c Mon Sep 17 00:00:00 2001 From: Thomas Heartman Date: Wed, 30 Mar 2022 16:01:07 +0200 Subject: [PATCH] docs: add segments api placeholder --- website/docs/api/admin/segments.mdx | 20 ++++++++++++++++++++ website/sidebars.js | 1 + 2 files changed, 21 insertions(+) create mode 100644 website/docs/api/admin/segments.mdx diff --git a/website/docs/api/admin/segments.mdx b/website/docs/api/admin/segments.mdx new file mode 100644 index 0000000000..6ef8883ab6 --- /dev/null +++ b/website/docs/api/admin/segments.mdx @@ -0,0 +1,20 @@ +--- +title: /api/admin/segments +--- +export const basePath = "/api/admin/segments" + +### Get all segments: `GET /{{{basePath}}}` + +### Create segment: `POST /` + +### Get segment by id: `GET /:id` + +### Update segment by id: `PUT /:id` + +### Delete segment by id: `DELETE /:id` + +### List strategies that use a specific segment: `GET /:id/strategies` + +### List segments applied to a specific strategy: `GET /strategies/:strategyId` + +### Replace activation strategy segments `POST /strategies/:strategyId` diff --git a/website/sidebars.js b/website/sidebars.js index d99dfd3b03..1a0b97275c 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -141,6 +141,7 @@ module.exports = { 'api/admin/features-archive', 'api/admin/metrics', 'api/admin/projects', + 'api/admin/segments', 'api/admin/state', 'api/admin/strategies', 'api/admin/user-admin',