Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 79 additions & 3 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -187,8 +187,79 @@
"pages": [
"v2/reference/overview"
]
},
{
"group": "Authentication",
"pages": [
"v2/reference/authentication/list-tokens",
"v2/reference/authentication/get-token",
"v2/reference/authentication/get-self",
"v2/reference/authentication/revoke-self"
]
},
{
"group": "Environments",
"pages": [
"v2/reference/environments/list-environments"
]
},
{
"group": "Branches",
"pages": [
"v2/reference/branches/list-branches",
"v2/reference/branches/create-branch",
"v2/reference/branches/list-changes",
"v2/reference/branches/propose-branch",
"v2/reference/branches/delete-branch"
]
},
{
"group": "Namespaces",
"pages": [
"v2/reference/namespaces/list-namespaces",
"v2/reference/namespaces/create-namespace",
"v2/reference/namespaces/get-namespace",
"v2/reference/namespaces/update-namespace",
"v2/reference/namespaces/delete-namespace"
]
},
{
"group": "Flags",
"pages": [
"v2/reference/flags/list-flags",
"v2/reference/flags/create-flag",
"v2/reference/flags/get-flag",
"v2/reference/flags/update-flag",
"v2/reference/flags/delete-flag"
]
},
{
"group": "Segments",
"pages": [
"v2/reference/segments/list-segments",
"v2/reference/segments/create-segment",
"v2/reference/segments/get-segment",
"v2/reference/segments/update-segment",
"v2/reference/segments/delete-segment"
]
},
{
"group": "Evaluation",
"pages": [
"v2/reference/evaluation/snapshot",
"v2/reference/evaluation/stream",
"v2/reference/evaluation/boolean-evaluation",
"v2/reference/evaluation/variant-evaluation",
"v2/reference/evaluation/batch-evaluation"
]
},
{
"group": "OpenFeature Evaluation [OFREP]",
"pages": [
"v2/reference/openfeature/flag-evaluation",
"v2/reference/openfeature/bulk-evaluation"
]
}

]
},
{
Expand Down Expand Up @@ -539,12 +610,17 @@
"dismissible": true
},
"api": {
"openapi": "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml",
"openapi": [
"https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml",
"https://raw.githubusercontent.com/flipt-io/flipt/refs/heads/v2/rpc/flipt/openapi.yaml",
"https://raw.githubusercontent.com/flipt-io/flipt/refs/heads/v2/rpc/v2/environments/openapi.yaml",
"https://raw.githubusercontent.com/flipt-io/flipt/refs/heads/v2/rpc/v2/evaluation/openapi.yaml"
],
"playground": {
"display": "simple"
},
"mdx": {
"server": "https://try.flipt.io",
"server": "http://localhost:8080",
"auth": {
"method": "bearer"
}
Expand Down
4 changes: 2 additions & 2 deletions docs/v1/reference/authentication/create-token.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Create Token"
openapi: POST /auth/v1/method/token
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml POST /auth/v1/method/token"
---

<RequestExample>

```bash cURL
curl --request POST \
--url https://try.flipt.io/auth/v1/method/token \
--url http://localhost:8080/auth/v1/method/token \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
Expand Down
4 changes: 2 additions & 2 deletions docs/v1/reference/authentication/delete-token.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Delete Token"
openapi: DELETE /auth/v1/tokens/{id}
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml DELETE /auth/v1/tokens/{id}"
---

<RequestExample>

```bash cURL
curl --request DELETE \
--url https://try.flipt.io/auth/v1/tokens/{id} \
--url http://localhost:8080/auth/v1/tokens/{id} \
--header 'Authorization: Bearer {token}'
```

Expand Down
4 changes: 2 additions & 2 deletions docs/v1/reference/authentication/expire-self.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Expire Self"
openapi: PUT /auth/v1/self/expire
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml PUT /auth/v1/self/expire"
---

<RequestExample>

```bash cURL
curl --request PUT \
--url https://try.flipt.io/auth/v1/self/expire \
--url http://localhost:8080/auth/v1/self/expire \
--header 'Authorization: Bearer <token>'
```

Expand Down
4 changes: 2 additions & 2 deletions docs/v1/reference/authentication/get-self.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Get Self"
openapi: GET /auth/v1/self
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml GET /auth/v1/self"
---

<RequestExample>

```bash cURL
curl --request GET \
--url https://try.flipt.io/auth/v1/self \
--url http://localhost:8080/auth/v1/self \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'
```
Expand Down
4 changes: 2 additions & 2 deletions docs/v1/reference/authentication/get-token.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "Get Token"
openapi: GET /auth/v1/tokens/{id}
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml GET /auth/v1/tokens/{id}"
---

<RequestExample>

```bash cURL
curl --url https://try.flipt.io/auth/v1/tokens/{id} \
curl --url http://localhost:8080/auth/v1/tokens/{id} \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {token}'
```
Expand Down
4 changes: 2 additions & 2 deletions docs/v1/reference/authentication/list-tokens.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "List Tokens"
openapi: GET /auth/v1/tokens
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml GET /auth/v1/tokens"
---

<RequestExample>

```bash cURL
curl --url https://try.flipt.io/auth/v1/tokens \
curl --url http://localhost:8080/auth/v1/tokens \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {token}'
```
Expand Down
4 changes: 2 additions & 2 deletions docs/v1/reference/constraints/create-constraint.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Create Constraint"
openapi: "POST /api/v1/namespaces/{namespaceKey}/segments/{segmentKey}/constraints"
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml POST /api/v1/namespaces/{namespaceKey}/segments/{segmentKey}/constraints"
---

<RequestExample>

```bash cURL
curl --request POST \
--url https://try.flipt.io/api/v1/namespaces/default/segments/{segmentKey}/constraints \
--url http://localhost:8080/api/v1/namespaces/default/segments/{segmentKey}/constraints \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
Expand Down
4 changes: 2 additions & 2 deletions docs/v1/reference/constraints/delete-constraint.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Delete Constraint"
openapi: "DELETE /api/v1/namespaces/{namespaceKey}/segments/{segmentKey}/constraints/{id}"
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml DELETE /api/v1/namespaces/{namespaceKey}/segments/{segmentKey}/constraints/{id}"
---

<RequestExample>

```bash cURL
curl --request DELETE \
--url https://try.flipt.io/api/v1/namespaces/default/segments/{segmentKey}/constraints/{id}
--url http://localhost:8080/api/v1/namespaces/default/segments/{segmentKey}/constraints/{id}
```

</RequestExample>
4 changes: 2 additions & 2 deletions docs/v1/reference/constraints/update-constraint.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Update Constraint"
openapi: "PUT /api/v1/namespaces/{namespaceKey}/segments/{segmentKey}/constraints/{id}"
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml PUT /api/v1/namespaces/{namespaceKey}/segments/{segmentKey}/constraints/{id}"
---

<RequestExample>

```bash cURL
curl --request PUT \
--url https://try.flipt.io/api/v1/namespaces/default/segments/{segmentKey}/constraints/{id} \
--url http://localhost:8080/api/v1/namespaces/default/segments/{segmentKey}/constraints/{id} \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
Expand Down
4 changes: 2 additions & 2 deletions docs/v1/reference/distributions/create-distribution.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Create Distribution"
openapi: "POST /api/v1/namespaces/{namespaceKey}/flags/{flagKey}/rules/{ruleId}/distributions"
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml POST /api/v1/namespaces/{namespaceKey}/flags/{flagKey}/rules/{ruleId}/distributions"
---

<RequestExample>

```bash cURL
curl --request POST \
--url https://try.flipt.io/api/v1/namespaces/default/flags/{flagKey}/rules/{ruleId}/distributions \
--url http://localhost:8080/api/v1/namespaces/default/flags/{flagKey}/rules/{ruleId}/distributions \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
Expand Down
4 changes: 2 additions & 2 deletions docs/v1/reference/distributions/delete-distribution.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Delete Distribution"
openapi: "DELETE /api/v1/namespaces/{namespaceKey}/flags/{flagKey}/rules/{ruleId}/distributions/{id}"
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml DELETE /api/v1/namespaces/{namespaceKey}/flags/{flagKey}/rules/{ruleId}/distributions/{id}"
---

<RequestExample>

```bash cURL
curl --request DELETE \
--url https://try.flipt.io/api/v1/namespaces/default/flags/{flagKey}/rules/{ruleId}/distributions/{id}
--url http://localhost:8080/api/v1/namespaces/default/flags/{flagKey}/rules/{ruleId}/distributions/{id}
```

</RequestExample>
4 changes: 2 additions & 2 deletions docs/v1/reference/distributions/update-distribution.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Update Distribution"
openapi: "PUT /api/v1/namespaces/{namespaceKey}/flags/{flagKey}/rules/{ruleId}/distributions/{id}"
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml PUT /api/v1/namespaces/{namespaceKey}/flags/{flagKey}/rules/{ruleId}/distributions/{id}"
---

<RequestExample>

```bash cURL
curl --request PUT \
--url https://try.flipt.io/api/v1/namespaces/default/flags/{flagKey}/rules/{ruleId}/distributions/{id} \
--url http://localhost:8080/api/v1/namespaces/default/flags/{flagKey}/rules/{ruleId}/distributions/{id} \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
Expand Down
4 changes: 2 additions & 2 deletions docs/v1/reference/evaluation/batch-evaluation.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Batch Evaluation"
openapi: "POST /evaluate/v1/batch"
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml POST /evaluate/v1/batch"
---

<RequestExample>

```bash cURL
curl --request POST \
--url https://try.flipt.io/evaluate/v1/batch \
--url http://localhost:8080/evaluate/v1/batch \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
Expand Down
4 changes: 2 additions & 2 deletions docs/v1/reference/evaluation/boolean-evaluation.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Boolean Evaluation"
openapi: "POST /evaluate/v1/boolean"
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml POST /evaluate/v1/boolean"
---

<RequestExample>

```bash cURL
curl --request POST \
--url https://try.flipt.io/evaluate/v1/boolean \
--url http://localhost:8080/evaluate/v1/boolean \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
Expand Down
4 changes: 2 additions & 2 deletions docs/v1/reference/evaluation/variant-evaluation.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Variant Evaluation"
openapi: "POST /evaluate/v1/variant"
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml POST /evaluate/v1/variant"
---

<RequestExample>

```bash cURL
curl --request POST \
--url https://try.flipt.io/evaluate/v1/variant \
--url http://localhost:8080/evaluate/v1/variant \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
Expand Down
4 changes: 2 additions & 2 deletions docs/v1/reference/flags/create-flag.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Create Flag"
openapi: "POST /api/v1/namespaces/{namespaceKey}/flags"
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml POST /api/v1/namespaces/{namespaceKey}/flags"
---

<RequestExample>

```bash cURL
curl --request POST \
--url https://try.flipt.io/api/v1/namespaces/default/flags \
--url http://localhost:8080/api/v1/namespaces/default/flags \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
Expand Down
4 changes: 2 additions & 2 deletions docs/v1/reference/flags/delete-flag.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Delete Flag"
openapi: "DELETE /api/v1/namespaces/{namespaceKey}/flags/{key}"
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml DELETE /api/v1/namespaces/{namespaceKey}/flags/{key}"
---

<RequestExample>

```bash cURL
curl --request DELETE \
--url https://try.flipt.io/api/v1/namespaces/default/flags/{key}
--url http://localhost:8080/api/v1/namespaces/default/flags/{key}
```

</RequestExample>
4 changes: 2 additions & 2 deletions docs/v1/reference/flags/get-flag.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "Get Flag"
openapi: "GET /api/v1/namespaces/{namespaceKey}/flags/{key}"
openapi: "https://raw.githubusercontent.com/flipt-io/flipt/main/openapi.yaml GET /api/v1/namespaces/{namespaceKey}/flags/{key}"
---

<RequestExample>

```bash cURL
curl --url https://try.flipt.io/api/v1/namespaces/default/flags/{key} \
curl --url http://localhost:8080/api/v1/namespaces/default/flags/{key} \
--header 'Accept: application/json'
```

Expand Down
Loading
Loading