VTC Spaces

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "space",
    "question"
  ],
  "properties": {
    "space": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Space name, @handle or numeric id, e.g. \"DexiTrade\""
    },
    "question": {
      "type": "string",
      "maxLength": 1000,
      "minLength": 2
    },
    "conversation_id": {
      "type": "string",
      "maxLength": 100,
      "description": "Continue a previous answer thread"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "module_code"
  ],
  "properties": {
    "group_id": {
      "type": "string",
      "description": "Numeric VTC Space id (group_id). Omit after set_guest_context or when using a Space JWT."
    },
    "module_code": {
      "type": "string",
      "description": "App module code from list_guest_public_apps"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "Full URL, e.g. https://dexitrade.apps.vtc.com/api/catalog/public?group=1205"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "query"
  ],
  "properties": {
    "query": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "e.g. \"DexiTrade\" or \"solar\""
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "space"
  ],
  "properties": {
    "space": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Space name, @handle or numeric id, e.g. \"DexiTrade\""
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "group_id": {
      "type": "string",
      "description": "Numeric VTC Space id (group_id). Omit after set_guest_context or when using a Space JWT."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "network_id": {
      "type": "string",
      "default": "1",
      "pattern": "^\\d+$"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "collection_name"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1,
      "description": "Page (default 1). Digits as text are accepted."
    },
    "group_id": {
      "type": "string",
      "description": "Numeric VTC Space id (group_id). Omit after set_guest_context or when using a Space JWT."
    },
    "page_size": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Page size (default 20). Digits as text are accepted."
    },
    "collection_name": {
      "type": "string",
      "description": "Mongo collection name, e.g. dexitrade_catalog_items"
    },
    "publisher_module": {
      "type": "string",
      "description": "Publisher module code when the collection lives on a shared shard DB"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "space"
  ],
  "properties": {
    "space": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Space name, @handle or numeric id, e.g. \"DexiTrade\""
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "space",
    "collection"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 200,
      "description": "Case-insensitive text to look for"
    },
    "space": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Space name, @handle or numeric id, e.g. \"DexiTrade\""
    },
    "page_size": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1
    },
    "collection": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]*$",
      "maxLength": 80,
      "minLength": 1
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "q"
  ],
  "properties": {
    "q": {
      "type": "string",
      "description": "Username, space name, or space/network username"
    },
    "limit": {
      "type": "integer",
      "maximum": 20,
      "minimum": 1,
      "description": "Max results (1–20). Digits as text are accepted."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "q"
  ],
  "properties": {
    "q": {
      "type": "string",
      "description": "Username, e.g. mark or @mark"
    },
    "limit": {
      "type": "integer",
      "maximum": 20,
      "minimum": 1,
      "description": "Max results (1–20). Digits as text are accepted."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "q"
  ],
  "properties": {
    "q": {
      "type": "string",
      "description": "Space name or username, e.g. DEXITRADE or dexi"
    },
    "limit": {
      "type": "integer",
      "maximum": 20,
      "minimum": 1,
      "description": "Max results (1–20). Digits as text are accepted."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "group_id"
  ],
  "properties": {
    "group_id": {
      "type": "string",
      "description": "Numeric Space id, public slug (dexi), or a unique space name"
    }
  },
  "additionalProperties": false
}