Wiktionary · JSON Structure

Mediawiki Action Api Action Api Response Structure

Generic envelope for any Action API response.

Type: object Properties: 6
DictionariesOpen SourceWikimediaMediaWikiLinguisticsOpen DataPublic APIs

ActionApiResponse is a JSON Structure definition published by Wiktionary, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

batchcomplete continue query parse warnings error

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wiktionary/refs/heads/main/json-structure/mediawiki-action-api-action-api-response-structure.json",
  "description": "Generic envelope for any Action API response.",
  "type": "object",
  "properties": {
    "batchcomplete": {
      "type": "string",
      "description": "Present when all sub-queries completed in one batch.",
      "example": ""
    },
    "continue": {
      "type": "object",
      "description": "Continuation cursor for paged result sets.",
      "additionalProperties": true
    },
    "query": {
      "type": "object",
      "description": "Container for `prop`/`list`/`meta` results when action=query.",
      "additionalProperties": true
    },
    "parse": {
      "type": "object",
      "description": "Container for action=parse output.",
      "additionalProperties": true
    },
    "warnings": {
      "type": "object",
      "description": "Per-module warning messages.",
      "additionalProperties": true
    },
    "error": {
      "description": "Standard MediaWiki Action API error envelope.",
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "example": "badvalue"
        },
        "info": {
          "type": "string",
          "example": "Unrecognized value for parameter \"action\"."
        },
        "*": {
          "type": "string",
          "description": "Additional error context.",
          "example": "See https://en.wiktionary.org/w/api.php for help."
        }
      },
      "name": "ApiError"
    }
  },
  "name": "ActionApiResponse"
}