Capability http reference

Fireback accelerates backend and mobile app development, offering powerful code generation tools and standardized architecture. With seamless backend integration and streamlined workflows, Fireback expedites the creation of robust and scalable apps.

postCapability

capability

Response Dto/Entity: *workspaces.CapabilityEntity

message CapabilityEntity {
	string uniqueId  = 1; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:2500;autoIncrement:false")
	optional string visibility = 2; // @tag(yaml:"visibility")
	int64 updated = 3; // @tag(gorm:"autoUpdateTime:nano")
	int64 created = 4; // @tag(gorm:"autoUpdateTime:nano")
}
export interface CapabilityEntity {
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:2500;autoIncrement:false") */
  uniqueId: string;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
}

Request Dto/Entity: *workspaces.CapabilityEntity

message CapabilityEntity {
	string uniqueId  = 1; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:2500;autoIncrement:false")
	optional string visibility = 2; // @tag(yaml:"visibility")
	int64 updated = 3; // @tag(gorm:"autoUpdateTime:nano")
	int64 created = 4; // @tag(gorm:"autoUpdateTime:nano")
}
export interface CapabilityEntity {
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:2500;autoIncrement:false") */
  uniqueId: string;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
}

patchCapability

capability

Response Dto/Entity: *workspaces.CapabilityEntity

message CapabilityEntity {
	string uniqueId  = 1; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:2500;autoIncrement:false")
	optional string visibility = 2; // @tag(yaml:"visibility")
	int64 updated = 3; // @tag(gorm:"autoUpdateTime:nano")
	int64 created = 4; // @tag(gorm:"autoUpdateTime:nano")
}
export interface CapabilityEntity {
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:2500;autoIncrement:false") */
  uniqueId: string;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
}

Request Dto/Entity: *workspaces.CapabilityEntity

message CapabilityEntity {
	string uniqueId  = 1; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:2500;autoIncrement:false")
	optional string visibility = 2; // @tag(yaml:"visibility")
	int64 updated = 3; // @tag(gorm:"autoUpdateTime:nano")
	int64 created = 4; // @tag(gorm:"autoUpdateTime:nano")
}
export interface CapabilityEntity {
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:2500;autoIncrement:false") */
  uniqueId: string;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
}

deleteCapability

capability

Request Dto/Entity: *core.DeleteRequest

Target Entity: *workspaces.CapabilityEntity

message CapabilityEntity {
	string uniqueId  = 1; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:2500;autoIncrement:false")
	optional string visibility = 2; // @tag(yaml:"visibility")
	int64 updated = 3; // @tag(gorm:"autoUpdateTime:nano")
	int64 created = 4; // @tag(gorm:"autoUpdateTime:nano")
}
export interface CapabilityEntity {
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:2500;autoIncrement:false") */
  uniqueId: string;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
}

getCapabilityByUniqueId

capability/:uniqueId

Response Dto/Entity: *workspaces.CapabilityEntity

message CapabilityEntity {
	string uniqueId  = 1; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:2500;autoIncrement:false")
	optional string visibility = 2; // @tag(yaml:"visibility")
	int64 updated = 3; // @tag(gorm:"autoUpdateTime:nano")
	int64 created = 4; // @tag(gorm:"autoUpdateTime:nano")
}
export interface CapabilityEntity {
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:2500;autoIncrement:false") */
  uniqueId: string;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
}

Params: :uniqueId

getCapabilities

capabilities

Response Dto/Entity: *[]workspaces.CapabilityEntity

message CapabilityEntity {
	string uniqueId  = 1; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:2500;autoIncrement:false")
	optional string visibility = 2; // @tag(yaml:"visibility")
	int64 updated = 3; // @tag(gorm:"autoUpdateTime:nano")
	int64 created = 4; // @tag(gorm:"autoUpdateTime:nano")
}
export interface CapabilityEntity {
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:2500;autoIncrement:false") */
  uniqueId: string;
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
}

getCapabilitiesTree

capabilities/tree

Response Dto/Entity: *workspaces.CapabilitiesResult

message CapabilitiesResult {
	repeated CapabilityEntity capabilities = 1;
	repeated CapabilityChild nested = 2;
	optional string visibility = 3; // @tag(yaml:"visibility")
	int64 updated = 4; // @tag(gorm:"autoUpdateTime:nano")
  	int64 created = 5; // @tag(gorm:"autoUpdateTime:nano")

}
export interface CapabilitiesResult {
  capabilities: CapabilityEntity[];
  nested: CapabilityChild[];
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
}