TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-10-15 23:50:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve apis description (#7400)

Browse Source 
* docs: improve apis description

* focus on version

* link to state
This commit is contained in:
Livio Spring
2024-02-19 15:39:36 +01:00
committed by GitHub
parent 0b77fd4c17
commit 462f5462dc
9 changed files with 73 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/docs/apis/apis/index.mdx Normal file
View File

@@ -0,0 +1,12 @@
---
title: Core Resources
sidebar_label: Core Resources
---
import DocCardList from '@theme/DocCardList';
ZITADEL provides multiple APIs to manage the system, instances and resources such as users, projects and more.
There are different versions and multiple services available:
<DocCardList />

2
docs/docs/apis/introduction.mdx
View File

@@ -39,7 +39,7 @@ Refer to our guide to learn how to [build your own login UI](/docs/guides/integr
## ZITADEL APIs (resource-based)
ZITADEL provides APIs for each [core resource](/docs/apis/resources):
ZITADEL provides APIs for each [core resource](/docs/apis/v2):
- [User](/docs/apis/resources/user_service)
- [Session](/docs/apis/resources/session_service)

12
docs/docs/apis/v2.mdx Normal file
View File

@@ -0,0 +1,12 @@
---
title: APIs V2 (Beta)
---
import DocCardList from '@theme/DocCardList';
APIs V2 organize access by resources (users, settings, etc.), unlike context-specific V1 APIs.
This simplifies finding the right API, especially for multi-organization resources.
**Note**: V2 is currently in [Beta](/support/software-release-cycles-support#beta) and not yet generally available (breaking changes possible). Check individual services for availability.
<DocCardList />

15
docs/docs/apis/v3.mdx Normal file
View File

@@ -0,0 +1,15 @@
---
title: APIs V3 (Preview)
---
import DocCardList from '@theme/DocCardList';
APIs (V3) organize access by resources (users, settings, etc.), unlike context-specific V1 APIs.
This simplifies finding the right API, especially for multi-organization resources.
V3 also offers more flexibility over the V2 API in these points:
- User schema definition for custom user management.
- Behavior customization (API call manipulation, webhooks).
**Note**: V3 is currently in [Preview](/support/software-release-cycles-support#preview) and not yet generally available (breaking changes possible). Check individual services for availability.
<DocCardList />