Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AssetsController

label

DISCOVERY

description

The assets controller of the app. Handles requests about assets that are available in the database.

This controller defines the following routes:

URI HTTP method Class method Description
/assets GET AssetsController.find Responds with a pageable PaginatedResultDTO that contains AssetDTO objects.
/assets/:address GET AssetsController.findByUser Uses the AuthGuard to validate the required access token (Server cookie or Bearer authorization header). Responds with a pageable PaginatedResultDTO that contains AssetDTO objects.


since

v0.3.0

Hierarchy

  • AssetsController

Index

Constructors

Methods

Constructors

constructor

Methods

Protected find

  • Handler of the /assets endpoint. Returns all assets that match the request query. If the query is null or not specified, returns all documents in DTO format using AssetDTO.

    The result of this endpoint can be paginated using query parameters: pageSize, pageNumber. Also, it can be sorted with query parameters: sort, order.

    async
    access

    protected

    method

    GET

    Parameters

    Returns Promise<PaginatedResultDTO<AssetDTO>>

Protected findByUser

  • Requests a user's assets entries. This endpoint is protected and a valid access token must be attached in the Authorization request header, in signed cookies or in browser cookies.

    The request is secured using the AuthGuard guard which attaches a payload to the request object.

    method

    GET

    access

    protected

    async

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      An express request used to extract the authenticated user payload.

    • query: AssetQuery

    Returns Promise<PaginatedResultDTO<AssetDTO>>

    An authenticated user's owned assets.

Generated using TypeDoc