Function listChangeRequestsForOrganizationHandler

  • listChangeRequestsForOrganizationHandler(paginationConfiguration, service, logger, context): Promise<adapter.AdapterHandlerResponse>

  • Get organization change requests handler

    Parameters

    • paginationConfiguration: PaginationConfigurations
    • service: Pick<ChangeRequestDataService, "listChangeRequests" | "normalizeChangeRequestResponses">

      injected service use to handle the organization related operations

      • getChangeRequestList
    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

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

      • params is required
      • params.orgId is required

    Returns Promise<adapter.AdapterHandlerResponse>

    200 OK

    • data: normalized change request responses with pagination

    Description

    This handler will get organization change requests by applying the following steps in sequence:

    1. Get organization id from path

    2. Concat organization id to filter expression (if any)

    3. Parse paginated list query (util.parsePaginatedListQuery)

    4. Get change request list (service.getChangeRequestList)

    5. Normalize change request responses (service.normalizeChangeRequestResponses)

    6. Return normalized change request responses

    Throws

    400 NBError Bad Request

    • error when parse paginated list query
    • pagination must be set
    • page size is too large, must less than ${MAXIMUM_PAGE_SIZE}

    Throws

    500 NBError Internal Server Error

    • error when getting change request list

Settings

Member Visibility

Theme

Generated using TypeDoc