wikimedia/mediawiki-extensions-Wikibase

View on GitHub
repo/rest-api/specs/resources/descriptions/responses.json

Summary

Maintainability
Test Coverage
{
    "ItemDescriptions": {
        "description": "Item's descriptions by language",
        "headers": {
            "Last-Modified": {
                "description": "Last modified date",
                "schema": { "type": "string" }
            },
            "ETag": {
                "description": "Last entity revision number",
                "schema": { "type": "string" }
            },
            "X-Authenticated-User": {
                "description": "Optional username of the user making the request",
                "schema": { "type": "string" }
            }
        },
        "content": {
            "application/json": {
                "schema": { "$ref": "../../global/schemas.json#/Descriptions" },
                "example": {
                    "en": "famous person",
                    "ru": "известная личность"
                }
            }
        }
    },
    "PropertyDescriptions": {
        "description": "Property's descriptions by language",
        "headers": {
            "Last-Modified": {
                "description": "Last modified date",
                "schema": { "type": "string" }
            },
            "ETag": {
                "description": "Last entity revision number",
                "schema": { "type": "string" }
            },
            "X-Authenticated-User": {
                "description": "Optional username of the user making the request",
                "schema": { "type": "string" }
            }
        },
        "content": {
            "application/json": {
                "schema": { "$ref": "../../global/schemas.json#/Descriptions" },
                "example": {
                    "en": "this item is a concrete object (instance) of this class, category or object group",
                    "ru": "данный элемент представляет собой конкретный объект (экземпляр / частный случай) класса, категории"
                }
            }
        }
    },
    "ItemDescription": {
        "description": "Item's description in a specific language",
        "headers": {
            "Last-Modified": {
                "description": "Last modified date",
                "schema": { "type": "string" }
            },
            "ETag": {
                "description": "Last entity revision number",
                "schema": { "type": "string" }
            },
            "X-Authenticated-User": {
                "description": "Optional username of the user making the request",
                "schema": { "type": "string" }
            }
        },
        "content": {
            "application/json": {
                "schema": { "type": "string" },
                "example": "famous person"
            }
        }
    },
    "PropertyDescription": {
        "description": "Property's description in a specific language",
        "headers": {
            "Last-Modified": {
                "description": "Last modified date",
                "schema": { "type": "string" }
            },
            "ETag": {
                "description": "Last entity revision number",
                "schema": { "type": "string" }
            },
            "X-Authenticated-User": {
                "description": "Optional username of the user making the request",
                "schema": { "type": "string" }
            }
        },
        "content": {
            "application/json": {
                "schema": { "type": "string" },
                "example": "this item is a concrete object (instance) of this class, category or object group"
            }
        }
    },
    "DescriptionDeleted": {
        "description": "The description was deleted",
        "headers": {
            "Content-Language": {
                "description": "Language code of the language in which response is provided",
                "schema": { "type": "string" }
            }
        },
        "content": {
            "application/json": {
                "schema": { "type": "string" },
                "example": "Description deleted"
            }
        }
    }
}