Sorting

SortOrder

The order or direction to sort results by.

Table

Value	Description
asc	Ascending order
desc	Descending order

Formats

Example

A JSON example of this model is:

"asc"

JSON Schema

The JSON schema for this model is:

$schema: https://json-schema.org/draft/2020-12/schema
$id: SortOrder.yaml
type: string
enum:
  - asc
  - desc

TypeSpec

The TypeSpec code for this model is:

enum SortOrder {
  asc,
  desc,
}

SortQueryParams

Query parameters for sorting. These parameters should be used on GET routes that support sorting.

Table

Parameter	Type	Description
sortBy	unknown	The field to sort by, should be an enum for individual routes
customSortBy	string	An implementation-defined sort key
sortOrder	SortOrder	The order to sort by

Formats

Example

An example URL using these parameters:

/common-grants/opportunities?sortBy=lastModifiedAt&sortOrder=asc

OpenAPI

The OpenAPI specification for this model is:

/common-grants/opportunities:
  get:
    parameters:
      - $ref: "#/components/parameters/CommonGrants.Sorting.SortQueryParams.sortBy"
      - $ref: "#/components/parameters/CommonGrants.Sorting.SortQueryParams.customSortBy"
      - $ref: "#/components/parameters/CommonGrants.Sorting.SortQueryParams.sortOrder"

Where the references to the parameters are defined as follows:

components:
  parameters:
    CommonGrants.Sorting.SortQueryParams.sortBy:
      name: sortBy
      in: query
      required: false
      description: The field to sort by, should be an enum for individual routes
      schema:
        # These would be defined by the protocol for a given route
        type: string
        enum:
          - lastModifiedAt
          - createdAt
          - title
          - status
          - closeDate
          - maxAwardAmount
      explode: false
    CommonGrants.Sorting.SortQueryParams.customSortBy:
      name: customSortBy
      in: query
      required: false
      description: An implementation-defined sort key
      schema:
        type: string
      explode: false
    CommonGrants.Sorting.SortQueryParams.sortOrder:
      name: sortOrder
      in: query
      required: false
      description: The order to sort by
      schema:
        $ref: "#/components/schemas/CommonGrants.Sorting.SortOrder"

JSON Schema

The JSON schema for this model is:

$schema: https://json-schema.org/draft/2020-12/schema
$id: SortQueryParams.yaml
type: object
properties:
  sortBy:
    type: string
    description: The field to sort by, should be an enum for individual routes
  customSortBy:
    type: string
    description: An implementation-defined sort key
  sortOrder:
    $ref: SortOrder.yaml
    description: The order to sort by
description: Query parameters for sorting

TypeSpec

The TypeSpec code for this model is:

/** Query parameters for sorting */
model SortQueryParams {
  /** The field to sort by */
  @query
  @example("lastModifiedAt")
  sortBy: unknown;

  /** Implementation-defined sort key */
  @query
  @example("customField")
  customSortBy?: string;

  /** The order to sort by */
  @query
  @example(SortOrder.asc)
  sortOrder?: SortOrder;
}

SortBodyParams

Body parameters for sorting. These parameters should be used on POST and PUT routes that support sorting.

Table

Parameter	Type	Description
sortBy	unknown	The field to sort by, should be an enum for individual routes
customSortBy	string	An implementation-defined sort key
sortOrder	SortOrder	The order to sort by

Formats

Example

A JSON example of this model is:

Sorting by a protocol-defined field:

{
  "sortBy": "lastModifiedAt",
  "sortOrder": "asc"
}

Sorting by an implementation-defined field:

{
  "sortBy": "custom",
  "customSortBy": "customField",
  "sortOrder": "asc"
}

OpenAPI

The OpenAPI specification for this model is:

/common-grants/opportunities:
  post:
    requestBody:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CommonGrants.Sorting.SortBodyParams"

Where the reference to the schema is defined as follows:

components:
  schemas:
    CommonGrants.Sorting.SortBodyParams:
      type: object
      properties:
        sortBy:
          # These would be defined by the protocol for a given route
          type: string
          enum:
            - lastModifiedAt
            - createdAt
            - title
            - status
            - closeDate
            - maxAwardAmount
        customSortBy:
          type: string
        sortOrder:
          $ref: "#/components/schemas/CommonGrants.Sorting.SortOrder"

JSON Schema

The JSON schema for this model is:

$schema: https://json-schema.org/draft/2020-12/schema
$id: SortBodyParams.yaml
type: object
properties:
  sortBy:
    type: string
    description: The field to sort by, should be an enum for individual routes
  customSortBy:
    type: string
    description: An implementation-defined sort key
  sortOrder:
    $ref: SortOrder.yaml
    description: The order to sort by
description: Body parameters for sorting

TypeSpec

The TypeSpec code for this model is:

/** Sorting parameters included in the request body */
model SortBodyParams {
  /** The field to sort by */
  @example("lastModifiedAt")
  sortBy: unknown;

  /** Implementation-defined sort key */
  @example("customField")
  customSortBy?: string;

  /** The order to sort by */
  @example(SortOrder.asc)
  sortOrder?: SortOrder;
}

SortedResultsInfo

Information about the sort order of the items returned. This model should be used to represent the sorting details in responses.

Table

Parameter	Type	Description
sortBy	string	The field to sort by
customSortBy	string	An implementation-defined sort key
sortOrder	SortOrder	The order to sort by
errors	Array<string>	The errors that occurred during sorting

Formats

Example

A JSON example of this model is:

{
  "sortBy": "lastModifiedAt",
  "customSortBy": "customField",
  "sortOrder": "asc"
}

JSON Schema

The JSON schema for this model is:

$schema: https://json-schema.org/draft/2020-12/schema
$id: SortInfo.yaml
type: object
properties:
  sortBy:
    type: string
    description: The field to sort by
  customSortBy:
    type: string
    description: An implementation-defined sort key
  sortOrder:
    $ref: "#/components/schemas/CommonGrants.Sorting.SortOrder"
    description: The order to sort by
  errors:
    type: array
    items:
      type: string
    description: The errors that occurred during sorting
description: Information about the sort order of the items returned

TypeSpec

The TypeSpec code for this model is:

/** Information about the sort order of the items returned */
model SortInfo {
  /** The field to sort by */
  @example("lastModifiedAt")
  sortBy: string;

  /** Implementation-defined sort key */
  @example("customField")
  customSortBy?: string;

  /** The order to sort by */
  @example(SortOrder.asc)
  sortOrder?: SortOrder;

  /** The errors that occurred during sorting */
  errors?: string[];
}