TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2024-12-04 23:45:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix naming v3

Browse Source
This commit is contained in:
Elio Bischof 2024-07-05 15:35:50 +02:00
parent 5ca8ad2075
commit 39f8f6ce42
No known key found for this signature in database
GPG Key ID: 7B383FDE4DDBF1BD
2 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/docs/apis/_v3_object.proto
View File

@ -16,9 +16,12 @@ message RequestContext {
string instance_domain = 3;
string org_id = 4;
string org_domain = 5;
string project_id = 6;
}
}
enum OwnerType {
OWNER_TYPE_UNSPECIFIED = 0;
OWNER_TYPE_SYSTEM = 1; // TODO: move the source of truth from the defaults.yaml into the database

20
docs/docs/apis/v3.mdx
View File

@ -130,6 +130,8 @@ All resource services by default support the following CRUD operations [as descr
- Standard CRUD methods for Targets
- Standard CRUD methods for Executions except the PutExecution method replaces the CreateExecution and PatchExecution methods
TODO: Should we think again about the naming of the resources? For example Triggers instead of executions?
Additional to the standard CRUD methods:
- ListAvailableExecutionServices
@ -218,23 +220,31 @@ Standard CRUD methods
Standard CRUD methods
Search also returns granted projects with owner and an indicator that it is granted.
### ZITADELApps
Standard CRUD methods
### ZITADELMemberships
### ZITADELManagers
The given context defines the organization, instance or system where the membership is created.
Previously known as memberships
- Standard CRUD for managers
The given context defines the project, organization, instance where the manager is allowed.
The context and the user ID together are unique.
TODO: Can we remove project grant manager roles? A manager only needs a user id, an org id and a project manager role.
Additional to the standard CRUD methods:
- ListAvailableRoles (context-aware)
### ZITADELGrants
### ZITADELAuthorizations
- Standard CRUD methods for project grants
- Standard CRUD methods for user grants
- Standard CRUD methods for project grants (project grants are org and project linking resources with roles. grants are not projects.)
- Standard CRUD methods for authorizations (previously known as user grants)
- Standard CRUD methods for roles
### ZITADELSMTPProviders