Codex Instances Sources version v1

HTTP status code 200

Returns a list of codex-instances-source items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "additionalProperties": false,
  "description": "Collection of sources",
  "properties": {
    "sources": {
      "type": "array",
      "description": "Collection of sources",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Codex Source schema",
        "description": "Codex Source schema",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "description": "short identifier for the module -- for example (kb, localekb)"
          },
          "name": {
            "type": "string",
            "description": "Module name and version -- for example (mod-codex-ekb-1.1.0, mod-agreements-1.0.2)"
          }
        },
        "required": [
          "id",
          "name"
        ]
      }
    }
  },
  "required": [
    "sources"
  ]
}

Example:

{
  "source": [
    {
      "id": "ekb",
      "name": "mod-codex-ekb-1.1.0"
    },
    {
      "id": "localekb",
      "name": "mod-agreements-1.0.2"
    }
  ]
}

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

unable to list codex-instances-sources -- malformed parameter 'query', syntax error at column 6

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator