Passport method http reference

User-flow built for you.

Browse content
Fireback ‐ Ultimate Go FullStack Framework
Ta treść nie jest dostępna w języku polskim.

getPassportMethods

passportMethods

Response Dto/Entity: *[]passports.PassportMethodEntity

message PassportMethodEntity {
  optional string visibility = 1; // @tag(yaml:"visibility")
  optional string workspaceId = 2; // @tag(yaml:"workspaceId")
  optional string parentId = 3; // @tag(yaml:"parentId")
  string uniqueId = 4; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 5; // @tag(yaml:"userId")
  repeated PassportMethodEntityPolyglot translations = 6; // @tag(gorm:"foreignKey:ParentId;references:UniqueId" json:"translations")
  optional string name = 8; // @tag(translate:"true" validate:"required" yaml:"name" )

  optional string type = 9; // @tag( validate:"required" yaml:"type" )

  optional string region = 10; // @tag( validate:"required" yaml:"region" )

  int64 rank = 11; // @tag(gorm:"type:int;name:rank")
  int64 updated = 12; // @tag(gorm:"autoUpdateTime:nano")
  int64 created = 13; // @tag(gorm:"autoUpdateTime:nano")
  string createdFormatted = 14; // @tag(sql:"-")
  string updatedFormatted = 15; // @tag(sql:"-")

}

export interface PassportMethodEntity {
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag(gorm:"foreignKey:ParentId;references:UniqueId" json:"translations") */
  translations: PassportMethodEntityPolyglot[];
  /** @tag(translate:"true" validate:"required" yaml:"name" ) */
  name?: string | undefined;
  /** @tag( validate:"required" yaml:"type" ) */
  type?: string | undefined;
  /** @tag( validate:"required" yaml:"region" ) */
  region?: string | undefined;
  /** @tag(gorm:"type:int;name:rank") */
  rank: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
  /** @tag(sql:"-") */
  createdFormatted: string;
  /** @tag(sql:"-") */
  updatedFormatted: string;
}

getPassportMethodByUniqueId

passportMethod/:uniqueId

Response Dto/Entity: *passports.PassportMethodEntity

message PassportMethodEntity {
  optional string visibility = 1; // @tag(yaml:"visibility")
  optional string workspaceId = 2; // @tag(yaml:"workspaceId")
  optional string parentId = 3; // @tag(yaml:"parentId")
  string uniqueId = 4; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 5; // @tag(yaml:"userId")
  repeated PassportMethodEntityPolyglot translations = 6; // @tag(gorm:"foreignKey:ParentId;references:UniqueId" json:"translations")
  optional string name = 8; // @tag(translate:"true" validate:"required" yaml:"name" )

  optional string type = 9; // @tag( validate:"required" yaml:"type" )

  optional string region = 10; // @tag( validate:"required" yaml:"region" )

  int64 rank = 11; // @tag(gorm:"type:int;name:rank")
  int64 updated = 12; // @tag(gorm:"autoUpdateTime:nano")
  int64 created = 13; // @tag(gorm:"autoUpdateTime:nano")
  string createdFormatted = 14; // @tag(sql:"-")
  string updatedFormatted = 15; // @tag(sql:"-")

}

export interface PassportMethodEntity {
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag(gorm:"foreignKey:ParentId;references:UniqueId" json:"translations") */
  translations: PassportMethodEntityPolyglot[];
  /** @tag(translate:"true" validate:"required" yaml:"name" ) */
  name?: string | undefined;
  /** @tag( validate:"required" yaml:"type" ) */
  type?: string | undefined;
  /** @tag( validate:"required" yaml:"region" ) */
  region?: string | undefined;
  /** @tag(gorm:"type:int;name:rank") */
  rank: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
  /** @tag(sql:"-") */
  createdFormatted: string;
  /** @tag(sql:"-") */
  updatedFormatted: string;
}

Params: :uniqueId

postPassportMethod

passportMethod

Response Dto/Entity: *passports.PassportMethodEntity

message PassportMethodEntity {
  optional string visibility = 1; // @tag(yaml:"visibility")
  optional string workspaceId = 2; // @tag(yaml:"workspaceId")
  optional string parentId = 3; // @tag(yaml:"parentId")
  string uniqueId = 4; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 5; // @tag(yaml:"userId")
  repeated PassportMethodEntityPolyglot translations = 6; // @tag(gorm:"foreignKey:ParentId;references:UniqueId" json:"translations")
  optional string name = 8; // @tag(translate:"true" validate:"required" yaml:"name" )

  optional string type = 9; // @tag( validate:"required" yaml:"type" )

  optional string region = 10; // @tag( validate:"required" yaml:"region" )

  int64 rank = 11; // @tag(gorm:"type:int;name:rank")
  int64 updated = 12; // @tag(gorm:"autoUpdateTime:nano")
  int64 created = 13; // @tag(gorm:"autoUpdateTime:nano")
  string createdFormatted = 14; // @tag(sql:"-")
  string updatedFormatted = 15; // @tag(sql:"-")

}

