1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
Commit Graph

28 Commits

Author SHA1 Message Date
Thomas Heartman
fc6ea25ebd docs: add more endpoint data 2022-04-01 15:47:00 +02:00
Thomas Heartman
3440b4f42a docs: add segments api placeholder 2022-04-01 15:47:00 +02:00
Thomas Heartman
c15cbfc6d3
Merge pull request #1319 from Unleash/docs/describe-project-users-endpoints
docs: describe `/api/admin/projects/:projectId/users/:userId/roles/:roleId` endpoint
2022-03-04 12:10:11 +01:00
Thomas Heartman
4705fe22cc docs: remove error payload that no longer applies. 2022-03-04 10:41:52 +01:00
Thomas Heartman
6d433c50ab docs: add info about requiring name OR email 2022-03-04 10:36:40 +01:00
Thomas Heartman
c9dd60e1ea
Apply suggestions from code review
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
2022-03-04 08:43:28 +01:00
Thomas Heartman
4c4f6a3aaa docs: update description of sendEmail option 2022-03-03 15:24:15 +01:00
Thomas Heartman
38ed3816a8 docs: Remove doubled section and clarify role removal 2022-03-03 14:17:43 +01:00
Thomas Heartman
9da796eb90 docs: add details for change role endpoint. 2022-03-03 09:25:22 +01:00
Thomas Heartman
e84b8f30e1 docs: add correct return values for role deletion endpoints. 2022-03-03 09:25:22 +01:00
Thomas Heartman
92349b5561 Apply suggestions from code review
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
2022-03-03 09:25:22 +01:00
Thomas Heartman
81c6ef2d6e chore: align url parameters table. 2022-03-03 09:25:22 +01:00
Thomas Heartman
01f7293e2e docs: add description of the project users/roles endpoint 2022-03-03 09:25:20 +01:00
Thomas Heartman
f92d86061a docs(chore): improve syntax highlighting and formatting of code bits
Use `bash` instead of `sh` for nicer highlighting by prism.

I've also broken large json blobs over multiple lines.
2022-03-03 09:24:43 +01:00
Thomas Heartman
5a220caf39 docs: Add payload properties for user-admin post payload
Adds an explanation of what the various properties in the payload
object to the `user-admin` endpoint does. Most seem fairly
self-explanatory, but I'm not entirely sure what `sendEmail` does.

Requires validation by a third party before merging.
2022-02-09 09:05:24 +01:00
Ivar Conradi Østhus
609422071f
docs: add "sendEmail" field to user-admin.md (#1329) 2022-02-08 20:47:01 +01:00
Christopher Kolstad
b0edddb283
fix: typo (#1346) 2022-02-08 14:57:52 +01:00
Fredrik Strand Oseberg
acb98db00f
docs: add docs for impression data (#1328)
* docs: add docs for impression data

* fix: update wording

* Update website/docs/advanced/impression_data.md

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>

* Update website/docs/advanced/impression_data.md

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>

* docs: use hyphen instead of underscore in file name and title/slug

We've been very inconsistent with our use of separators previously
(we should try and find a standard). Hyphens are most common online,
so I've switched to that instead.

* docs: use syntax highlighting for shell commands

* docs: start outlining impression data restructure.

* docs: Add impression data info to API: create toggles

* docs: Add impression data row to compatibility matrix

* docs: restructures the impression data reference doc.

* chore: remove question callout in source material

* docs: add redirect for `impression_data` -> 'impression-data'

* docs: Add sdk availability to availability note

* chore: Fix broken doc paths.

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-02-08 12:11:08 +01:00
Ivar Conradi Østhus
2bc7b951b2
doc: Fix delete call for deleting feature toggles
Fixes: #1330
2022-02-04 12:56:58 +01:00
Ivar Conradi Østhus
642a2371ef fix: updated API docs to reflect v4.3 2021-12-06 15:31:50 +01:00
Thomas Heartman
e8478126a5
Merge branch 'master' into docs/add-stickiness 2021-11-24 13:59:56 +01:00
Thomas Heartman
d58ed5f84b
Apply suggestions from code review
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
2021-11-24 13:39:02 +01:00
Christopher Kolstad
6c6001619c
Feat/variant api (#1119)
Add a new .../:feature/variants API

This adds
- `GET /api/admin/projects/:projectId/features/:featureName/variants` which returns 
```json
{ version: '1', variants: IVariant[] }
```
- `PATCH /api/admin/projects/:projectId/features/:featureName/variants` which accepts a json patch set and updates the feature's variants field and then returns 
```json
{ version: '1', variants: IVariant[] }
```
- `PUT /api/admin/projects/:projectId/features/:featureName/variants`
 which accepts a IVariant[] and overwrites the current variants list for the feature defined in :featureName and returns
```json
{ version: '1', variants: IVariant[] }

- This also makes sure the total weight of all variants is == 1000
- Validates that there is at least 1 'variable' variant if there are variants
- Validates that 'fix' variants total weight can't exceed 1000
- Adds tests for all these invariants.


Co-authored-by: Simon Hornby <simon@getunleash.ai>
2021-11-24 13:08:04 +01:00
Thomas Heartman
9c0848b053 docs: fix links to old versions of pages; link to new versions. 2021-11-24 12:03:31 +01:00
jonkjenn
e4e8d12ca7
Docs: Update feature-toggles-api.md (#1105)
Co-authored-by: Ivar Conradi Østhus <ivarconr@gmail.com>
2021-11-15 22:36:25 +01:00
Ivar Conradi Østhus
d8478dd928
feat: clean up events (#1089)
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
2021-11-12 13:15:51 +01:00
Ivar Conradi Østhus
d0b2ce3170
fix: add enpoint for fetching a single user (#1074)
* fix: add enpoint for fetching a single user

* fix add api docs
2021-10-28 14:24:09 +02:00
Ivar Conradi Østhus
ffec4f6342 fix: rename websitev2 to website 2021-10-26 11:25:19 +02:00