Function listAttributesHandler

  • listAttributesHandler(attributeService, paginationConfiguration, logger, context): Promise<adapter.AdapterHandlerResponse>

  • Get Attribute List Handler

    Parameters

    • attributeService: Pick<AttributeDataService, "listPaginatedAttributes" | "normalizeAttributeResponses">

      injected service use to handle the attribute related operations

    • paginationConfiguration: PaginationConfigurations

      injected pagination configuration

    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

      request context [headers, body, params, query].

    Returns Promise<adapter.AdapterHandlerResponse>

    200 Status Ok

    • data: attribute list

    Description

    This handler is used to get a list of attributes by applying the following steps in sequence:

    1. Parse the paginated list query (util.parsePaginatedListQuery)

    2. Get the attribute list (attributeService.listPaginatedAttributes)

    3. Return the attribute list

    Throws

    400 NBError Bad Request

    • error when parse paginated list query, ${error.message}
    • pagination must be set
    • Page size exceeds ${MAXIMUM_PAGE_SIZE} mbs

Settings

Member Visibility

Theme

Generated using TypeDoc