Skip to content

A continuation of HomeBox the inventory and organization system built for the Home User

106 KB
Raw Blame
basePath: /api
definitions:
  attachment.Type:
    enum:
    - attachment
    - photo
    - manual
    - warranty
    - attachment
    - receipt
    - thumbnail
    type: string
    x-enum-varnames:
    - DefaultType
    - TypePhoto
    - TypeManual
    - TypeWarranty
    - TypeAttachment
    - TypeReceipt
    - TypeThumbnail
  authroles.Role:
    enum:
    - user
    - admin
    - user
    - attachments
    type: string
    x-enum-varnames:
    - DefaultRole
    - RoleAdmin
    - RoleUser
    - RoleAttachments
  currencies.Currency:
    properties:
      code:
        type: string
      decimals:
        type: integer
      local:
        type: string
      name:
        type: string
      symbol:
        type: string
    type: object
  ent.APIKey:
    properties:
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.APIKeyEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the APIKeyQuery when eager-loading is set.
      expires_at:
        description: ExpiresAt holds the value of the "expires_at" field.
        type: string
      id:
        description: ID of the ent.
        type: string
      last_used_at:
        description: LastUsedAt holds the value of the "last_used_at" field.
        type: string
      name:
        description: Name holds the value of the "name" field.
        type: string
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
      user_id:
        description: UserID holds the value of the "user_id" field.
        type: string
    type: object
  ent.APIKeyEdges:
    properties:
      user:
        allOf:
        - $ref: '#/definitions/ent.User'
        description: User holds the value of the user edge.
    type: object
  ent.Attachment:
    properties:
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.AttachmentEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the AttachmentQuery when eager-loading is set.
      id:
        description: ID of the ent.
        type: string
      mime_type:
        description: MimeType holds the value of the "mime_type" field.
        type: string
      path:
        description: Path holds the value of the "path" field.
        type: string
      primary:
        description: Primary holds the value of the "primary" field.
        type: boolean
      title:
        description: Title holds the value of the "title" field.
        type: string
      type:
        allOf:
        - $ref: '#/definitions/attachment.Type'
        description: Type holds the value of the "type" field.
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
    type: object
  ent.AttachmentEdges:
    properties:
      entity:
        allOf:
        - $ref: '#/definitions/ent.Entity'
        description: Entity holds the value of the entity edge.
      thumbnail:
        allOf:
        - $ref: '#/definitions/ent.Attachment'
        description: Thumbnail holds the value of the thumbnail edge.
    type: object
  ent.AuthRoles:
    properties:
      edges:
        allOf:
        - $ref: '#/definitions/ent.AuthRolesEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the AuthRolesQuery when eager-loading is set.
      id:
        description: ID of the ent.
        type: integer
      role:
        allOf:
        - $ref: '#/definitions/authroles.Role'
        description: Role holds the value of the "role" field.
    type: object
  ent.AuthRolesEdges:
    properties:
      token:
        allOf:
        - $ref: '#/definitions/ent.AuthTokens'
        description: Token holds the value of the token edge.
    type: object
  ent.AuthTokens:
    properties:
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.AuthTokensEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the AuthTokensQuery when eager-loading is set.
      expires_at:
        description: ExpiresAt holds the value of the "expires_at" field.
        type: string
      id:
        description: ID of the ent.
        type: string
      token:
        description: Token holds the value of the "token" field.
        items:
          type: integer
        type: array
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
    type: object
  ent.AuthTokensEdges:
    properties:
      roles:
        allOf:
        - $ref: '#/definitions/ent.AuthRoles'
        description: Roles holds the value of the roles edge.
      user:
        allOf:
        - $ref: '#/definitions/ent.User'
        description: User holds the value of the user edge.
    type: object
  ent.Entity:
    properties:
      archived:
        description: Archived holds the value of the "archived" field.
        type: boolean
      asset_id:
        description: AssetID holds the value of the "asset_id" field.
        type: integer
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      description:
        description: Description holds the value of the "description" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.EntityEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the EntityQuery when eager-loading is set.
      id:
        description: ID of the ent.
        type: string
      import_ref:
        description: ImportRef holds the value of the "import_ref" field.
        type: string
      insured:
        description: Insured holds the value of the "insured" field.
        type: boolean
      lifetime_warranty:
        description: LifetimeWarranty holds the value of the "lifetime_warranty" field.
        type: boolean
      manufacturer:
        description: Manufacturer holds the value of the "manufacturer" field.
        type: string
      model_number:
        description: ModelNumber holds the value of the "model_number" field.
        type: string
      name:
        description: Name holds the value of the "name" field.
        type: string
      notes:
        description: Notes holds the value of the "notes" field.
        type: string
      purchase_date:
        description: PurchaseDate holds the value of the "purchase_date" field.
        type: string
      purchase_from:
        description: PurchaseFrom holds the value of the "purchase_from" field.
        type: string
      purchase_price:
        description: PurchasePrice holds the value of the "purchase_price" field.
        type: number
      quantity:
        description: Quantity holds the value of the "quantity" field.
        type: number
      serial_number:
        description: SerialNumber holds the value of the "serial_number" field.
        type: string
      sold_date:
        description: SoldDate holds the value of the "sold_date" field.
        type: string
      sold_notes:
        description: SoldNotes holds the value of the "sold_notes" field.
        type: string
      sold_price:
        description: SoldPrice holds the value of the "sold_price" field.
        type: number
      sold_to:
        description: SoldTo holds the value of the "sold_to" field.
        type: string
      sync_child_entity_locations:
        description: SyncChildEntityLocations holds the value of the "sync_child_entity_locations"
          field.
        type: boolean
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
      warranty_details:
        description: WarrantyDetails holds the value of the "warranty_details" field.
        type: string
      warranty_expires:
        description: WarrantyExpires holds the value of the "warranty_expires" field.
        type: string
    type: object
  ent.EntityEdges:
    properties:
      attachments:
        description: Attachments holds the value of the attachments edge.
        items:
          $ref: '#/definitions/ent.Attachment'
        type: array
      children:
        description: Children holds the value of the children edge.
        items:
          $ref: '#/definitions/ent.Entity'
        type: array
      entity_type:
        allOf:
        - $ref: '#/definitions/ent.EntityType'
        description: EntityType holds the value of the entity_type edge.
      fields:
        description: Fields holds the value of the fields edge.
        items:
          $ref: '#/definitions/ent.EntityField'
        type: array
      group:
        allOf:
        - $ref: '#/definitions/ent.Group'
        description: Group holds the value of the group edge.
      location:
        allOf:
        - $ref: '#/definitions/ent.Entity'
        description: Location holds the value of the location edge.
      location_entities:
        description: LocationEntities holds the value of the location_entities edge.
        items:
          $ref: '#/definitions/ent.Entity'
        type: array
      maintenance_entries:
        description: MaintenanceEntries holds the value of the maintenance_entries
          edge.
        items:
          $ref: '#/definitions/ent.MaintenanceEntry'
        type: array
      parent:
        allOf:
        - $ref: '#/definitions/ent.Entity'
        description: Parent holds the value of the parent edge.
      tag:
        description: Tag holds the value of the tag edge.
        items:
          $ref: '#/definitions/ent.Tag'
        type: array
    type: object
  ent.EntityField:
    properties:
      boolean_value:
        description: BooleanValue holds the value of the "boolean_value" field.
        type: boolean
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      description:
        description: Description holds the value of the "description" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.EntityFieldEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the EntityFieldQuery when eager-loading is set.
      id:
        description: ID of the ent.
        type: string
      name:
        description: Name holds the value of the "name" field.
        type: string
      number_value:
        description: NumberValue holds the value of the "number_value" field.
        type: integer
      text_value:
        description: TextValue holds the value of the "text_value" field.
        type: string
      time_value:
        description: TimeValue holds the value of the "time_value" field.
        type: string
      type:
        allOf:
        - $ref: '#/definitions/entityfield.Type'
        description: Type holds the value of the "type" field.
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
    type: object
  ent.EntityFieldEdges:
    properties:
      entity:
        allOf:
        - $ref: '#/definitions/ent.Entity'
        description: Entity holds the value of the entity edge.
    type: object
  ent.EntityTemplate:
    properties:
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      default_description:
        description: Default description for items created from this template
        type: string
      default_insured:
        description: DefaultInsured holds the value of the "default_insured" field.
        type: boolean
      default_lifetime_warranty:
        description: DefaultLifetimeWarranty holds the value of the "default_lifetime_warranty"
          field.
        type: boolean
      default_manufacturer:
        description: DefaultManufacturer holds the value of the "default_manufacturer"
          field.
        type: string
      default_model_number:
        description: Default model number for items created from this template
        type: string
      default_name:
        description: Default name template for items (can use placeholders)
        type: string
      default_quantity:
        description: DefaultQuantity holds the value of the "default_quantity" field.
        type: number
      default_tag_ids:
        description: Default tag IDs for items created from this template
        items:
          type: string
        type: array
      default_warranty_details:
        description: DefaultWarrantyDetails holds the value of the "default_warranty_details"
          field.
        type: string
      description:
        description: Description holds the value of the "description" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.EntityTemplateEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the EntityTemplateQuery when eager-loading is set.
      id:
        description: ID of the ent.
        type: string
      include_purchase_fields:
        description: Whether to include purchase fields in items created from this
          template
        type: boolean
      include_sold_fields:
        description: Whether to include sold fields in items created from this template
        type: boolean
      include_warranty_fields:
        description: Whether to include warranty fields in items created from this
          template
        type: boolean
      name:
        description: Name holds the value of the "name" field.
        type: string
      notes:
        description: Notes holds the value of the "notes" field.
        type: string
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
    type: object
  ent.EntityTemplateEdges:
    properties:
      fields:
        description: Fields holds the value of the fields edge.
        items:
          $ref: '#/definitions/ent.TemplateField'
        type: array
      group:
        allOf:
        - $ref: '#/definitions/ent.Group'
        description: Group holds the value of the group edge.
      location:
        allOf:
        - $ref: '#/definitions/ent.Entity'
        description: Location holds the value of the location edge.
    type: object
  ent.EntityType:
    properties:
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      description:
        description: Description holds the value of the "description" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.EntityTypeEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the EntityTypeQuery when eager-loading is set.
      icon:
        description: Icon holds the value of the "icon" field.
        type: string
      id:
        description: ID of the ent.
        type: string
      is_location:
        description: IsLocation holds the value of the "is_location" field.
        type: boolean
      name:
        description: Name holds the value of the "name" field.
        type: string
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
    type: object
  ent.EntityTypeEdges:
    properties:
      default_template:
        allOf:
        - $ref: '#/definitions/ent.EntityTemplate'
        description: DefaultTemplate holds the value of the default_template edge.
      entities:
        description: Entities holds the value of the entities edge.
        items:
          $ref: '#/definitions/ent.Entity'
        type: array
      group:
        allOf:
        - $ref: '#/definitions/ent.Group'
        description: Group holds the value of the group edge.
    type: object
  ent.Export:
    properties:
      artifact_path:
        description: ArtifactPath holds the value of the "artifact_path" field.
        type: string
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.ExportEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the ExportQuery when eager-loading is set.
      error:
        description: Error holds the value of the "error" field.
        type: string
      group_id:
        description: GroupID holds the value of the "group_id" field.
        type: string
      id:
        description: ID of the ent.
        type: string
      kind:
        allOf:
        - $ref: '#/definitions/export.Kind'
        description: Kind holds the value of the "kind" field.
      progress:
        description: Progress holds the value of the "progress" field.
        type: integer
      size_bytes:
        description: SizeBytes holds the value of the "size_bytes" field.
        type: integer
      status:
        allOf:
        - $ref: '#/definitions/export.Status'
        description: Status holds the value of the "status" field.
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
    type: object
  ent.ExportEdges:
    properties:
      group:
        allOf:
        - $ref: '#/definitions/ent.Group'
        description: Group holds the value of the group edge.
    type: object
  ent.Group:
    properties:
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      currency:
        description: Currency holds the value of the "currency" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.GroupEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the GroupQuery when eager-loading is set.
      id:
        description: ID of the ent.
        type: string
      name:
        description: Name holds the value of the "name" field.
        type: string
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
    type: object
  ent.GroupEdges:
    properties:
      entities:
        description: Entities holds the value of the entities edge.
        items:
          $ref: '#/definitions/ent.Entity'
        type: array
      entity_templates:
        description: EntityTemplates holds the value of the entity_templates edge.
        items:
          $ref: '#/definitions/ent.EntityTemplate'
        type: array
      entity_types:
        description: EntityTypes holds the value of the entity_types edge.
        items:
          $ref: '#/definitions/ent.EntityType'
        type: array
      exports:
        description: Exports holds the value of the exports edge.
        items:
          $ref: '#/definitions/ent.Export'
        type: array
      invitation_tokens:
        description: InvitationTokens holds the value of the invitation_tokens edge.
        items:
          $ref: '#/definitions/ent.GroupInvitationToken'
        type: array
      notifiers:
        description: Notifiers holds the value of the notifiers edge.
        items:
          $ref: '#/definitions/ent.Notifier'
        type: array
      tags:
        description: Tags holds the value of the tags edge.
        items:
          $ref: '#/definitions/ent.Tag'
        type: array
      user_groups:
        description: UserGroups holds the value of the user_groups edge.
        items:
          $ref: '#/definitions/ent.UserGroup'
        type: array
      users:
        description: Users holds the value of the users edge.
        items:
          $ref: '#/definitions/ent.User'
        type: array
    type: object
  ent.GroupInvitationToken:
    properties:
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.GroupInvitationTokenEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the GroupInvitationTokenQuery when eager-loading is set.
      expires_at:
        description: ExpiresAt holds the value of the "expires_at" field.
        type: string
      id:
        description: ID of the ent.
        type: string
      token:
        description: Token holds the value of the "token" field.
        items:
          type: integer
        type: array
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
      uses:
        description: Uses holds the value of the "uses" field.
        type: integer
    type: object
  ent.GroupInvitationTokenEdges:
    properties:
      group:
        allOf:
        - $ref: '#/definitions/ent.Group'
        description: Group holds the value of the group edge.
    type: object
  ent.MaintenanceEntry:
    properties:
      cost:
        description: Cost holds the value of the "cost" field.
        type: number
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      date:
        description: Date holds the value of the "date" field.
        type: string
      description:
        description: Description holds the value of the "description" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.MaintenanceEntryEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the MaintenanceEntryQuery when eager-loading is set.
      entity_id:
        description: EntityID holds the value of the "entity_id" field.
        type: string
      id:
        description: ID of the ent.
        type: string
      name:
        description: Name holds the value of the "name" field.
        type: string
      scheduled_date:
        description: ScheduledDate holds the value of the "scheduled_date" field.
        type: string
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
    type: object
  ent.MaintenanceEntryEdges:
    properties:
      entity:
        allOf:
        - $ref: '#/definitions/ent.Entity'
        description: Entity holds the value of the entity edge.
    type: object
  ent.Notifier:
    properties:
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.NotifierEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the NotifierQuery when eager-loading is set.
      group_id:
        description: GroupID holds the value of the "group_id" field.
        type: string
      id:
        description: ID of the ent.
        type: string
      is_active:
        description: IsActive holds the value of the "is_active" field.
        type: boolean
      name:
        description: Name holds the value of the "name" field.
        type: string
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
      user_id:
        description: UserID holds the value of the "user_id" field.
        type: string
    type: object
  ent.NotifierEdges:
    properties:
      group:
        allOf:
        - $ref: '#/definitions/ent.Group'
        description: Group holds the value of the group edge.
      user:
        allOf:
        - $ref: '#/definitions/ent.User'
        description: User holds the value of the user edge.
    type: object
  ent.PasswordResetTokens:
    properties:
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.PasswordResetTokensEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the PasswordResetTokensQuery when eager-loading is set.
      expires_at:
        description: ExpiresAt holds the value of the "expires_at" field.
        type: string
      id:
        description: ID of the ent.
        type: string
      token:
        description: Token holds the value of the "token" field.
        items:
          type: integer
        type: array
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
      used_at:
        description: UsedAt holds the value of the "used_at" field.
        type: string
      user_id:
        description: UserID holds the value of the "user_id" field.
        type: string
    type: object
  ent.PasswordResetTokensEdges:
    properties:
      user:
        allOf:
        - $ref: '#/definitions/ent.User'
        description: User holds the value of the user edge.
    type: object
  ent.Tag:
    properties:
      color:
        description: Color holds the value of the "color" field.
        type: string
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      description:
        description: Description holds the value of the "description" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.TagEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the TagQuery when eager-loading is set.
      icon:
        description: Icon holds the value of the "icon" field.
        type: string
      id:
        description: ID of the ent.
        type: string
      name:
        description: Name holds the value of the "name" field.
        type: string
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
    type: object
  ent.TagEdges:
    properties:
      children:
        description: Children holds the value of the children edge.
        items:
          $ref: '#/definitions/ent.Tag'
        type: array
      entities:
        description: Entities holds the value of the entities edge.
        items:
          $ref: '#/definitions/ent.Entity'
        type: array
      group:
        allOf:
        - $ref: '#/definitions/ent.Group'
        description: Group holds the value of the group edge.
      parent:
        allOf:
        - $ref: '#/definitions/ent.Tag'
        description: Parent holds the value of the parent edge.
    type: object
  ent.TemplateField:
    properties:
      boolean_value:
        description: BooleanValue holds the value of the "boolean_value" field.
        type: boolean
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      description:
        description: Description holds the value of the "description" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.TemplateFieldEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the TemplateFieldQuery when eager-loading is set.
      id:
        description: ID of the ent.
        type: string
      name:
        description: Name holds the value of the "name" field.
        type: string
      number_value:
        description: NumberValue holds the value of the "number_value" field.
        type: integer
      text_value:
        description: TextValue holds the value of the "text_value" field.
        type: string
      time_value:
        description: TimeValue holds the value of the "time_value" field.
        type: string
      type:
        allOf:
        - $ref: '#/definitions/templatefield.Type'
        description: Type holds the value of the "type" field.
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
    type: object
  ent.TemplateFieldEdges:
    properties:
      entity_template:
        allOf:
        - $ref: '#/definitions/ent.EntityTemplate'
        description: EntityTemplate holds the value of the entity_template edge.
    type: object
  ent.User:
    properties:
      activated_on:
        description: ActivatedOn holds the value of the "activated_on" field.
        type: string
      created_at:
        description: CreatedAt holds the value of the "created_at" field.
        type: string
      default_group_id:
        description: DefaultGroupID holds the value of the "default_group_id" field.
        type: string
      edges:
        allOf:
        - $ref: '#/definitions/ent.UserEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the UserQuery when eager-loading is set.
      email:
        description: Email holds the value of the "email" field.
        type: string
      id:
        description: ID of the ent.
        type: string
      is_superuser:
        description: IsSuperuser holds the value of the "is_superuser" field.
        type: boolean
      name:
        description: Name holds the value of the "name" field.
        type: string
      oidc_issuer:
        description: OidcIssuer holds the value of the "oidc_issuer" field.
        type: string
      oidc_subject:
        description: OidcSubject holds the value of the "oidc_subject" field.
        type: string
      settings:
        additionalProperties: true
        description: Settings holds the value of the "settings" field.
        type: object
      superuser:
        description: Superuser holds the value of the "superuser" field.
        type: boolean
      updated_at:
        description: UpdatedAt holds the value of the "updated_at" field.
        type: string
    type: object
  ent.UserEdges:
    properties:
      api_keys:
        description: APIKeys holds the value of the api_keys edge.
        items:
          $ref: '#/definitions/ent.APIKey'
        type: array
      auth_tokens:
        description: AuthTokens holds the value of the auth_tokens edge.
        items:
          $ref: '#/definitions/ent.AuthTokens'
        type: array
      groups:
        description: Groups holds the value of the groups edge.
        items:
          $ref: '#/definitions/ent.Group'
        type: array
      notifiers:
        description: Notifiers holds the value of the notifiers edge.
        items:
          $ref: '#/definitions/ent.Notifier'
        type: array
      password_reset_tokens:
        description: PasswordResetTokens holds the value of the password_reset_tokens
          edge.
        items:
          $ref: '#/definitions/ent.PasswordResetTokens'
        type: array
      user_groups:
        description: UserGroups holds the value of the user_groups edge.
        items:
          $ref: '#/definitions/ent.UserGroup'
        type: array
    type: object
  ent.UserGroup:
    properties:
      edges:
        allOf:
        - $ref: '#/definitions/ent.UserGroupEdges'
        description: |-
          Edges holds the relations/edges for other nodes in the graph.
          The values are being populated by the UserGroupQuery when eager-loading is set.
      group_id:
        description: GroupID holds the value of the "group_id" field.
        type: string
      role:
        allOf:
        - $ref: '#/definitions/usergroup.Role'
        description: Role holds the value of the "role" field.
      user_id:
        description: UserID holds the value of the "user_id" field.
        type: string
    type: object
  ent.UserGroupEdges:
    properties:
      group:
        allOf:
        - $ref: '#/definitions/ent.Group'
        description: Group holds the value of the group edge.
      user:
        allOf:
        - $ref: '#/definitions/ent.User'
        description: User holds the value of the user edge.
    type: object
  entityfield.Type:
    enum:
    - text
    - number
    - boolean
    - time
    type: string
    x-enum-varnames:
    - TypeText
    - TypeNumber
    - TypeBoolean
    - TypeTime
  export.Kind:
    enum:
    - export
    - export
    - import
    type: string
    x-enum-varnames:
    - DefaultKind
    - KindExport
    - KindImport
  export.Status:
    enum:
    - pending
    - pending
    - running
    - completed
    - failed
    type: string
    x-enum-varnames:
    - DefaultStatus
    - StatusPending
    - StatusRunning
    - StatusCompleted
    - StatusFailed
  repo.APIKeyCreate:
    properties:
      expiresAt:
        type: string
        x-nullable: true
      name:
        maxLength: 255
        minLength: 1
        type: string
    required:
    - name
    type: object
  repo.APIKeyCreatedOut:
    properties:
      createdAt:
        type: string
      expiresAt:
        type: string
        x-nullable: true
      id:
        type: string
      lastUsedAt:
        type: string
        x-nullable: true
      name:
        type: string
      token:
        type: string
      userId:
        type: string
    type: object
  repo.APIKeyOut:
    properties:
      createdAt:
        type: string
      expiresAt:
        type: string
        x-nullable: true
      id:
        type: string
      lastUsedAt:
        type: string
        x-nullable: true
      name:
        type: string
      userId:
        type: string
    type: object
  repo.BarcodeProduct:
    properties:
      barcode:
        type: string
      imageBase64:
        type: string
      imageURL:
        type: string
      item:
        $ref: '#/definitions/repo.EntityCreate'
      manufacturer:
        type: string
      modelNumber:
        description: Identifications
        type: string
      notes:
        description: Extras
        type: string
      search_engine_name:
        type: string
    type: object
  repo.DuplicateOptions:
    properties:
      copyAttachments:
        type: boolean
      copyCustomFields:
        type: boolean
      copyMaintenance:
        type: boolean
      copyPrefix:
        type: string
    type: object
  repo.EntityCreate:
    properties:
      description:
        maxLength: 1000
        type: string
      entityTypeId:
        type: string
      locationId:
        description: Only needed when ParentID is another item and this lives elsewhere
          (#1688).
        type: string
        x-nullable: true
        x-omitempty: true
      manufacturer:
        maxLength: 255
        type: string
        x-nullable: true
        x-omitempty: true
      modelNumber:
        description: |-
          Identifications — optional at create time; populated e.g. by the
          barcode product-search import flow (#1578).
        maxLength: 255
        type: string
        x-nullable: true
        x-omitempty: true
      name:
        maxLength: 255
        minLength: 1
        type: string
      parentId:
        type: string
        x-nullable: true
      quantity:
        type: number
      tagIds:
        description: Edges
        items:
          type: string
        type: array
    required:
    - name
    type: object
  repo.EntityFieldData:
    properties:
      booleanValue:
        type: boolean
      id:
        type: string
      name:
        type: string
      numberValue:
        type: integer
      textValue:
        type: string
      type:
        type: string
    type: object
  repo.EntityListResult:
    properties:
      items:
        items:
          $ref: '#/definitions/repo.EntitySummary'
        type: array
      page:
        type: integer
      pageSize:
        type: integer
      total:
        type: integer
      totalPrice:
        type: number
    type: object
  repo.EntityOut:
    properties:
      archived:
        type: boolean
      assetId:
        example: "0"
        type: string
      attachments:
        items:
          $ref: '#/definitions/repo.ItemAttachment'
        type: array
      children:
        description: Container-specific fields (for entities whose entity_type.is_location
          = true)
        items:
          $ref: '#/definitions/repo.EntitySummary'
        type: array
      createdAt:
        type: string
      description:
        type: string
      entityType:
        allOf:
        - $ref: '#/definitions/repo.EntityTypeSummary'
        x-nullable: true
        x-omitempty: true
      fields:
        items:
          $ref: '#/definitions/repo.EntityFieldData'
        type: array
      id:
        type: string
      imageId:
        type: string
        x-nullable: true
        x-omitempty: true
      insured:
        type: boolean
      itemCount:
        description: Container-specific (populated when querying locations)
        type: number
      lifetimeWarranty:
        description: Warranty
        type: boolean
      location:
        allOf:
        - $ref: '#/definitions/repo.EntitySummary'
        description: |-
          Location is resolved: this entity's own location, else the nearest
          location ancestor. Read-only — write via LocationID.
        x-nullable: true
        x-omitempty: true
      locationId:
        description: |-
          LocationID is set only when this entity has its own location, nil when
          inherited. Same name as the EntityUpdate field so a GET/PUT round trip
          doesn't pin an inherited location or drop an explicit one.
        type: string
        x-nullable: true
        x-omitempty: true
      manufacturer:
        type: string
      modelNumber:
        type: string
      name:
        type: string
      notes:
        description: Extras
        type: string
      parent:
        allOf:
        - $ref: '#/definitions/repo.EntitySummary'
        description: Edges
        x-nullable: true
        x-omitempty: true
      purchaseDate:
        description: Purchase
        type: string
      purchaseFrom:
        type: string
      purchasePrice:
        type: number
      quantity:
        type: number
      serialNumber:
        type: string
      soldDate:
        description: Sold
        type: string
      soldNotes:
        type: string
      soldPrice:
        type: number
      soldTo:
        type: string
      syncChildEntityLocations:
        type: boolean
      tags:
        items:
          $ref: '#/definitions/repo.TagSummary'
        type: array
      thumbnailId:
        type: string
        x-nullable: true
        x-omitempty: true
      totalPrice:
        type: number
      updatedAt:
        type: string
      warrantyDetails:
        type: string
      warrantyExpires:
        type: string
    type: object
  repo.EntityPatch:
    properties:
      entityTypeId:
        type: string
        x-nullable: true
        x-omitempty: true
      id:
        type: string
      locationId:
        type: string
        x-nullable: true
        x-omitempty: true
      parentId:
        type: string
        x-nullable: true
        x-omitempty: true
      quantity:
        type: number
        x-nullable: true
        x-omitempty: true
      tagIds:
        items:
          type: string
        type: array
        x-nullable: true
        x-omitempty: true
    type: object
  repo.EntityPath:
    properties:
      id:
        type: string
      name:
        type: string
      type:
        $ref: '#/definitions/repo.EntityPathType'
    type: object
  repo.EntityPathType:
    enum:
    - location
    - item
    type: string
    x-enum-varnames:
    - EntityPathTypeLocation
    - EntityPathTypeItem
  repo.EntitySummary:
    properties:
      archived:
        type: boolean
      assetId:
        example: "0"
        type: string
      createdAt:
        type: string
      description:
        type: string
      entityType:
        allOf:
        - $ref: '#/definitions/repo.EntityTypeSummary'
        x-nullable: true
        x-omitempty: true
      id:
        type: string
      imageId:
        type: string
        x-nullable: true
        x-omitempty: true
      insured:
        type: boolean
      itemCount:
        description: Container-specific (populated when querying locations)
        type: number
      name:
        type: string
      parent:
        allOf:
        - $ref: '#/definitions/repo.EntitySummary'
        description: Edges
        x-nullable: true
        x-omitempty: true
      purchasePrice:
        type: number
      quantity:
        type: number
      soldDate:
        description: Sale details
        type: string
      tags:
        items:
          $ref: '#/definitions/repo.TagSummary'
        type: array
      thumbnailId:
        type: string
        x-nullable: true
        x-omitempty: true
      updatedAt:
        type: string
    type: object
  repo.EntityTemplateCreate:
    properties:
      defaultDescription:
        maxLength: 1000
        type: string
        x-nullable: true
      defaultInsured:
        type: boolean
      defaultLifetimeWarranty:
        type: boolean
      defaultLocationId:
        description: Default location and tags
        type: string
        x-nullable: true
      defaultManufacturer:
        maxLength: 255
        type: string
        x-nullable: true
      defaultModelNumber:
        maxLength: 255
        type: string
        x-nullable: true
      defaultName:
        maxLength: 255
        type: string
        x-nullable: true
      defaultQuantity:
        description: Default values for entities
        type: number
        x-nullable: true
      defaultTagIds:
        items:
          type: string
        type: array
        x-nullable: true
      defaultWarrantyDetails:
        maxLength: 1000
        type: string
        x-nullable: true
      description:
        maxLength: 1000
        type: string
      fields:
        description: Custom fields
        items:
          $ref: '#/definitions/repo.TemplateField'
        type: array
      includePurchaseFields:
        type: boolean
      includeSoldFields:
        type: boolean
      includeWarrantyFields:
        description: Metadata flags
        type: boolean
      name:
        maxLength: 255
        minLength: 1
        type: string
      notes:
        maxLength: 1000
        type: string
    required:
    - name
    type: object
  repo.EntityTemplateOut:
    properties:
      createdAt:
        type: string
      defaultDescription:
        type: string
      defaultInsured:
        type: boolean
      defaultLifetimeWarranty:
        type: boolean
      defaultLocation:
        allOf:
        - $ref: '#/definitions/repo.TemplateLocationSummary'
        description: Default location and tags
      defaultManufacturer:
        type: string
      defaultModelNumber:
        type: string
      defaultName:
        type: string
      defaultQuantity:
        description: Default values for entities
        type: number
      defaultTags:
        items:
          $ref: '#/definitions/repo.TemplateTagSummary'
        type: array
      defaultWarrantyDetails:
        type: string
      description:
        type: string
      fields:
        description: Custom fields
        items:
          $ref: '#/definitions/repo.TemplateField'
        type: array
      id:
        type: string
      includePurchaseFields:
        type: boolean
      includeSoldFields:
        type: boolean
      includeWarrantyFields:
        description: Metadata flags
        type: boolean
      name:
        type: string
      notes:
        type: string
      updatedAt:
        type: string
    type: object
  repo.EntityTemplateSummary:
    properties:
      createdAt:
        type: string
      description:
        type: string
      id:
        type: string
      name:
        type: string
      updatedAt:
        type: string
    type: object
  repo.EntityTemplateUpdate:
    properties:
      defaultDescription:
        maxLength: 1000
        type: string
        x-nullable: true
      defaultInsured:
        type: boolean
      defaultLifetimeWarranty:
        type: boolean
      defaultLocationId:
        description: Default location and tags
        type: string
        x-nullable: true
      defaultManufacturer:
        maxLength: 255
        type: string
        x-nullable: true
      defaultModelNumber:
        maxLength: 255
        type: string
        x-nullable: true
      defaultName:
        maxLength: 255
        type: string
        x-nullable: true
      defaultQuantity:
        description: Default values for entities
        type: number
        x-nullable: true
      defaultTagIds:
        items:
          type: string
        type: array
        x-nullable: true
      defaultWarrantyDetails:
        maxLength: 1000
        type: string
        x-nullable: true
      description:
        maxLength: 1000
        type: string
      fields:
        description: Custom fields
        items:
          $ref: '#/definitions/repo.TemplateField'
        type: array
      id:
        type: string
      includePurchaseFields:
        type: boolean
      includeSoldFields:
        type: boolean
      includeWarrantyFields:
        description: Metadata flags
        type: boolean
      name:
        maxLength: 255
        minLength: 1
        type: string
      notes:
        maxLength: 1000
        type: string
    required:
    - name
    type: object
  repo.EntityTypeCreate:
    properties:
      defaultTemplateId:
        type: string
      icon:
        type: string
      isLocation:
        type: boolean
      name:
        type: string
    type: object
  repo.EntityTypeSummary:
    properties:
      createdAt:
        type: string
      defaultTemplate:
        $ref: '#/definitions/repo.EntityTemplateSummary'
      defaultTemplateId:
        type: string
      description:
        type: string
      icon:
        type: string
      id:
        type: string
      isLocation:
        type: boolean
      name:
        type: string
      updatedAt:
        type: string
    type: object
  repo.EntityTypeUpdate:
    properties:
      defaultTemplateId:
        type: string
      icon:
        type: string
      id:
        type: string
      isLocation:
        type: boolean
      name:
        type: string
    type: object
  repo.EntityUpdate:
    properties:
      archived:
        type: boolean
      assetId:
        type: string
      description:
        maxLength: 1000
        type: string
      entityTypeId:
        type: string
      fields:
        items:
          $ref: '#/definitions/repo.EntityFieldData'
        type: array
      id:
        type: string
      insured:
        type: boolean
      lifetimeWarranty:
        description: Warranty
        type: boolean
      locationId:
        description: |-
          Only needed when ParentID is another item and this lives elsewhere (#1688).
          Otherwise ParentID carries the location. See resolveLocationOverride.
        type: string
        x-nullable: true
        x-omitempty: true
      manufacturer:
        type: string
      modelNumber:
        type: string
      name:
        maxLength: 255
        minLength: 1
        type: string
      notes:
        description: Extras
        type: string
      parentId:
        type: string
        x-nullable: true
        x-omitempty: true
      purchaseDate:
        description: Purchase
        type: string
      purchaseFrom:
        maxLength: 255
        type: string
      purchasePrice:
        type: number
        x-nullable: true
        x-omitempty: true
      quantity:
        type: number
      serialNumber:
        description: Identifications
        type: string
      soldDate:
        description: Sold
        type: string
      soldNotes:
        type: string
      soldPrice:
        type: number
        x-nullable: true
        x-omitempty: true
      soldTo:
        maxLength: 255
        type: string
      syncChildEntityLocations:
        type: boolean
      tagIds:
        description: Edges
        items:
          type: string
        type: array
      warrantyDetails:
        type: string
      warrantyExpires:
        type: string
    required:
    - name
    type: object
  repo.ExportOut:
    properties:
      artifactPath:
        type: string
      createdAt:
        type: string
      error:
        type: string
      groupId:
        type: string
      id:
        type: string
      kind:
        description: |-
          Kind is "export" for server-produced backup artifacts, "import" for
          user-uploaded restore zips. The lifecycle fields below behave the
          same for both.
        type: string
      progress:
        type: integer
      sizeBytes:
        type: integer
      status:
        type: string
      updatedAt:
        type: string
    type: object
  repo.Group:
    properties:
      createdAt:
        type: string
      currency:
        type: string
      id:
        type: string
      name:
        type: string
      updatedAt:
        type: string
    type: object
  repo.GroupInvitation:
    properties:
      expiresAt:
        type: string
      group:
        $ref: '#/definitions/repo.Group'
      id:
        type: string
      uses:
        type: integer
    type: object
  repo.GroupStatistics:
    properties:
      totalItemPrice:
        type: number
      totalItems:
        type: integer
      totalLocations:
        type: integer
      totalTags:
        type: integer
      totalUsers:
        type: integer
      totalWithWarranty:
        type: integer
    type: object
  repo.GroupUpdate:
    properties:
      currency:
        type: string
      name:
        type: string
    type: object
  repo.ItemAttachment:
    properties:
      createdAt:
        type: string
      id:
        type: string
      mimeType:
        type: string
      path:
        type: string
      primary:
        type: boolean
      thumbnail:
        $ref: '#/definitions/ent.Attachment'
      title:
        type: string
      type:
        type: string
      updatedAt:
        type: string
    type: object
  repo.ItemAttachmentUpdate:
    properties:
      primary:
        type: boolean
      title:
        type: string
      type:
        type: string
    type: object
  repo.MaintenanceEntry:
    properties:
      completedDate:
        type: string
      cost:
        example: "0"
        type: string
      description:
        type: string
      id:
        type: string
      name:
        type: string
      scheduledDate:
        type: string
    type: object
  repo.MaintenanceEntryCreate:
    properties:
      completedDate:
        type: string
      cost:
        example: "0"
        type: string
      description:
        type: string
      name:
        type: string
      scheduledDate:
        type: string
    required:
    - name
    type: object
  repo.MaintenanceEntryUpdate:
    properties:
      completedDate:
        type: string
      cost:
        example: "0"
        type: string
      description:
        type: string
      name:
        type: string
      scheduledDate:
        type: string
    type: object
  repo.MaintenanceEntryWithDetails:
    properties:
      completedDate:
        type: string
      cost:
        example: "0"
        type: string
      description:
        type: string
      id:
        type: string
      itemID:
        type: string
      itemName:
        type: string
      name:
        type: string
      scheduledDate:
        type: string
    type: object
  repo.MaintenanceFilterStatus:
    enum:
    - scheduled
    - completed
    - both
    type: string
    x-enum-varnames:
    - MaintenanceFilterStatusScheduled
    - MaintenanceFilterStatusCompleted
    - MaintenanceFilterStatusBoth
  repo.NotifierCreate:
    properties:
      isActive:
        type: boolean
      name:
        maxLength: 255
        minLength: 1
        type: string
      url:
        type: string
    required:
    - name
    - url
    type: object
  repo.NotifierOut:
    properties:
      createdAt:
        type: string
      groupId:
        type: string
      id:
        type: string
      isActive:
        type: boolean
      name:
        type: string
      updatedAt:
        type: string
      url:
        type: string
      userId:
        type: string
    type: object
  repo.NotifierUpdate:
    properties:
      isActive:
        type: boolean
      name:
        maxLength: 255
        minLength: 1
        type: string
      url:
        type: string
        x-nullable: true
    required:
    - name
    type: object
  repo.PaginationResult-repo_EntitySummary:
    properties:
      items:
        items:
          $ref: '#/definitions/repo.EntitySummary'
        type: array
      page:
        type: integer
      pageSize:
        type: integer
      total:
        type: integer
    type: object
  repo.TagCreate:
    properties:
      color:
        type: string
      description:
        maxLength: 1000
        type: string
      icon:
        maxLength: 255
        type: string
      name:
        maxLength: 255
        minLength: 1
        type: string
      parentId:
        type: string
        x-nullable: true
    required:
    - name
    type: object
  repo.TagOut:
    properties:
      children:
        items:
          $ref: '#/definitions/repo.TagSummary'
        type: array
      color:
        type: string
      createdAt:
        type: string
      description:
        type: string
      icon:
        type: string
      id:
        type: string
      name:
        type: string
      parent:
        allOf:
        - $ref: '#/definitions/repo.TagSummary'
        x-nullable: true
      parentId:
        type: string
        x-nullable: true
      updatedAt:
        type: string
    type: object
  repo.TagSummary:
    properties:
      color:
        type: string
      createdAt:
        type: string
      description:
        type: string
      icon:
        type: string
      id:
        type: string
      name:
        type: string
      parentId:
        type: string
        x-nullable: true
      updatedAt:
        type: string
    type: object
  repo.TagUpdate:
    properties:
      color:
        type: string
      description:
        maxLength: 1000
        type: string
      icon:
        maxLength: 255
        type: string
      id:
        type: string
      name:
        maxLength: 255
        minLength: 1
        type: string
      parentId:
        type: string
        x-nullable: true
    required:
    - name
    type: object
  repo.TemplateField:
    properties:
      booleanValue:
        type: boolean
      id:
        type: string
      name:
        type: string
      numberValue:
        type: integer
      textValue:
        type: string
      timeValue:
        type: string
      type:
        type: string
    type: object
  repo.TemplateLocationSummary:
    properties:
      id:
        type: string
      name:
        type: string
    type: object
  repo.TemplateTagSummary:
    properties:
      id:
        type: string
      name:
        type: string
    type: object
  repo.TotalsByOrganizer:
    properties:
      id:
        type: string
      name:
        type: string
      total:
        type: number
    type: object
  repo.TreeItem:
    properties:
      children:
        items:
          $ref: '#/definitions/repo.TreeItem'
        type: array
      id:
        type: string
      name:
        type: string
      type:
        type: string
    type: object
  repo.UserOut:
    properties:
      defaultGroupId:
        type: string
      email:
        type: string
      groupIds:
        items:
          type: string
        type: array
      id:
        type: string
      isSuperuser:
        type: boolean
      name:
        type: string
      oidcIssuer:
        type: string
      oidcSubject:
        type: string
    type: object
  repo.UserSummary:
    properties:
      email:
        type: string
      id:
        type: string
      name:
        type: string
    type: object
  repo.UserUpdate:
    properties:
      email:
        type: string
      name:
        type: string
    type: object
  repo.ValueOverTime:
    properties:
      end:
        type: string
      entries:
        items:
          $ref: '#/definitions/repo.ValueOverTimeEntry'
        type: array
      start:
        type: string
      valueAtEnd:
        type: number
      valueAtStart:
        type: number
    type: object
  repo.ValueOverTimeEntry:
    properties:
      date:
        type: string
      name:
        type: string
      value:
        type: number
    type: object
  services.Latest:
    properties:
      date:
        type: string
      version:
        type: string
    type: object
  services.UserRegistration:
    properties:
      email:
        type: string
      name:
        type: string
      password:
        type: string
      token:
        type: string
    type: object
  templatefield.Type:
    enum:
    - text
    - number
    - boolean
    - time
    type: string
    x-enum-varnames:
    - TypeText
    - TypeNumber
    - TypeBoolean
    - TypeTime
  usergroup.Role:
    enum:
    - user
    - user
    - owner
    type: string
    x-enum-varnames:
    - DefaultRole
    - RoleUser
    - RoleOwner
  v1.APISummary:
    properties:
      allowRegistration:
        type: boolean
      build:
        $ref: '#/definitions/v1.Build'
      demo:
        type: boolean
      health:
        type: boolean
      labelPrinting:
        type: boolean
      latest:
        $ref: '#/definitions/services.Latest'
      message:
        type: string
      oidc:
        $ref: '#/definitions/v1.OIDCStatus'
      telemetry:
        $ref: '#/definitions/v1.TelemetryStatus'
      title:
        type: string
      versions:
        items:
          type: string
        type: array
    type: object
  v1.ActionAmountResult:
    properties:
      completed:
        type: integer
    type: object
  v1.Build:
    properties:
      buildTime:
        type: string
      commit:
        type: string
      version:
        type: string
    type: object
  v1.ChangePassword:
    properties:
      current:
        type: string
      new:
        type: string
    type: object
  v1.CreateRequest:
    properties:
      name:
        type: string
    required:
    - name
    type: object
  v1.EntityTemplateCreateItemRequest:
    properties:
      description:
        maxLength: 1000
        type: string
      entityTypeId:
        description: |-
          EntityTypeID is the entity type selected by the user. When set it takes
          precedence; when empty the repository falls back to the group's default.
        type: string
      locationId:
        type: string
        x-nullable: true
        x-omitempty: true
      name:
        maxLength: 255
        minLength: 1
        type: string
      parentId:
        type: string
      quantity:
        type: number
      tagIds:
        items:
          type: string
        type: array
    required:
    - name
    - parentId
    type: object
  v1.ForgotPasswordRequest:
    properties:
      email:
        example: [email protected]
        type: string
    required:
    - email
    type: object
  v1.GroupAcceptInvitationResponse:
    properties:
      id:
        type: string
      name:
        type: string
    type: object
  v1.GroupInvitation:
    properties:
      expiresAt:
        type: string
      id:
        type: string
      token:
        type: string
      uses:
        type: integer
    type: object
  v1.GroupInvitationCreate:
    properties:
      expiresAt:
        type: string
      uses:
        maximum: 100
        minimum: 1
        type: integer
    required:
    - uses
    type: object
  v1.LoginForm:
    properties:
      password:
        example: admin
        type: string
      stayLoggedIn:
        type: boolean
      username:
        example: [email protected]
        type: string
    type: object
  v1.OIDCStatus:
    properties:
      allowLocal:
        type: boolean
      autoRedirect:
        type: boolean
      buttonText:
        type: string
      enabled:
        type: boolean
    type: object
  v1.ResetPasswordRequest:
    properties:
      password:
        minLength: 6
        type: string
      token:
        minLength: 20
        type: string
    required:
    - password
    - token
    type: object
  v1.Results-repo_ExportOut:
    properties:
      items:
        items:
          $ref: '#/definitions/repo.ExportOut'
        type: array
    type: object
  v1.TelemetryStatus:
    properties:
      enabled:
        type: boolean
    type: object
  v1.TokenResponse:
    properties:
      attachmentToken:
        type: string
      expiresAt:
        type: string
      token:
        type: string
    type: object
  v1.WipeInventoryOptions:
    properties:
      wipeLocations:
        type: boolean
      wipeMaintenance:
        type: boolean
      wipeTags:
        type: boolean
    type: object
  v1.Wrapped:
    properties:
      item: {}
    type: object
  v1.externalAttachmentRequest:
    properties:
      attachment_type:
        type: string
      external_id:
        type: string
      source_type:
        type: string
      title:
        type: string
    type: object
  validate.ErrorResponse:
    properties:
      error:
        type: string
      fields:
        type: string
    type: object
info:
  contact:
    name: Homebox Team
    url: https://discord.homebox.software
  description: Track, Manage, and Organize your Things.
  title: Homebox API
  version: "1.0"
paths:
  /v1/actions/create-missing-thumbnails:
    post:
      description: Creates thumbnails for items that are missing them
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.ActionAmountResult'
      security:
      - Bearer: []
      summary: Create Missing Thumbnails
      tags:
      - Actions
  /v1/actions/ensure-asset-ids:
    post:
      description: Ensures all items in the database have an asset ID
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.ActionAmountResult'
      security:
      - Bearer: []
      summary: Ensure Asset IDs
      tags:
      - Actions
  /v1/actions/ensure-import-refs:
    post:
      description: Ensures all items in the database have an import ref
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.ActionAmountResult'
      security:
      - Bearer: []
      summary: Ensures Import Refs
      tags:
      - Actions
  /v1/actions/set-primary-photos:
    post:
      description: Sets the first photo of each item as the primary photo
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.ActionAmountResult'
      security:
      - Bearer: []
      summary: Set Primary Photos
      tags:
      - Actions
  /v1/actions/wipe-inventory:
    post:
      description: Deletes all items in the inventory
      parameters:
      - description: Wipe options
        in: body
        name: options
        schema:
          $ref: '#/definitions/v1.WipeInventoryOptions'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.ActionAmountResult'
      security:
      - Bearer: []
      summary: Wipe Inventory
      tags:
      - Actions
  /v1/actions/zero-item-time-fields:
    post:
      description: Resets all item date fields to the beginning of the day
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.ActionAmountResult'
      security:
      - Bearer: []
      summary: Zero Out Time Fields
      tags:
      - Actions
  /v1/assets/{id}:
    get:
      parameters:
      - description: Asset ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.PaginationResult-repo_EntitySummary'
      security:
      - Bearer: []
      summary: Get Item by Asset ID
      tags:
      - Items
  /v1/currencies:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/currencies.Currency'
      summary: Currency
      tags:
      - Base
  /v1/entities:
    get:
      parameters:
      - description: 'search string; matches names, descriptions, serial/model numbers,
          manufacturers, notes, purchase sources, tag names, and custom field values.
          Use #<assetId> to look up by asset ID and double quotes for exact phrases'
        in: query
        name: q
        type: string
      - description: page number
        in: query
        name: page
        type: integer
      - description: items per page
        in: query
        name: pageSize
        type: integer
      - collectionFormat: multi
        description: tags Ids
        in: query
        items:
          type: string
        name: tags
        type: array
      - description: require all selected tags to match (AND) instead of any (OR)
        in: query
        name: matchAllTags
        type: boolean
      - collectionFormat: multi
        description: parent Ids
        in: query
        items:
          type: string
        name: parentIds
        type: array
      - collectionFormat: multi
        description: entity type IDs; when provided this filter takes precedence over
          isLocation
        in: query
        items:
          type: string
        name: entityTypeIds
        type: array
      - description: 'field to order by; valid values: name, createdAt, updatedAt,
          assetId'
        in: query
        name: orderBy
        type: string
      - description: 'order direction; valid values: asc, desc. Defaults to desc for
          createdAt and updatedAt, asc otherwise'
        in: query
        name: orderDirection
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.EntityListResult'
      security:
      - Bearer: []
      summary: Query All Entities
      tags:
      - Entities
    post:
      parameters:
      - description: Entity Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.EntityCreate'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/repo.EntityOut'
      security:
      - Bearer: []
      summary: Create Entity
      tags:
      - Entities
  /v1/entities/{id}:
    delete:
      parameters:
      - description: Entity ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Delete Entity
      tags:
      - Entities
    get:
      parameters:
      - description: Entity ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.EntityOut'
      security:
      - Bearer: []
      summary: Get Entity
      tags:
      - Entities
    patch:
      parameters:
      - description: Entity ID
        in: path
        name: id
        required: true
        type: string
      - description: Entity Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.EntityPatch'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.EntityOut'
      security:
      - Bearer: []
      summary: Patch Entity
      tags:
      - Entities
    put:
      parameters:
      - description: Entity ID
        in: path
        name: id
        required: true
        type: string
      - description: Entity Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.EntityUpdate'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.EntityOut'
      security:
      - Bearer: []
      summary: Update Entity
      tags:
      - Entities
  /v1/entities/{id}/attachments:
    post:
      consumes:
      - multipart/form-data
      parameters:
      - description: Entity ID
        in: path
        name: id
        required: true
        type: string
      - description: File attachment
        in: formData
        name: file
        required: true
        type: file
      - description: Type of file
        in: formData
        name: type
        type: string
      - description: Is this the primary attachment
        in: formData
        name: primary
        type: boolean
      - description: name of the file including extension
        in: formData
        name: name
        required: true
        type: string
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/repo.EntityOut'
        "422":
          description: Unprocessable Entity
          schema:
            $ref: '#/definitions/validate.ErrorResponse'
      security:
      - Bearer: []
      summary: Create Entity Attachment
      tags:
      - Entities Attachments
  /v1/entities/{id}/attachments/{attachment_id}:
    delete:
      parameters:
      - description: Entity ID
        in: path
        name: id
        required: true
        type: string
      - description: Attachment ID
        in: path
        name: attachment_id
        required: true
        type: string
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Delete Entity Attachment
      tags:
      - Entities Attachments
    get:
      parameters:
      - description: Entity ID
        in: path
        name: id
        required: true
        type: string
      - description: Attachment ID
        in: path
        name: attachment_id
        required: true
        type: string
      produces:
      - application/octet-stream
      responses:
        "200":
          description: OK
          schema:
            type: file
      security:
      - Bearer: []
      summary: Get Entity Attachment
      tags:
      - Entities Attachments
    put:
      parameters:
      - description: Entity ID
        in: path
        name: id
        required: true
        type: string
      - description: Attachment ID
        in: path
        name: attachment_id
        required: true
        type: string
      - description: Attachment Update
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.ItemAttachmentUpdate'
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.EntityOut'
      security:
      - Bearer: []
      summary: Update Entity Attachment
      tags:
      - Entities Attachments
  /v1/entities/{id}/attachments/external:
    post:
      consumes:
      - application/json
      description: Links an entity to a document or URL in an external system without
        copying
      parameters:
      - description: Entity ID
        in: path
        name: id
        required: true
        type: string
      - description: External document reference
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/v1.externalAttachmentRequest'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/repo.EntityOut'
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/validate.ErrorResponse'
      security:
      - Bearer: []
      summary: Create External Link Attachment
      tags:
      - Entities Attachments
  /v1/entities/{id}/duplicate:
    post:
      parameters:
      - description: Entity ID
        in: path
        name: id
        required: true
        type: string
      - description: Duplicate Options
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.DuplicateOptions'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/repo.EntityOut'
      security:
      - Bearer: []
      summary: Duplicate Entity
      tags:
      - Entities
  /v1/entities/{id}/maintenance:
    get:
      parameters:
      - description: Item ID
        in: path
        name: id
        required: true
        type: string
      - enum:
        - scheduled
        - completed
        - both
        in: query
        name: status
        type: string
        x-enum-varnames:
        - MaintenanceFilterStatusScheduled
        - MaintenanceFilterStatusCompleted
        - MaintenanceFilterStatusBoth
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/repo.MaintenanceEntryWithDetails'
            type: array
      security:
      - Bearer: []
      summary: Get Maintenance Log
      tags:
      - Item Maintenance
    post:
      parameters:
      - description: Item ID
        in: path
        name: id
        required: true
        type: string
      - description: Entry Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.MaintenanceEntryCreate'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/repo.MaintenanceEntry'
      security:
      - Bearer: []
      summary: Create Maintenance Entry
      tags:
      - Item Maintenance
  /v1/entities/{id}/path:
    get:
      parameters:
      - description: Entity ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/repo.EntityPath'
            type: array
      security:
      - Bearer: []
      summary: Get the full path of an entity
      tags:
      - Entities
  /v1/entities/export:
    get:
      responses:
        "200":
          description: text/csv
          schema:
            type: string
      security:
      - Bearer: []
      summary: Export Entities
      tags:
      - Entities
  /v1/entities/fields:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              type: string
            type: array
      security:
      - Bearer: []
      summary: Get All Custom Field Names
      tags:
      - Entities
  /v1/entities/fields/values:
    get:
      parameters:
      - description: Field name
        in: query
        name: field
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              type: string
            type: array
      security:
      - Bearer: []
      summary: Get All Custom Field Values
      tags:
      - Entities
  /v1/entities/import:
    post:
      consumes:
      - multipart/form-data
      parameters:
      - description: CSV file to upload
        in: formData
        name: csv
        required: true
        type: file
      produces:
      - application/json
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Import Entities
      tags:
      - Entities
  /v1/entities/tree:
    get:
      parameters:
      - description: include items in response tree
        in: query
        name: withItems
        type: boolean
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/repo.TreeItem'
            type: array
      security:
      - Bearer: []
      summary: Get Locations Tree
      tags:
      - Entities
  /v1/entity-types:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/repo.EntityTypeSummary'
            type: array
      security:
      - Bearer: []
      summary: Get All Entity Types
      tags:
      - Entity Types
    post:
      parameters:
      - description: Entity Type Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.EntityTypeCreate'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/repo.EntityTypeSummary'
      security:
      - Bearer: []
      summary: Create Entity Type
      tags:
      - Entity Types
  /v1/entity-types/{id}:
    delete:
      parameters:
      - description: Entity Type ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Delete Entity Type
      tags:
      - Entity Types
    put:
      parameters:
      - description: Entity Type ID
        in: path
        name: id
        required: true
        type: string
      - description: Entity Type Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.EntityTypeUpdate'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.EntityTypeSummary'
      security:
      - Bearer: []
      summary: Update Entity Type
      tags:
      - Entity Types
  /v1/group/exports:
    get:
      description: Returns export job rows for the caller's group, newest first.
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.Results-repo_ExportOut'
      security:
      - Bearer: []
      summary: List Collection Exports
      tags:
      - Group
    post:
      description: Creates a pending export row and enqueues the build job. Poll the
        listing endpoint or watch the WebSocket for completion.
      produces:
      - application/json
      responses:
        "202":
          description: Accepted
          schema:
            $ref: '#/definitions/repo.ExportOut'
      security:
      - Bearer: []
      summary: Start a Collection Export
      tags:
      - Group
  /v1/group/exports/{id}:
    delete:
      description: Deletes the export row and its blob artifact.
      parameters:
      - description: Export ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Delete an Export
      tags:
      - Group
    get:
      parameters:
      - description: Export ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.ExportOut'
      security:
      - Bearer: []
      summary: Get an Export
      tags:
      - Group
  /v1/group/exports/{id}/download:
    get:
      parameters:
      - description: Export ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/zip
      responses:
        "200":
          description: OK
          schema:
            type: file
      security:
      - Bearer: []
      summary: Download an Export Artifact
      tags:
      - Group
  /v1/group/import:
    post:
      consumes:
      - multipart/form-data
      description: Uploads a collection-export zip and enqueues the import job. The
        destination group must be empty. Returns the tracked import row so clients
        can poll for progress.
      parameters:
      - description: Export zip
        in: formData
        name: file
        required: true
        type: file
      produces:
      - application/json
      responses:
        "202":
          description: Accepted
          schema:
            $ref: '#/definitions/repo.ExportOut'
      security:
      - Bearer: []
      summary: Import a Collection Zip
      tags:
      - Group
  /v1/groups:
    delete:
      produces:
      - application/json
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Delete Group
      tags:
      - Group
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.Group'
      security:
      - Bearer: []
      summary: Get Group
      tags:
      - Group
    post:
      parameters:
      - description: Create group request
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/v1.CreateRequest'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/repo.Group'
      security:
      - Bearer: []
      summary: Create Group
      tags:
      - Group
    put:
      parameters:
      - description: User Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.GroupUpdate'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.Group'
      security:
      - Bearer: []
      summary: Update Group
      tags:
      - Group
  /v1/groups/all:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/repo.Group'
            type: array
      security:
      - Bearer: []
      summary: Get All Groups
      tags:
      - Group
  /v1/groups/invitations:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/repo.GroupInvitation'
            type: array
      security:
      - Bearer: []
      summary: Get All Group Invitations
      tags:
      - Group
    post:
      operationId: groupInvitationCreate
      parameters:
      - description: User Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/v1.GroupInvitationCreate'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.GroupInvitation'
      security:
      - Bearer: []
      summary: Create Group Invitation
      tags:
      - Group
  /v1/groups/invitations/{id}:
    delete:
      parameters:
      - description: Invitation ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Delete Group Invitation
      tags:
      - Group
    post:
      operationId: groupInvitationAccept
      parameters:
      - description: Invitation Token
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.GroupAcceptInvitationResponse'
      security:
      - Bearer: []
      summary: Accept Group Invitation
      tags:
      - Group
  /v1/groups/members:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/repo.UserSummary'
            type: array
      security:
      - Bearer: []
      summary: Get All Group Members
      tags:
      - Group
  /v1/groups/members/{user_id}:
    delete:
      parameters:
      - description: User ID
        in: path
        name: user_id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Remove User from Group
      tags:
      - Group
  /v1/groups/statistics:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.GroupStatistics'
      security:
      - Bearer: []
      summary: Get Group Statistics
      tags:
      - Statistics
  /v1/groups/statistics/locations:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/repo.TotalsByOrganizer'
            type: array
      security:
      - Bearer: []
      summary: Get Location Statistics
      tags:
      - Statistics
  /v1/groups/statistics/purchase-price:
    get:
      parameters:
      - description: start date
        in: query
        name: start
        type: string
      - description: end date
        in: query
        name: end
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.ValueOverTime'
      security:
      - Bearer: []
      summary: Get Purchase Price Statistics
      tags:
      - Statistics
  /v1/groups/statistics/tags:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/repo.TotalsByOrganizer'
            type: array
      security:
      - Bearer: []
      summary: Get Tags Statistics
      tags:
      - Statistics
  /v1/labelmaker/asset/{id}:
    get:
      parameters:
      - description: Asset ID
        in: path
        name: id
        required: true
        type: string
      - description: Print this label, defaults to false
        in: query
        name: print
        type: boolean
      produces:
      - application/json
      responses:
        "200":
          description: image/png
          schema:
            type: string
      security:
      - Bearer: []
      summary: Get Asset label
      tags:
      - Items
  /v1/labelmaker/item/{id}:
    get:
      parameters:
      - description: Item ID
        in: path
        name: id
        required: true
        type: string
      - description: Print this label, defaults to false
        in: query
        name: print
        type: boolean
      produces:
      - application/json
      responses:
        "200":
          description: image/png
          schema:
            type: string
      security:
      - Bearer: []
      summary: Get Item label
      tags:
      - Items
  /v1/labelmaker/location/{id}:
    get:
      parameters:
      - description: Location ID
        in: path
        name: id
        required: true
        type: string
      - description: Print this label, defaults to false
        in: query
        name: print
        type: boolean
      produces:
      - application/json
      responses:
        "200":
          description: image/png
          schema:
            type: string
      security:
      - Bearer: []
      summary: Get Location label
      tags:
      - Locations
  /v1/maintenance:
    get:
      parameters:
      - enum:
        - scheduled
        - completed
        - both
        in: query
        name: status
        type: string
        x-enum-varnames:
        - MaintenanceFilterStatusScheduled
        - MaintenanceFilterStatusCompleted
        - MaintenanceFilterStatusBoth
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/repo.MaintenanceEntryWithDetails'
            type: array
      security:
      - Bearer: []
      summary: Query All Maintenance
      tags:
      - Maintenance
  /v1/maintenance/{id}:
    delete:
      parameters:
      - description: Maintenance ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Delete Maintenance Entry
      tags:
      - Maintenance
    put:
      parameters:
      - description: Maintenance ID
        in: path
        name: id
        required: true
        type: string
      - description: Entry Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.MaintenanceEntryUpdate'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.MaintenanceEntry'
      security:
      - Bearer: []
      summary: Update Maintenance Entry
      tags:
      - Maintenance
  /v1/notifiers:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/repo.NotifierOut'
            type: array
      security:
      - Bearer: []
      summary: Get Notifiers
      tags:
      - Notifiers
    post:
      parameters:
      - description: Notifier Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.NotifierCreate'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.NotifierOut'
      security:
      - Bearer: []
      summary: Create Notifier
      tags:
      - Notifiers
  /v1/notifiers/{id}:
    delete:
      parameters:
      - description: Notifier ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Delete a Notifier
      tags:
      - Notifiers
    put:
      parameters:
      - description: Notifier ID
        in: path
        name: id
        required: true
        type: string
      - description: Notifier Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.NotifierUpdate'
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.NotifierOut'
      security:
      - Bearer: []
      summary: Update Notifier
      tags:
      - Notifiers
  /v1/notifiers/test:
    post:
      parameters:
      - description: URL
        in: query
        name: url
        required: true
        type: string
      produces:
      - application/json
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Test Notifier
      tags:
      - Notifiers
  /v1/products/search-from-barcode:
    get:
      parameters:
      - description: barcode to be searched
        in: query
        name: data
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/repo.BarcodeProduct'
            type: array
      security:
      - Bearer: []
      summary: Search EAN from Barcode
      tags:
      - Items
  /v1/qrcode:
    get:
      parameters:
      - description: data to be encoded into qrcode
        in: query
        name: data
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: image/jpeg
          schema:
            type: string
      security:
      - Bearer: []
      summary: Create QR Code
      tags:
      - Items
  /v1/reporting/bill-of-materials:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: text/csv
          schema:
            type: string
      security:
      - Bearer: []
      summary: Export Bill of Materials
      tags:
      - Reporting
  /v1/status:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.APISummary'
      summary: Application Info
      tags:
      - Base
  /v1/tags:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/repo.TagSummary'
            type: array
      security:
      - Bearer: []
      summary: Get All Tags
      tags:
      - Tags
    post:
      parameters:
      - description: Tag Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.TagCreate'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/repo.TagOut'
      security:
      - Bearer: []
      summary: Create Tag
      tags:
      - Tags
  /v1/tags/{id}:
    delete:
      parameters:
      - description: Tag ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Delete Tag
      tags:
      - Tags
    get:
      parameters:
      - description: Tag ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.TagOut'
      security:
      - Bearer: []
      summary: Get Tag
      tags:
      - Tags
    put:
      parameters:
      - description: Tag ID
        in: path
        name: id
        required: true
        type: string
      - description: Tag Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.TagUpdate'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.TagOut'
      security:
      - Bearer: []
      summary: Update Tag
      tags:
      - Tags
  /v1/templates:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/repo.EntityTemplateSummary'
            type: array
      security:
      - Bearer: []
      summary: Get All Entity Templates
      tags:
      - Entity Templates
    post:
      parameters:
      - description: Template Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.EntityTemplateCreate'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/repo.EntityTemplateOut'
      security:
      - Bearer: []
      summary: Create Entity Template
      tags:
      - Entity Templates
  /v1/templates/{id}:
    delete:
      parameters:
      - description: Template ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Delete Entity Template
      tags:
      - Entity Templates
    get:
      parameters:
      - description: Template ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.EntityTemplateOut'
      security:
      - Bearer: []
      summary: Get Entity Template
      tags:
      - Entity Templates
    put:
      parameters:
      - description: Template ID
        in: path
        name: id
        required: true
        type: string
      - description: Template Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.EntityTemplateUpdate'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/repo.EntityTemplateOut'
      security:
      - Bearer: []
      summary: Update Entity Template
      tags:
      - Entity Templates
  /v1/templates/{id}/create-item:
    post:
      parameters:
      - description: Template ID
        in: path
        name: id
        required: true
        type: string
      - description: Entity Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/v1.EntityTemplateCreateItemRequest'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/repo.EntityOut'
      security:
      - Bearer: []
      summary: Create Entity from Template
      tags:
      - Entity Templates
  /v1/users/change-password:
    put:
      parameters:
      - description: Password Payload
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/v1.ChangePassword'
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Change Password
      tags:
      - User
  /v1/users/forgot-password:
    post:
      consumes:
      - application/json
      description: |-
        Sends a password reset email if the address is associated with a local account.
        Always returns 204 on success to avoid leaking whether the email is registered.
      parameters:
      - description: Email
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/v1.ForgotPasswordRequest'
      produces:
      - application/json
      responses:
        "204":
          description: No Content
        "400":
          description: missing or invalid request body, or empty email field
          schema:
            type: string
        "403":
          description: demo mode is enabled or local login is disabled
          schema:
            type: string
        "500":
          description: internal error while processing the request
          schema:
            type: string
      summary: Request Password Reset
      tags:
      - Authentication
  /v1/users/login:
    post:
      consumes:
      - application/x-www-form-urlencoded
      - application/json
      parameters:
      - description: Login Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/v1.LoginForm'
      - description: auth provider
        in: query
        name: provider
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/v1.TokenResponse'
      summary: User Login
      tags:
      - Authentication
  /v1/users/login/oidc:
    get:
      produces:
      - application/json
      responses:
        "302":
          description: Found
      summary: OIDC Login Initiation
      tags:
      - Authentication
  /v1/users/login/oidc/callback:
    get:
      parameters:
      - description: Authorization code
        in: query
        name: code
        required: true
        type: string
      - description: State parameter
        in: query
        name: state
        required: true
        type: string
      responses:
        "302":
          description: Found
      summary: OIDC Callback Handler
      tags:
      - Authentication
  /v1/users/logout:
    post:
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: User Logout
      tags:
      - Authentication
  /v1/users/logout/all:
    post:
      description: |-
        Revokes every session token for the authenticated user across all
        devices, including the current one. Use this to invalidate a session
        token that may have been leaked or stolen. API keys are stored
        separately and are not affected; revoke them from the API keys page.
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Log Out Of All Sessions
      tags:
      - Authentication
  /v1/users/refresh:
    get:
      description: |-
        handleAuthRefresh returns a handler that will issue a new token from an existing token.
        This does not validate that the user still exists within the database.
      responses:
        "200":
          description: OK
      security:
      - Bearer: []
      summary: User Token Refresh
      tags:
      - Authentication
  /v1/users/register:
    post:
      parameters:
      - description: User Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/services.UserRegistration'
      produces:
      - application/json
      responses:
        "204":
          description: No Content
        "403":
          description: Local login is not enabled
          schema:
            type: string
      summary: Register New User
      tags:
      - User
  /v1/users/reset-password:
    post:
      consumes:
      - application/json
      description: |-
        Consumes a single-use reset token and changes the user's password.
        On success, all existing sessions for the user are revoked.
      parameters:
      - description: Token + new password
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/v1.ResetPasswordRequest'
      produces:
      - application/json
      responses:
        "204":
          description: No Content
        "400":
          description: invalid request body, password shorter than the minimum length,
            or token that is invalid / expired / already used
          schema:
            type: string
        "403":
          description: demo mode is enabled or local login is disabled
          schema:
            type: string
        "500":
          description: internal error while processing the request
          schema:
            type: string
      summary: Reset Password
      tags:
      - Authentication
  /v1/users/self:
    delete:
      produces:
      - application/json
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Delete Account
      tags:
      - User
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            allOf:
            - $ref: '#/definitions/v1.Wrapped'
            - properties:
                item:
                  $ref: '#/definitions/repo.UserOut'
              type: object
      security:
      - Bearer: []
      summary: Get User Self
      tags:
      - User
    put:
      parameters:
      - description: User Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.UserUpdate'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            allOf:
            - $ref: '#/definitions/v1.Wrapped'
            - properties:
                item:
                  $ref: '#/definitions/repo.UserUpdate'
              type: object
      security:
      - Bearer: []
      summary: Update Account
      tags:
      - User
  /v1/users/self/api-keys:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/repo.APIKeyOut'
            type: array
      security:
      - Bearer: []
      summary: List API Keys
      tags:
      - User
    post:
      parameters:
      - description: API Key Data
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/repo.APIKeyCreate'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/repo.APIKeyCreatedOut'
      security:
      - Bearer: []
      summary: Create API Key
      tags:
      - User
  /v1/users/self/api-keys/{id}:
    delete:
      parameters:
      - description: API Key ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "204":
          description: No Content
      security:
      - Bearer: []
      summary: Delete API Key
      tags:
      - User
  /v1/users/self/settings:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            allOf:
            - $ref: '#/definitions/v1.Wrapped'
            - properties:
                item:
                  additionalProperties: true
                  type: object
              type: object
      security:
      - Bearer: []
      summary: Get user settings
      tags:
      - User
    put:
      parameters:
      - description: Settings Data
        in: body
        name: payload
        required: true
        schema:
          additionalProperties: true
          type: object
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            allOf:
            - $ref: '#/definitions/v1.Wrapped'
            - properties:
                item:
                  additionalProperties: true
                  type: object
              type: object
      security:
      - Bearer: []
      summary: Update user settings
      tags:
      - User
schemes:
- https
- http
securityDefinitions:
  Bearer:
    description: '"Type ''Bearer TOKEN'' to correctly set the API Key"'
    in: header
    name: Authorization
    type: apiKey
swagger: "2.0"