export interface PassportMethodEntity {
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag(gorm:"foreignKey:ParentId;references:UniqueId" json:"translations") */
  translations: PassportMethodEntityPolyglot[];
  /** @tag(translate:"true" validate:"required" yaml:"name" ) */
  name?: string | undefined;
  /** @tag( validate:"required" yaml:"type" ) */
  type?: string | undefined;
  /** @tag( validate:"required" yaml:"region" ) */
  region?: string | undefined;
  /** @tag(gorm:"type:int;name:rank") */
  rank: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
  /** @tag(sql:"-") */
  createdFormatted: string;
  /** @tag(sql:"-") */
  updatedFormatted: string;
}

Request Dto/Entity: *passports.PassportMethodEntity

message PassportMethodEntity {
  optional string visibility = 1; // @tag(yaml:"visibility")
  optional string workspaceId = 2; // @tag(yaml:"workspaceId")
  optional string parentId = 3; // @tag(yaml:"parentId")
  string uniqueId = 4; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 5; // @tag(yaml:"userId")
  repeated PassportMethodEntityPolyglot translations = 6; // @tag(gorm:"foreignKey:ParentId;references:UniqueId" json:"translations")
  optional string name = 8; // @tag(translate:"true" validate:"required" yaml:"name" )

  optional string type = 9; // @tag( validate:"required" yaml:"type" )

  optional string region = 10; // @tag( validate:"required" yaml:"region" )

  int64 rank = 11; // @tag(gorm:"type:int;name:rank")
  int64 updated = 12; // @tag(gorm:"autoUpdateTime:nano")
  int64 created = 13; // @tag(gorm:"autoUpdateTime:nano")
  string createdFormatted = 14; // @tag(sql:"-")
  string updatedFormatted = 15; // @tag(sql:"-")

}

export interface PassportMethodEntity {
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag(gorm:"foreignKey:ParentId;references:UniqueId" json:"translations") */
  translations: PassportMethodEntityPolyglot[];
  /** @tag(translate:"true" validate:"required" yaml:"name" ) */
  name?: string | undefined;
  /** @tag( validate:"required" yaml:"type" ) */
  type?: string | undefined;
  /** @tag( validate:"required" yaml:"region" ) */
  region?: string | undefined;
  /** @tag(gorm:"type:int;name:rank") */
  rank: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
  /** @tag(sql:"-") */
  createdFormatted: string;
  /** @tag(sql:"-") */
  updatedFormatted: string;
}

patchPassportMethod

passportMethod

Response Dto/Entity: *passports.PassportMethodEntity

message PassportMethodEntity {
  optional string visibility = 1; // @tag(yaml:"visibility")
  optional string workspaceId = 2; // @tag(yaml:"workspaceId")
  optional string parentId = 3; // @tag(yaml:"parentId")
  string uniqueId = 4; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 5; // @tag(yaml:"userId")
  repeated PassportMethodEntityPolyglot translations = 6; // @tag(gorm:"foreignKey:ParentId;references:UniqueId" json:"translations")
  optional string name = 8; // @tag(translate:"true" validate:"required" yaml:"name" )

  optional string type = 9; // @tag( validate:"required" yaml:"type" )

  optional string region = 10; // @tag( validate:"required" yaml:"region" )

  int64 rank = 11; // @tag(gorm:"type:int;name:rank")
  int64 updated = 12; // @tag(gorm:"autoUpdateTime:nano")
  int64 created = 13; // @tag(gorm:"autoUpdateTime:nano")
  string createdFormatted = 14; // @tag(sql:"-")
  string updatedFormatted = 15; // @tag(sql:"-")

}

export interface PassportMethodEntity {
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag(gorm:"foreignKey:ParentId;references:UniqueId" json:"translations") */
  translations: PassportMethodEntityPolyglot[];
  /** @tag(translate:"true" validate:"required" yaml:"name" ) */
  name?: string | undefined;
  /** @tag( validate:"required" yaml:"type" ) */
  type?: string | undefined;
  /** @tag( validate:"required" yaml:"region" ) */
  region?: string | undefined;
  /** @tag(gorm:"type:int;name:rank") */
  rank: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
  /** @tag(sql:"-") */
  createdFormatted: string;
  /** @tag(sql:"-") */
  updatedFormatted: string;
}

