rct.api
Message
CountAllEventsResponse
Message
CountEventsByTypeRequest
Message
CountEventsByTypeResponse
Message
CreateComponentRequest
Message
CreateComponentResponse
Message
DeleteComponentRequest
Message
DeleteComponentResponse
Message
ListComponentsByPageRequest
Message
ListComponentsByPageResponse
Message
ListEventsByComponentRequest
Message
ListEventsByComponentResponse
Message
XEventDeploymentEnvironment
Message
XEventDeploymentPipeline
List
rct.api.ListComponentsByPageRequest
rct.api.ListComponentsByPageResponse
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | shortName |
string
|
||
2 | displayName |
string
|
||
3 | order |
int32
|
||
4 | description |
rct.common.TextItem
|
||
5 | type |
rct.common.CatalogItemType
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | id |
string
|
||
2 | metadata |
rct.api.CatalogItemMetadata
|
* Size efficient representation of the batch of components.
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | components |
repeated
rct.api.ComponentRef
|
||
2 | teams |
repeated
rct.api.TeamRef
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | shortName |
string
|
* Mandatory human-readable component identificator. Is used in the links and APIs. Limits: - max length: 70 - characters: [a-z0-9] and "-" - lowercase only Examples: - checkout-card, user-service - https://rocketslo.com/components/checkout-card |
|
2 | displayName |
string
|
* Optional human-readable component identificator. If not provided then shortName is used instead. Limits: - max length: 120 - characters: [A-Za-z0-9], "-", " ", "_" - case insensitive Examples: - "Checkout Card", "User Service" |
|
3 | description |
rct.common.TextItem
|
* Optional rich component description. Summary about what this component is and what it does. Limits: - max length: 2000 Examples: - "User Service is core component of our application. It handles all user related data and operations." |
|
4 | type |
string
|
* Mandatory ID of the component type. Points to CatalogItemView. |
|
5 | avatar |
rct.common.Avatar
|
* Optional component avatar. If not specified then default built-in avatar will be used. |
|
6 | ownerTeamId |
string
|
* Mandatory owner team ID. |
* The minimal component object. Repeated fields (like users, tags, teams) are represented only with ids.
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | id |
string
|
* Mandatory internal component ID. Example: "component:790AAD4A-9628-421A-BEC9-30005F6A9C58". |
|
2 | metadata |
rct.api.ComponentMetadata
|
||
3 | type |
rct.api.CatalogItemView
|
* Mandatory component type. |
|
5 | tags |
repeated
rct.api.TagView
|
* List of tags. Order is important and must be respected by the frontend. |
|
8 | createMeta |
rct.common.CreateMeta
|
||
9 | updateMeta |
rct.common.UpdateMeta
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | id |
string
|
* Mandatory internal component ID. |
|
2 | metadata |
rct.api.ComponentMetadata
|
||
3 | type |
rct.api.CatalogItemView
|
* Mandatory component type. |
|
5 | tags |
repeated
rct.api.TagView
|
* List of tags. Order is important and must be respected by the frontend. |
|
8 | createMeta |
rct.common.CreateMeta
|
||
9 | updateMeta |
rct.common.UpdateMeta
|
||
10 | ownerTeam |
rct.api.Team
|
* Team that owns the component. |
|
11 | links |
repeated
rct.api.Link
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | count |
int64
|
The number of events. |
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | type |
rct.api.EventType
|
The type of event to count. |
|
2 | componentShortName |
string
|
The component short name |
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | type |
rct.api.EventType
|
The type of event to count. |
|
2 | count |
int64
|
The number of events. |
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | meta |
rct.api.ComponentMetadata
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | component |
rct.api.ComponentView
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | componentShortName |
string
|
The component short name. |
|
2 | event |
rct.api.XEventInput
|
The event body. |
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | id |
string
|
||
2 | meta |
rct.api.LinkMeta
|
||
3 | createMeta |
rct.common.CreateMeta
|
||
4 | updateMeta |
rct.common.UpdateMeta
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | url |
string
|
||
2 | displayName |
string
|
||
3 | avatar |
rct.common.Avatar
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | pageRequest |
rct.common.PageRequest
|
* Limits: - max 100 components in one page |
|
2 | options |
rct.api.ListComponentsOptions
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | batch |
rct.api.ComponentBatch
|
||
2 | pageResponse |
rct.common.PageResponse
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | componentShortName |
string
|
||
2 | pageRequest |
rct.common.PageRequest
|
* Limits: - max 100 components in one page |
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | events |
repeated
rct.api.XEventItem
|
||
2 | pageResponse |
rct.common.PageResponse
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | includeUserDetails |
bool
|
if false then ListTeamsResponse.batch.usersByIds is empty |
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | pageRequest |
rct.common.PageRequest
|
* Limits: - max 100 teams in one page |
|
2 | options |
rct.api.ListTeamsOptions
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | batch |
rct.api.TeamBatch
|
* Batch of teams. |
|
2 | pageResponse |
rct.common.PageResponse
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | users |
repeated
rct.api.User
|
||
2 | pageResponse |
rct.common.PageResponse
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | tagId |
string
|
||
2 | displayName |
string
|
||
3 | valueId |
string
|
||
4 | value |
string
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | id |
string
|
* Mandatory internal team identificator. Example: - team:07D4AE66-41E1-42FD-9BDC-9FB736A25302 |
|
2 | meta |
rct.api.TeamMeta
|
||
3 | members |
repeated
rct.api.User
|
* Team members. |
|
4 | createMeta |
rct.common.CreateMeta
|
||
5 | updateMeta |
rct.common.UpdateMeta
|
||
6 | ownerOfComponentIds |
repeated
string
|
* Size efficient representation of the batch of teams.
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | teams |
repeated
rct.api.TeamRef
|
* List of teams. |
|
2 | usersByIds |
repeated
rct.api.TeamBatch.UsersByIdsEntry
|
* Map containing all the users referenced by teams. Key = userId, value = User. Empty if ListTeamsOptions.includeUserDetails is false. |
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | shortName |
string
|
* Mandatory human-readable team identificator. Is used in the links and APIs. Limits: - max length: 70 - characters: [a-z0-9] and "-" - lowercase only Examples: - team-bravo - https://rocketslo.com/components/team-bravo |
|
2 | displayName |
string
|
* Optional human-readable team identificator. If not provided then shortName is used instead. Limits: - max length: 120 - characters: [A-Za-z0-9], "-", " ", "_" - case insensitive Examples: - "Team Bravo" |
|
3 | description |
rct.common.TextItem
|
* Optional rich team description. Summary about what this team is and what they do. Limits: - max length: 2000 |
|
4 | avatar |
rct.common.Avatar
|
* Optional team avatar. If not provided, random built-in avatar is used. |
* The minimal team object. Repeated fields (like users) are represented only with ids.
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | id |
string
|
* Mandatory internal team identificator. Example: - team:07D4AE66-41E1-42FD-9BDC-9FB736A25302 |
|
2 | meta |
rct.api.TeamMeta
|
||
3 | memberUserIds |
repeated
string
|
* IDs of team members. Order is important and must be respected by the frontend. For example, current user might be always the first in the list. |
|
4 | createMeta |
rct.common.CreateMeta
|
||
5 | updateMeta |
rct.common.UpdateMeta
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | id |
string
|
Mandatory. |
|
2 | username |
string
|
Mandatory username. Limits: - max length: 50 - lowercase only - characters: [a-z0-9], "-", "_" and "." |
|
3 |
string
|
Mandatory |
||
4 | fullName |
string
|
Optional. If not provided username is used instead. |
|
5 | avatar |
rct.common.Avatar
|
Mandatory. If not provided, random built-in avatar is assigned during user creation. |
|
6 | tenantId |
string
|
Remove? For all the users tenantId will be the same. |
|
8 | createMeta |
rct.common.CreateMeta
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | displayName |
string
|
The name of the event. |
|
2 | lastUpdated |
int64
|
The last time (UTC) this event was updated. |
|
3 | description |
string
|
The description of the event. |
|
4 | url |
string
|
The URL of the event. |
|
5 | properties |
rct.api.XEventBuildProperties
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | pipelineId |
string
|
The ID of the build event pipeline. |
|
2 | url |
string
|
The URL to the build event pipeline. |
|
3 | displayName |
string
|
The name of the build event pipeline. |
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | state |
rct.api.XEventBuildProperties.State
|
||
2 | pipeline |
rct.api.XEventBuildPipeline
|
||
3 | startedAt |
int64
|
The time (UTC) the build started. |
|
4 | completedAt |
int64
|
The time (UTC) the build completed. |
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | displayName |
string
|
The name of the event. |
|
2 | lastUpdatedAt |
int64
|
The time (UTC) this event was last updated. |
|
3 | description |
string
|
The description of the event. |
|
4 | url |
string
|
The URL of the event. |
|
5 | sentiment |
rct.api.XEventCustom.Sentiment
|
||
6 | status |
string
|
||
8 | properties |
repeated
rct.api.XEventCustomProp
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | displayName |
string
|
The name of the deployment event. |
|
2 | url |
string
|
The URL of the deployment event. |
|
3 | description |
string
|
The description of the deployment event. |
|
4 | lastUpdated |
int64
|
The last time (UTC) this event was updated. |
|
5 | properties |
rct.api.XEventDeploymentProperties
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | environmentId |
string
|
The ID of the environment where the deployment event occurred. |
|
2 | displayName |
string
|
The display name of the environment where the deployment event occurred. |
|
3 | category |
rct.api.XEventDeploymentEnvironment.Category
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | pipelineId |
string
|
The ID of the deployment event pipeline. |
|
2 | url |
string
|
The URL of the deployment event pipeline. |
|
3 | displayName |
string
|
The name of the deployment event pipeline. |
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | sequenceNumber |
int64
|
The sequence number for the deployment. |
|
2 | state |
rct.api.XEventDeploymentProperties.State
|
||
3 | pipeline |
rct.api.XEventDeploymentPipeline
|
||
4 | environment |
rct.api.XEventDeploymentEnvironment
|
||
5 | startedAt |
int64
|
The time (UTC) this deployment was started at. |
|
6 | completedAt |
int64
|
The time (UTC) this deployment was completed at. |
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | deployment |
rct.api.XEventDeployment
|
||
2 | build |
rct.api.XEventBuild
|
||
3 | custom |
rct.api.XEventCustom
|
Field | Type | Description | Default Value | |
---|---|---|---|---|
1 | id |
string
|
The ID of the event. |
|
2 | componentShortName |
string
|
The short name of the component (aka component ID). |
|
3 | rawEvent |
string
|
The RAW event JSON. |
The type of environment where the deployment event occurred.
Name | Number | Description |
---|---|---|
CATEGORY_UNSPECIFIED |
0 | |
CATEGORY_PRODUCTION |
1 | |
CATEGORY_STAGING |
2 | |
CATEGORY_TESTING |
3 | |
CATEGORY_DEVELOPMENT |
4 |
The type of event.
Name | Number | Description |
---|---|---|
EVENT_TYPE_UNSPECIFIED |
0 | |
EVENT_TYPE_DEPLOYMENT |
1 | |
EVENT_TYPE_BUILD |
2 | |
EVENT_TYPE_CUSTOM |
3 |
The sentiment for the custom event.
Name | Number | Description |
---|---|---|
SENTIMENT_UNSPECIFIED |
0 | |
SENTIMENT_NEUTRAL |
1 | |
SENTIMENT_INFO |
2 | |
SENTIMENT_WARNING |
3 | |
SENTIMENT_ERROR |
4 |
The state of the deployment.
Name | Number | Description |
---|---|---|
STATE_UNSPECIFIED |
0 | |
STATE_PENDING |
1 | |
STATE_IN_PROGRESS |
2 | |
STATE_SUCCESSFUL |
3 | |
STATE_CANCELED |
4 | |
STATE_FAILED |
5 | |
STATE_ROLLED_BACK |
6 |
The state of the build.
Name | Number | Description |
---|---|---|
STATE_UNSPECIFIED |
0 | |
STATE_IN_PROGRESS |
1 | |
STATE_SUCCESSFUL |
2 | |
STATE_CANCELED |
3 | |
STATE_FAILED |
4 | |
STATE_ERROR |
5 | |
STATE_TIMED_OUT |
6 | |
STATE_UNKNOWN |
7 |