Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update openapi definition for version 0.2.18 #170

Merged
merged 2 commits into from
Jan 15, 2024
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
57 changes: 56 additions & 1 deletion openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.1
info:
title: api
version: 0.2.15
version: 0.2.18
paths:
/evaluate/v1/boolean:
post:
Expand Down Expand Up @@ -523,6 +523,11 @@ paths:
required: false
schema:
type: string
- name: reference
in: query
required: false
schema:
type: string
responses:
'200':
description: ''
Expand Down Expand Up @@ -571,6 +576,11 @@ paths:
required: true
schema:
type: string
- name: reference
in: query
required: false
schema:
type: string
responses:
'200':
description: ''
Expand Down Expand Up @@ -648,6 +658,11 @@ paths:
required: false
schema:
type: string
- name: reference
in: query
required: false
schema:
type: string
responses:
'200':
description: ''
Expand Down Expand Up @@ -686,6 +701,11 @@ paths:
required: true
schema:
type: string
- name: reference
in: query
required: false
schema:
type: string
responses:
'200':
description: ''
Expand Down Expand Up @@ -763,6 +783,11 @@ paths:
required: false
schema:
type: string
- name: reference
in: query
required: false
schema:
type: string
responses:
'200':
description: ''
Expand Down Expand Up @@ -847,6 +872,11 @@ paths:
required: true
schema:
type: string
- name: reference
in: query
required: false
schema:
type: string
responses:
'200':
description: ''
Expand Down Expand Up @@ -940,6 +970,11 @@ paths:
required: false
schema:
type: string
- name: reference
in: query
required: false
schema:
type: string
responses:
'200':
description: ''
Expand Down Expand Up @@ -1024,6 +1059,11 @@ paths:
required: true
schema:
type: string
- name: reference
in: query
required: false
schema:
type: string
responses:
'200':
description: ''
Expand Down Expand Up @@ -1112,6 +1152,11 @@ paths:
required: false
schema:
type: string
- name: reference
in: query
required: false
schema:
type: string
responses:
'200':
description: ''
Expand Down Expand Up @@ -1160,6 +1205,11 @@ paths:
required: true
schema:
type: string
- name: reference
in: query
required: false
schema:
type: string
responses:
'200':
description: ''
Expand Down Expand Up @@ -1322,6 +1372,8 @@ components:
type: object
additionalProperties:
type: string
reference:
type: string
required:
- namespaceKey
- flagKey
Expand Down Expand Up @@ -1439,6 +1491,8 @@ components:
type: array
items:
$ref: '#/components/schemas/EvaluationevaluationRequest'
reference:
type: string
required:
- requests
EvaluationbatchEvaluationResponse:
Expand Down Expand Up @@ -1478,6 +1532,7 @@ components:
- METHOD_TOKEN
- METHOD_OIDC
- METHOD_KUBERNETES
- METHOD_JWT
description: The default is METHOD_NONE
Authauthentication:
type: object
Expand Down
29 changes: 16 additions & 13 deletions reference/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,22 @@ The Flipt REST API can also be used with any language that can make HTTP request

The latest version of the REST API is fully documented using the [OpenAPI v3 specification](https://github.com/flipt-io/flipt-openapi).

## Authentication

<Info>
Flipt authentication is **disabled** (not required) by default.

Head to the [Configuration: Authentication](/configuration#authentication) section to enable it.

</Info>

As of [v1.35.0](https://github.com/flipt-io/flipt/releases/tag/v1.35.0) Flipt now supports two types of authentication for the API:

- **Client Token Authentication** - This method user tokens stored by Flipt to authenticate the request. See the [Using Client Tokens](/authentication/using-tokens) section for more information.
- **JSON Web Token (JWT) Authentication** - This method uses a JWT token, created and signed externally from Flipt to authenticate the request. See the [Using JWT Tokens](/authentication/using-jwt) section for more information.

See the [Authentication](/authentication) documentation for more information on all supported authentication methods.

## SDKs

We're adding new SDKs all the time. To see the current list of official REST SDKs, head to the [REST SDKs](/integration/server/rest) documentation.
Expand Down Expand Up @@ -37,16 +53,3 @@ Version [v1.20.0](https://github.com/flipt-io/flipt/releases/tag/v1.20.0) of Fli
All previous endpoints without the `/namespaces` prefix still work as before (i.e.: `/api/v1/flags`), they simply resolve to using the **default** namespace.

See the [Concepts: Namespaces](/concepts#namespaces) section for more information.

## Authentication

<Info>
Flipt authentication is **disabled** (not required) by default.

Head to the [Configuration: Authentication](/configuration#authentication) section to enable it.

</Info>

Once enabled, the Flipt REST API uses tokens for authentication. The token is passed in the `Authorization` header of the request as a `Bearer` token.

For more information on how to create a token, see the [Authentication](/authentication) documentation.