Product 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.

getProducts

/products

Response Dto/Entity: *[]licenses.ProductEntity

message ProductEntity {
  string workspaceId = 1; // @tag(yaml:"workspaceId")
  string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  string userId = 4; // @tag(yaml:"userId")
  string name = 6; // @tag( validate:"required" yaml:"name")
  string privateKey = 7; // @tag( validate:"required" yaml:"privateKey")
  string publicKey = 8; // @tag( validate:"required" yaml:"publicKey")

}
export interface ProductEntity {
    /** @tag(yaml:"workspaceId") */
    workspaceId: string;
    /** @tag(yaml:"parentId") */
    parentId: string;
    /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
    uniqueId: string;
    /** @tag(yaml:"userId") */
    userId: string;
    /** @tag( validate:"required" yaml:"name") */
    name: string;
    /** @tag( validate:"required" yaml:"privateKey") */
    privateKey: string;
    /** @tag( validate:"required" yaml:"publicKey") */
    publicKey: string;
}

getProductById

/product/:id

Response Dto/Entity: *licenses.ProductEntity

message ProductEntity {
  string workspaceId = 1; // @tag(yaml:"workspaceId")
  string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  string userId = 4; // @tag(yaml:"userId")
  string name = 6; // @tag( validate:"required" yaml:"name")
  string privateKey = 7; // @tag( validate:"required" yaml:"privateKey")
  string publicKey = 8; // @tag( validate:"required" yaml:"publicKey")

}
export interface ProductEntity {
    /** @tag(yaml:"workspaceId") */
    workspaceId: string;
    /** @tag(yaml:"parentId") */
    parentId: string;
    /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
    uniqueId: string;
    /** @tag(yaml:"userId") */
    userId: string;
    /** @tag( validate:"required" yaml:"name") */
    name: string;
    /** @tag( validate:"required" yaml:"privateKey") */
    privateKey: string;
    /** @tag( validate:"required" yaml:"publicKey") */
    publicKey: string;
}

Params: :id

postProduct

/product

Response Dto/Entity: *licenses.ProductEntity

message ProductEntity {
  string workspaceId = 1; // @tag(yaml:"workspaceId")
  string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  string userId = 4; // @tag(yaml:"userId")
  string name = 6; // @tag( validate:"required" yaml:"name")
  string privateKey = 7; // @tag( validate:"required" yaml:"privateKey")
  string publicKey = 8; // @tag( validate:"required" yaml:"publicKey")

}
export interface ProductEntity {
    /** @tag(yaml:"workspaceId") */
    workspaceId: string;
    /** @tag(yaml:"parentId") */
    parentId: string;
    /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
    uniqueId: string;
    /** @tag(yaml:"userId") */
    userId: string;
    /** @tag( validate:"required" yaml:"name") */
    name: string;
    /** @tag( validate:"required" yaml:"privateKey") */
    privateKey: string;
    /** @tag( validate:"required" yaml:"publicKey") */
    publicKey: string;
}

Request Dto/Entity: *licenses.ProductEntity

message ProductEntity {
  string workspaceId = 1; // @tag(yaml:"workspaceId")
  string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  string userId = 4; // @tag(yaml:"userId")
  string name = 6; // @tag( validate:"required" yaml:"name")
  string privateKey = 7; // @tag( validate:"required" yaml:"privateKey")
  string publicKey = 8; // @tag( validate:"required" yaml:"publicKey")

}
export interface ProductEntity {
    /** @tag(yaml:"workspaceId") */
    workspaceId: string;
    /** @tag(yaml:"parentId") */
    parentId: string;
    /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
    uniqueId: string;
    /** @tag(yaml:"userId") */
    userId: string;
    /** @tag( validate:"required" yaml:"name") */
    name: string;
    /** @tag( validate:"required" yaml:"privateKey") */
    privateKey: string;
    /** @tag( validate:"required" yaml:"publicKey") */
    publicKey: string;
}

patchProductById

/product/:id

Response Dto/Entity: *licenses.ProductEntity

message ProductEntity {
  string workspaceId = 1; // @tag(yaml:"workspaceId")
  string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  string userId = 4; // @tag(yaml:"userId")
  string name = 6; // @tag( validate:"required" yaml:"name")
  string privateKey = 7; // @tag( validate:"required" yaml:"privateKey")
  string publicKey = 8; // @tag( validate:"required" yaml:"publicKey")

}
export interface ProductEntity {
    /** @tag(yaml:"workspaceId") */
    workspaceId: string;
    /** @tag(yaml:"parentId") */
    parentId: string;
    /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
    uniqueId: string;
    /** @tag(yaml:"userId") */
    userId: string;
    /** @tag( validate:"required" yaml:"name") */
    name: string;
    /** @tag( validate:"required" yaml:"privateKey") */
    privateKey: string;
    /** @tag( validate:"required" yaml:"publicKey") */
    publicKey: string;
}

Request Dto/Entity: *licenses.ProductEntity

message ProductEntity {
  string workspaceId = 1; // @tag(yaml:"workspaceId")
  string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  string userId = 4; // @tag(yaml:"userId")
  string name = 6; // @tag( validate:"required" yaml:"name")
  string privateKey = 7; // @tag( validate:"required" yaml:"privateKey")
  string publicKey = 8; // @tag( validate:"required" yaml:"publicKey")

}
export interface ProductEntity {
    /** @tag(yaml:"workspaceId") */
    workspaceId: string;
    /** @tag(yaml:"parentId") */
    parentId: string;
    /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
    uniqueId: string;
    /** @tag(yaml:"userId") */
    userId: string;
    /** @tag( validate:"required" yaml:"name") */
    name: string;
    /** @tag( validate:"required" yaml:"privateKey") */
    privateKey: string;
    /** @tag( validate:"required" yaml:"publicKey") */
    publicKey: string;
}

Params: :id

deleteProductById

/product/:id

Target Entity: *licenses.ProductEntity

message ProductEntity {
  string workspaceId = 1; // @tag(yaml:"workspaceId")
  string parentId = 2; // @tag(yaml:"parentId")
  string uniqueId = 3; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  string userId = 4; // @tag(yaml:"userId")
  string name = 6; // @tag( validate:"required" yaml:"name")
  string privateKey = 7; // @tag( validate:"required" yaml:"privateKey")
  string publicKey = 8; // @tag( validate:"required" yaml:"publicKey")

}
export interface ProductEntity {
    /** @tag(yaml:"workspaceId") */
    workspaceId: string;
    /** @tag(yaml:"parentId") */
    parentId: string;
    /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
    uniqueId: string;
    /** @tag(yaml:"userId") */
    userId: string;
    /** @tag( validate:"required" yaml:"name") */
    name: string;
    /** @tag( validate:"required" yaml:"privateKey") */
    privateKey: string;
    /** @tag( validate:"required" yaml:"publicKey") */
    publicKey: string;
}

Params: :id