diff --git a/docs/docs.json b/docs/docs.json index 69e7b7b..ac106be 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -175,6 +175,19 @@ } ] }, + { + "anchor": "API Reference", + "icon": "code", + "groups": [ + { + "group": "Overview", + "pages": [ + "v2/reference/overview" + ] + } + + ] + }, { "anchor": "Blog", "href": "https://blog.flipt.io", diff --git a/docs/v2/licensing.mdx b/docs/v2/licensing.mdx index 5a3f6fe..b82d89a 100644 --- a/docs/v2/licensing.mdx +++ b/docs/v2/licensing.mdx @@ -18,30 +18,30 @@ The **majority of Flipt v2 remains free and open source**, including: ## Feature Comparison: Free vs Pro -| Feature Category | Free | Pro | Notes | -| ----------------------------------- | ---- | --- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Core Functionality** | | | | -| Feature flag evaluation engine | ✅ | ✅ | Full functionality in both | -| Dashboard and UI | ✅ | ✅ | Complete interface | -| Multi-environment support | ✅ | ✅ | Unlimited environments | -| Branch environments | ✅ | ✅ | Git-based branching | -| Git-backed storage and sync | ✅ | ✅ | Full Git integration | -| Authentication mechanisms | ✅ | ✅ | OIDC, token-based | -| Real-time client updates | ✅ | ✅ | Server Sent Events (SSE) support | -| **Advanced Workflows** | | | | -| Enterprise DevOps Integration | ❌ | ✅ | GitHub, GitLab, Bitbucket, Azure DevOps, Gitea | -| Merge proposals with SCM | ❌ | ✅ | Automated PR/MR creation | -| GPG commit signing | ❌ | ✅ | Cryptographic verification | -| **Security & Operations** | | | | +| Feature Category | Free | Pro | Notes | +| ----------------------------------- | ---- | --- | ----------------------------------------------------------------------------------------------------- | +| **Core Functionality** | | | | +| Feature flag evaluation engine | ✅ | ✅ | Full functionality in both | +| Dashboard and UI | ✅ | ✅ | Complete interface | +| Multi-environment support | ✅ | ✅ | Unlimited environments | +| Branch environments | ✅ | ✅ | Git-based branching | +| Git-backed storage and sync | ✅ | ✅ | Full Git integration | +| Authentication mechanisms | ✅ | ✅ | OIDC, token-based | +| Real-time client updates | ✅ | ✅ | Server Sent Events (SSE) support | +| **Advanced Workflows** | | | | +| Enterprise DevOps Integration | ❌ | ✅ | GitHub, GitLab, Bitbucket, Azure DevOps, Gitea | +| Merge proposals with SCM | ❌ | ✅ | Automated PR/MR creation | +| GPG commit signing | ❌ | ✅ | Cryptographic verification | +| **Security & Operations** | | | | | Integrated secrets management | ❌ | ✅ | HashiCorp Vault, AWS Secrets Manager, GCP Secret Manager, and Azure Key Vault with secrets references | -| Air-gapped environment support | ❌ | ✅ | Offline license validation | -| Enterprise authentication providers | ❌ | 🔄 | Coming soon | -| Advanced analytics and reporting | ❌ | 🔄 | Coming soon | -| **Support** | | | | -| Community support | ✅ | ✅ | Discord, GitHub issues | -| Dedicated support channel | ❌ | ✅ | Direct Slack access | -| Priority bug fixes | ❌ | ✅ | Faster resolution | -| Priority feature requests | ❌ | ✅ | Influence roadmap | +| Air-gapped environment support | ❌ | ✅ | Offline license validation | +| Enterprise authentication providers | ❌ | 🔄 | Coming soon | +| Advanced analytics and reporting | ❌ | 🔄 | Coming soon | +| **Support** | | | | +| Community support | ✅ | ✅ | Discord, GitHub issues | +| Dedicated support channel | ❌ | ✅ | Direct Slack access | +| Priority bug fixes | ❌ | ✅ | Faster resolution | +| Priority feature requests | ❌ | ✅ | Influence roadmap | ## Pro Licensing diff --git a/docs/v2/reference/overview.mdx b/docs/v2/reference/overview.mdx new file mode 100644 index 0000000..da51147 --- /dev/null +++ b/docs/v2/reference/overview.mdx @@ -0,0 +1,10 @@ +--- +title: API Overview +description: Learn how to interact with the Flipt REST API to manage flags, segments, rules, and evaluate feature flags programmatically. +--- + +Flipt's API is the primary way to interact with Flipt Open Source outside of the UI. It's used to create, update, and delete entities such as namespaces, flags, segments, rules, and also to evaluate flags. + +The Flipt UI is completely backed by this same API. This means that anything that can be done in the Flipt UI can also be done via the REST API. + +The latest version of the [management REST API](https://raw.githubusercontent.com/flipt-io/flipt/refs/heads/v2/rpc/v2/environments/openapi.yaml) and [evaluation REST API](https://raw.githubusercontent.com/flipt-io/flipt/refs/heads/v2/rpc/v2/evaluation/openapi.yaml) are documented using the OpenAPI v3 specification.