---
title: "SearchResults"
url: "https://nov18-dev.movespot.fyi/apis/portal-search-2/versions/27ea8baa-a891-4d7b-9c82-b7123e17bb02/schemas/SearchResults"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-search-2/versions/27ea8baa-a891-4d7b-9c82-b7123e17bb02.md

# SearchResults

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Portal Search
  version: 2.0.0
components:
  schemas:
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    SearchIndicesParameters:
      type: string
      enum:
        - product-catalog
      title: SearchIndicesParameters
    ProductCatalogIndexSource:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        name:
          description: the name of the product
          type: string
          example: Nice Product
          nullable: true
          readOnly: true
        description:
          description: a description of the product
          type: string
          example: A nice product for customers to read about and consume
          nullable: true
          readOnly: true
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        document_count:
          description: Number of product documents available.
          type: number
          example: 5
          readOnly: true
        version_count:
          description: Number of product versions.
          type: number
          example: 2
          readOnly: true
        latest_version:
          description: Last created version.
          type: object
          additionalProperties: false
          nullable: true
          properties:
            name:
              description: Name of product version.
              type: string
              example: v2.0.0
            id:
              $ref: "#/components/schemas/UUID"
          required:
            - name
            - id
        public_labels:
          $ref: "#/components/schemas/PublicLabels"
      additionalProperties: false
      required:
        - id
        - created_at
        - updated_at
        - name
        - document_count
        - version_count
        - latest_version
        - public_labels
      title: ProductCatalogIndexSource
    PageMeta:
      description: Contains pagination query parameters and the total number of
        objects returned.
      type: object
      properties:
        number:
          type: number
          example: 1
        size:
          type: number
          example: 10
        total:
          type: number
          example: 100
      required:
        - number
        - size
        - total
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    PublicLabels:
      description: >
        Public labels store information about an entity that can be used for
        filtering a list of objects.


        Public labels are intended to store **PUBLIC** metadata. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      type: object
      example:
        category: finance
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: PublicLabels
    SearchResults:
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
        data:
          description: The paginated results that matched the search query
          type: array
          items:
            type: object
            additionalProperties: false
            properties:
              index:
                $ref: "#/components/schemas/SearchIndicesParameters"
              source:
                $ref: "#/components/schemas/ProductCatalogIndexSource"
            required:
              - index
              - source
      additionalProperties: false
      required:
        - data
        - meta
      title: SearchResults
```
