Skip to content

Commit

Permalink
chore: Update authentication.mdx
Browse files Browse the repository at this point in the history
  • Loading branch information
markphelps authored Feb 5, 2024
1 parent 2334aca commit ade8bd9
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions configuration/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,15 @@ See the [Authentication: Overview](/authentication/overview) documentation for m
## Exclusions

Exclusions allow you to disable authentication for sections of the API.
The Flipt API is made of up of top-level API sections, each with its own unique prefix:
The Flipt API is made up of several top-level API sections, each with its own unique prefix.

Check failure on line 27 in configuration/authentication.mdx

View workflow job for this annotation

GitHub Actions / lint

Delete `·`

For example:

- `/api/v1` is the core feature flag state management section
- `/meta` describes the configuration of the running Flipt instance
- `/evaluate/v1` is the application facing flag state evaluation API

Each of these API sections can be optionally omitted from requiring authentication.
A common use case is to allow the evaluation API to be publicly accessible while still requiring authenticated users for managing feature-flag configuration and state.
Several of these API sections can be optionally omitted from requiring authentication.
A common use case is to allow the evaluation API to be publicly accessible while still requiring authenticated users to manage feature-flag configuration and state.

Check warning on line 35 in configuration/authentication.mdx

View workflow job for this annotation

GitHub Actions / Vale

[vale] reported by reviewdog 🐶 [Openly.SentenceLength] Write short sentences (less than 25 words). Raw Output: {"message": "[Openly.SentenceLength] Write short sentences (less than 25 words).", "location": {"path": "configuration/authentication.mdx", "range": {"start": {"line": 35, "column": 1}}}, "severity": "WARNING"}

By default, when authentication is configured as `required: true`, the effective configuration for the exclusions looks like this:

Expand All @@ -40,7 +41,6 @@ authentication:
required: true
exclude:
management: false
metadata: false
evaluation: false
```

Expand Down

0 comments on commit ade8bd9

Please sign in to comment.