Topic Search Result Item

Topic Search Result Item

APIs.ioEngineeringPlatform

Properties

Name Type Description
name string
display_name string
short_description string
description string
created_by string
released string
created_at string
updated_at string
featured boolean
curated boolean
score number
repository_count integer
logo_url string
text_matches object
related array
aliases array
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-topic-search-result-item-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/topic-search-result-item",
  "title": "Topic Search Result Item",
  "description": "Topic Search Result Item",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "display_name": {
      "type": "string",
      "nullable": true
    },
    "short_description": {
      "type": "string",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "created_by": {
      "type": "string",
      "nullable": true
    },
    "released": {
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "featured": {
      "type": "boolean"
    },
    "curated": {
      "type": "boolean"
    },
    "score": {
      "type": "number"
    },
    "repository_count": {
      "type": "integer",
      "nullable": true
    },
    "logo_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "text_matches": {
      "$ref": "#/components/schemas/search-result-text-matches"
    },
    "related": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "object",
        "properties": {
          "topic_relation": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "topic_id": {
                "type": "integer"
              },
              "relation_type": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "aliases": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "object",
        "properties": {
          "topic_relation": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "topic_id": {
                "type": "integer"
              },
              "relation_type": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  },
  "required": [
    "name",
    "display_name",
    "short_description",
    "description",
    "created_by",
    "released",
    "created_at",
    "updated_at",
    "featured",
    "curated",
    "score"
  ]
}