Request Dto/Entity: *passports.PassportMethodEntity

message PassportMethodEntity {
  optional string visibility = 1; // @tag(yaml:"visibility")
  optional string workspaceId = 2; // @tag(yaml:"workspaceId")
  optional string parentId = 3; // @tag(yaml:"parentId")
  string uniqueId = 4; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 5; // @tag(yaml:"userId")
  repeated PassportMethodEntityPolyglot translations = 6; // @tag(gorm:"foreignKey:ParentId;references:UniqueId" json:"translations")
  optional string name = 8; // @tag(translate:"true" validate:"required" yaml:"name" )

  optional string type = 9; // @tag( validate:"required" yaml:"type" )

  optional string region = 10; // @tag( validate:"required" yaml:"region" )

  int64 rank = 11; // @tag(gorm:"type:int;name:rank")
  int64 updated = 12; // @tag(gorm:"autoUpdateTime:nano")
  int64 created = 13; // @tag(gorm:"autoUpdateTime:nano")
  string createdFormatted = 14; // @tag(sql:"-")
  string updatedFormatted = 15; // @tag(sql:"-")

}

export interface PassportMethodEntity {
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag(gorm:"foreignKey:ParentId;references:UniqueId" json:"translations") */
  translations: PassportMethodEntityPolyglot[];
  /** @tag(translate:"true" validate:"required" yaml:"name" ) */
  name?: string | undefined;
  /** @tag( validate:"required" yaml:"type" ) */
  type?: string | undefined;
  /** @tag( validate:"required" yaml:"region" ) */
  region?: string | undefined;
  /** @tag(gorm:"type:int;name:rank") */
  rank: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
  /** @tag(sql:"-") */
  createdFormatted: string;
  /** @tag(sql:"-") */
  updatedFormatted: string;
}

patchPassportMethods

passportMethods

Response Dto/Entity: *core.BulkRecordRequest[passports.PassportMethodEntity]

Request Dto/Entity: *core.BulkRecordRequest[passports.PassportMethodEntity]

deletePassportMethod

passportMethod

Request Dto/Entity: *core.DeleteRequest

Target Entity: *passports.PassportMethodEntity

message PassportMethodEntity {
  optional string visibility = 1; // @tag(yaml:"visibility")
  optional string workspaceId = 2; // @tag(yaml:"workspaceId")
  optional string parentId = 3; // @tag(yaml:"parentId")
  string uniqueId = 4; // @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId")
  optional string userId = 5; // @tag(yaml:"userId")
  repeated PassportMethodEntityPolyglot translations = 6; // @tag(gorm:"foreignKey:ParentId;references:UniqueId" json:"translations")
  optional string name = 8; // @tag(translate:"true" validate:"required" yaml:"name" )

  optional string type = 9; // @tag( validate:"required" yaml:"type" )

  optional string region = 10; // @tag( validate:"required" yaml:"region" )

  int64 rank = 11; // @tag(gorm:"type:int;name:rank")
  int64 updated = 12; // @tag(gorm:"autoUpdateTime:nano")
  int64 created = 13; // @tag(gorm:"autoUpdateTime:nano")
  string createdFormatted = 14; // @tag(sql:"-")
  string updatedFormatted = 15; // @tag(sql:"-")

}

export interface PassportMethodEntity {
  /** @tag(yaml:"visibility") */
  visibility?: string | undefined;
  /** @tag(yaml:"workspaceId") */
  workspaceId?: string | undefined;
  /** @tag(yaml:"parentId") */
  parentId?: string | undefined;
  /** @tag(gorm:"primarykey;uniqueId;unique;not null;size:100;" yaml:"uniqueId") */
  uniqueId: string;
  /** @tag(yaml:"userId") */
  userId?: string | undefined;
  /** @tag(gorm:"foreignKey:ParentId;references:UniqueId" json:"translations") */
  translations: PassportMethodEntityPolyglot[];
  /** @tag(translate:"true" validate:"required" yaml:"name" ) */
  name?: string | undefined;
  /** @tag( validate:"required" yaml:"type" ) */
  type?: string | undefined;
  /** @tag( validate:"required" yaml:"region" ) */
  region?: string | undefined;
  /** @tag(gorm:"type:int;name:rank") */
  rank: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  updated: number;
  /** @tag(gorm:"autoUpdateTime:nano") */
  created: number;
  /** @tag(sql:"-") */
  createdFormatted: string;
  /** @tag(sql:"-") */
  updatedFormatted: string;
}

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 31 it's main activity I do.