Browse content
Fireback - User authentication built for you. Get your license

Product http reference

User-flow built for you.

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

Ali Torabi

Software Engineer

Ali Torabi's github account
My name is Ali Torabi, I am a software engineer who is highly interested in JavaScript, Golang and C++. I serve clients, build projects and create content and videos. Started programming in primary school, still at age of 30 it's main activity I do.