wikimedia/mediawiki-extensions-Wikibase

{
    "get": {
        "operationId": "getPropertyDescription",
        "tags": [ "descriptions" ],
        "summary": "Retrieve a Property's description in a specific language",
        "parameters": [
            { "$ref": "../../global/parameters.json#/PropertyId" },
            { "$ref": "../../global/parameters.json#/LanguageCode" },
            { "$ref": "../../global/parameters.json#/IfNoneMatch" },
            { "$ref": "../../global/parameters.json#/IfModifiedSince" },
            { "$ref": "../../global/parameters.json#/IfMatch" },
            { "$ref": "../../global/parameters.json#/IfUnmodifiedSince" },
            { "$ref": "../../global/parameters.json#/Authorization" }
        ],
        "responses": {
            "200": { "$ref": "./responses.json#/PropertyDescription" },
            "304": { "$ref": "../../global/responses.json#/NotModified" },
            "400": { "$ref": "../../global/responses.json#/InvalidTermByLanguageInput" },
            "404": { "$ref": "../../global/responses.json#/ResourceNotFound" },
            "412": { "$ref": "../../global/responses.json#/PreconditionFailedError" },
            "500": { "$ref": "../../global/responses.json#/UnexpectedError" }
        }
    },
    "put": {
        "operationId": "setPropertyDescription",
        "tags": [ "descriptions" ],
        "summary": "Add / Replace a Property's description in a specific language",
        "parameters": [
            { "$ref": "../../global/parameters.json#/PropertyId" },
            { "$ref": "../../global/parameters.json#/LanguageCode" },
            { "$ref": "../../global/parameters.json#/IfNoneMatch" },
            { "$ref": "../../global/parameters.json#/IfModifiedSince" },
            { "$ref": "../../global/parameters.json#/IfMatch" },
            { "$ref": "../../global/parameters.json#/IfUnmodifiedSince" },
            { "$ref": "../../global/parameters.json#/Authorization" }
        ],
        "requestBody": {
            "description": "Payload containing Property description in the specified language and edit metadata",
            "content": {
                "application/json": {
                    "schema": { "$ref": "./requests.json#/SetDescriptionInLanguage" },
                    "example": {
                        "description": "this item is a concrete object (instance) of this class, category or object group",
                        "tags": [],
                        "bot": false,
                        "comment": "set English description"
                    }
                }
            }
        },
        "responses": {
            "200": {
                "description": "The updated description",
                "$ref": "./responses.json#/PropertyDescription"
            },
            "201": {
                "description": "The newly added description",
                "$ref": "./responses.json#/PropertyDescription"
            },
            "304": { "$ref": "../../global/responses.json#/NotModified" },
            "400": { "$ref": "../../global/responses.json#/InvalidSetDescriptionInput" },
            "403": { "$ref": "../../global/responses.json#/PermissionDenied" },
            "404": { "$ref": "../../global/responses.json#/ResourceNotFound" },
            "412": { "$ref": "../../global/responses.json#/PreconditionFailedError" },
            "422": { "$ref": "../../global/responses.json#/DataPolicyViolation" },
            "429": { "$ref": "../../global/responses.json#/RequestLimitReached" },
            "500": { "$ref": "../../global/responses.json#/UnexpectedError" }
        }
    },
    "delete": {
        "operationId": "deletePropertyDescription",
        "tags": [ "descriptions" ],
        "summary": "Delete a Property's description in a specific language",
        "parameters": [
            { "$ref": "../../global/parameters.json#/PropertyId" },
            { "$ref": "../../global/parameters.json#/LanguageCode" },
            { "$ref": "../../global/parameters.json#/IfNoneMatch" },
            { "$ref": "../../global/parameters.json#/IfModifiedSince" },
            { "$ref": "../../global/parameters.json#/IfMatch" },
            { "$ref": "../../global/parameters.json#/IfUnmodifiedSince" },
            { "$ref": "../../global/parameters.json#/Authorization" }
        ],
        "requestBody": { "$ref": "../../global/requests.json#/Delete" },
        "responses": {
            "200": { "$ref": "./responses.json#/DescriptionDeleted" },
            "400": { "$ref": "../../global/responses.json#/InvalidRemoveDescriptionInput" },
            "403": { "$ref": "../../global/responses.json#/PermissionDenied" },
            "404": { "$ref": "../../global/responses.json#/ResourceNotFound" },
            "412": { "$ref": "../../global/responses.json#/PreconditionFailedError" },
            "429": { "$ref": "../../global/responses.json#/RequestLimitReached" },
            "500": { "$ref": "../../global/responses.json#/UnexpectedError" }
        }
    }
}