Application Service

Service to manage Applications and APis

Applications

The Applications service exposes methods to manage Applications and API definitions in Service Bridge.

CreateApplication

rpc CreateApplication (tetrateio.api.tsb.application.v2.CreateApplicationRequest) returns (tetrateio.api.tsb.application.v2.Application)

Requires CREATE

Creates a new Application in TSB.

GetApplication

rpc GetApplication (tetrateio.api.tsb.application.v2.GetApplicationRequest) returns (tetrateio.api.tsb.application.v2.Application)

Requires READ

Get the details of an existing application.

UpdateApplication

rpc UpdateApplication (tetrateio.api.tsb.application.v2.Application) returns (tetrateio.api.tsb.application.v2.Application)

Requires WRITE

Modify an existing application.

ListApplications

rpc ListApplications (tetrateio.api.tsb.application.v2.ListApplicationsRequest) returns (tetrateio.api.tsb.application.v2.ListApplicationsResponse)

List all existing applications for the given tenant.

DeleteApplication

rpc DeleteApplication (tetrateio.api.tsb.application.v2.DeleteApplicationRequest) returns (google.protobuf.Empty)

Requires DELETE

Delete an existing Application. Note that deleting resources in TSB is a recursive operation. Deleting a application will delete all API objects that exist in it.

GetApplicationStatus

rpc GetApplicationStatus (tetrateio.api.tsb.application.v2.GetStatusRequest) returns (tetrateio.api.tsb.application.v2.ResourceStatus)

Requires ReadApplication

Get the configuration status of an existing application.

CreateAPI

rpc CreateAPI (tetrateio.api.tsb.application.v2.CreateAPIRequest) returns (tetrateio.api.tsb.application.v2.API)

Requires CREATE

Attach a new API to the given application.

GetAPI

rpc GetAPI (tetrateio.api.tsb.application.v2.GetAPIRequest) returns (tetrateio.api.tsb.application.v2.API)

Requires READ

Get the details of an API.

UpdateAPI

rpc UpdateAPI (tetrateio.api.tsb.application.v2.API) returns (tetrateio.api.tsb.application.v2.API)

Requires WRITE

Deprecated. Use the UpdateAPIWithParams method instead. Modifies an existing API object if its status is not DIRTY.

UpdateAPIWithParams

rpc UpdateAPIWithParams (tetrateio.api.tsb.application.v2.UpdateAPIRequest) returns (tetrateio.api.tsb.application.v2.API)

Requires WriteAPI

Modify an existing API object. By default, API objects that are in DIRTY state cannot be modified. This state is reached when the configurations generated for the API object are not in sync with the contents of the API object itself, so updates are rejected to prevent accidental changes. In these situations, the force flag can be used to force the update and to overwrite any changes that have been done to the generated config resources. When using the HTTP APIs, the force flag must be set as a query parameter.

ListAPIs

rpc ListAPIs (tetrateio.api.tsb.application.v2.ListAPIsRequest) returns (tetrateio.api.tsb.application.v2.ListAPIsResponse)

List all APIs attached to the given application.

DeleteAPI

rpc DeleteAPI (tetrateio.api.tsb.application.v2.DeleteAPIRequest) returns (google.protobuf.Empty)

Requires DELETE

Delete an existing API.

GetAPIStatus

rpc GetAPIStatus (tetrateio.api.tsb.application.v2.GetStatusRequest) returns (tetrateio.api.tsb.application.v2.ResourceStatus)

Requires ReadAPI

Get the configuration status of an existing API.

CreateAPIRequest

Request to create an API and register it in the management plane so configuration can be generated for it.

Field Description Validation Rule

parent

string
REQUIRED
Parent resource where the API will be created. This is the FQN of the application where the API belongs to.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
}

api

tetrateio.api.tsb.application.v2.API
REQUIRED
Details of the API to be created.

message = {
  required: true
}

CreateApplicationRequest

Request to create an application and register it in the management plane so configuration can be generated for it.

Field Description Validation Rule

parent

string
REQUIRED
Parent resource where the application will be created. This is the FQN of the tenant where the application belongs to.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
}

application

tetrateio.api.tsb.application.v2.Application
REQUIRED
Details of the application to be created.

message = {
  required: true
}

DeleteAPIRequest

Request to delete an API.

Field Description Validation Rule

fqn

string
REQUIRED
Fully-qualified name of the API.

string = {
  min_len: 1
}

DeleteApplicationRequest

Request to delete an application.

Field Description Validation Rule

fqn

string
REQUIRED
Fully-qualified name of the application.

string = {
  min_len: 1
}

forceDeleteProtectedGroups

bool
Force the deletion of internal groups even if they are protected against deletion.

GetAPIRequest

Request to retrieve an API.

Field Description Validation Rule

fqn

string
REQUIRED
Fully-qualified name of the API.

string = {
  min_len: 1
}

GetApplicationRequest

Request to retrieve an application.

Field Description Validation Rule

fqn

string
REQUIRED
Fully-qualified name of the application.

string = {
  min_len: 1
}

GetStatusRequest

Request to retrieve the configuration status of a given resource.

Field Description Validation Rule

fqn

string
REQUIRED
Fully-qualified name of the resource to get the configuration status for.

string = {
  min_len: 1
}

ListAPIsRequest

Request to list APIs.

Field Description Validation Rule

parent

string
REQUIRED
Parent resource to list APIs from. This is the FQN of the application where the APIs belong to.

string = {
  min_len: 1
}

ListAPIsResponse

List of APIs that have been attached to the given application.

Field Description Validation Rule

apis

List of tetrateio.api.tsb.application.v2.API
The list of APIs that are registered in the given application.

ListApplicationsRequest

Request to list applications.

Field Description Validation Rule

parent

string
REQUIRED
Parent resource to list applications from. This is the FQN of the tenant where the applications belong to.

string = {
  min_len: 1
}

ListApplicationsResponse

List of applications in the given tenant.

Field Description Validation Rule

applications

List of tetrateio.api.tsb.application.v2.Application
The list of applications that are registered in the given tenant.

UpdateAPIRequest

Field Description Validation Rule

api

tetrateio.api.tsb.application.v2.API
REQUIRED
Details of the API to be updated.

message = {
  required: true
}

force

bool
When the force parameter is set, changes will be applied regardless of the status of the API object. This will overwrite the generated configuration objects even if they were manually modified or were out of sync with the API object. Defaults to false.