Extension:Proofread Page/Metadata API

From Linux Web Expert

Revision as of 12:33, 16 August 2023 by imported>Pppery (Pppery moved page Extension:ProofreadPage/Metadata API to Extension:Proofread Page/Metadata API)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The ProofreadPage extension provides information about the extension's configurations using the query action with meta=proofread:

{
    "action": "query",
    "meta": "proofread"
}

Example: https://en.wikisource.org/wiki/Special:ApiSandbox#action=query&format=json&meta=proofreadinfo

Response
{
    "batchcomplete": "",
    "query": {
        "proofreadnamespaces": {
            "index": {
                "id": 106
            },
            "page": {
                "id": 104
            }
        },
        "proofreadqualitylevels": [
            {
                "id": 0,
                "category": "Without text"
            },
            {
                "id": 1,
                "category": "Not proofread"
            },
            {
                "id": 2,
                "category": "Problematic"
            },
            {
                "id": 3,
                "category": "Proofread"
            },
            {
                "id": 4,
                "category": "Validated"
            }
        ]
    }
}

Properties

You can select which properties are returned using the prpiprop key:

  • namespaces: The Index and Page namespaces
  • qualitylevels: the quality levels, which reports the following information:
    • The level ID, from 0-4
    • The corresponding category, as configured by the MediaWiki:Proofreadpage quality0 category messages

The default value for this key is namespaces|qualitylevels