feat: System api (#3461)

* feat: start system api

* feat: remove auth

* feat: change gitignore

* feat: run system api

* feat: remove clear view form admin api

* feat: search instances

* feat: add instance

* fix: set primary domain

* Update .gitignore

* fix: add instance

* fix: add instance

* fix: handle errors

* fix: handle instance name

* fix: test

Co-authored-by: Livio Amstutz <livio.a@gmail.com>
This commit is contained in:
Fabi
2022-04-21 12:37:39 +02:00
committed by GitHub
parent a7816a43b1
commit 3d5891eb11
40 changed files with 1216 additions and 485 deletions

View File

@@ -1427,21 +1427,6 @@ they represent the delta of the event happend on the objects
POST: /views/_search
### ClearView
> **rpc** ClearView([ClearViewRequest](#clearviewrequest))
[ClearViewResponse](#clearviewresponse)
Truncates the delta of the change stream
be carefull with this function because ZITADEL has to
recompute the deltas after they got cleared.
Search requests will return wrong results until all deltas are recomputed
POST: /views/{database}/{view_name}
### ListFailedEvents
> **rpc** ListFailedEvents([ListFailedEventsRequest](#listfailedeventsrequest))
@@ -1463,7 +1448,7 @@ For example if the SMTP-API wasn't able to send an email at the first time
Deletes the event from failed events view.
the event is not removed from the change stream
This call is usefull if the system was able to process the event later.
This call is usefull if the system was able to process the event later.
e.g. if the second try of sending an email was successful. the first try produced a
failed event. You can find out if it worked on the `failure_count`
@@ -1718,24 +1703,6 @@ This is an empty request
### ClearViewRequest
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| database | string | - | string.min_len: 1<br /> string.max_len: 200<br /> |
| view_name | string | - | string.min_len: 1<br /> string.max_len: 200<br /> |
### ClearViewResponse
This is an empty response
### DeactivateIDPRequest

View File

@@ -70,13 +70,13 @@ DomainPrimaryQuery is always equals
### IdQuery
### IdsQuery
IdQuery is always equals
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| id | string | - | string.max_len: 200<br /> |
| ids | repeated string | - | |
@@ -91,7 +91,6 @@ IdQuery is always equals
| details | zitadel.v1.ObjectDetails | - | |
| state | State | - | |
| name | string | - | |
| version | string | - | |
@@ -102,19 +101,7 @@ IdQuery is always equals
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.id_query | IdQuery | - | |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.state_query | StateQuery | - | |
### StateQuery
StateQuery is always equals
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| state | State | - | enum.defined_only: true<br /> |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) query.id_query | IdsQuery | - | |

View File

@@ -29,7 +29,7 @@ Returns a list of ZITADEL instances/tenants
POST: /instances
POST: /instances/_search
### GetInstance
@@ -70,18 +70,6 @@ This might take some time
DELETE: /instances/{id}
### GetUsage
> **rpc** GetUsage([GetUsageRequest](#getusagerequest))
[GetUsageResponse](#getusageresponse)
Returns the usage metrics of an instance
GET: /instances/{id}/usage
### ListDomains
> **rpc** ListDomains([ListDomainsRequest](#listdomainsrequest))
@@ -91,7 +79,7 @@ Returns the custom domains of an instance
GET: /instances/{id}/domains
POST: /instances/{id}/domains/_search
### AddDomain
@@ -227,13 +215,12 @@ failed event. You can find out if it worked on the `failure_count`
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| instance_name | string | - | string.min_len: 1<br /> string.max_len: 200<br /> |
| first_org_name | string | - | string.min_len: 1<br /> string.max_len: 200<br /> |
| first_org_name | string | - | string.max_len: 200<br /> |
| custom_domain | string | - | string.max_len: 200<br /> |
| owner_first_name | string | - | string.min_len: 1<br /> string.max_len: 200<br /> |
| owner_last_name | string | - | string.min_len: 1<br /> string.max_len: 200<br /> |
| owner_first_name | string | - | string.max_len: 200<br /> |
| owner_last_name | string | - | string.max_len: 200<br /> |
| owner_email | string | - | string.min_len: 1<br /> string.max_len: 200<br /> |
| owner_username | string | - | string.min_len: 1<br /> string.max_len: 200<br /> |
| password | string | - | string.min_len: 1<br /> string.max_len: 200<br /> |
| owner_username | string | - | string.max_len: 200<br /> |
| request_limit | uint64 | - | |
| action_mins_limit | uint64 | - | |
@@ -247,6 +234,7 @@ failed event. You can find out if it worked on the `failure_count`
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| id | string | - | |
| details | zitadel.v1.ObjectDetails | - | |