repo/rest-api/src/RouteHandlers/openapi.json
{
"openapi": "3.1.0",
"info": {
"title": "Wikibase REST API",
"version": "0.5",
"description": "OpenAPI definition of Wikibase REST API",
"contact": {
"name": "Wikimedia Deutschland - Wikibase Product Platform Team",
"url": "https://phabricator.wikimedia.org/project/board/6692/"
},
"license": {
"name": "GNU General Public License v2.0 or later",
"url": "https://spdx.org/licenses/GPL-2.0-or-later.html"
}
},
"paths": {
"/openapi.json": {
"get": {
"operationId": "getOpenApiDoc",
"tags": [
"OpenAPI document"
],
"summary": "Retrieve the OpenAPI document",
"responses": {
"200": {
"description": "OpenAPI document",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"openapi": "...",
"info": {
"title": "Wikibase REST API",
"version": "...",
"description": "OpenAPI definition of Wikibase REST API"
},
"paths": "..."
}
}
}
}
}
}
},
"/property-data-types": {
"get": {
"operationId": "getPropertyDataTypes",
"tags": [
"Property data types"
],
"summary": "Retrieve the map of Property data types to value types",
"responses": {
"200": {
"description": "The map of Property data types to value types",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"example": {
"data-type": "value-type"
}
}
}
}
}
}
},
"/entities/items": {
"post": {
"operationId": "addItem",
"tags": [
"items"
],
"summary": "Create a Wikibase Item",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"description": "Payload containing a Wikibase Item and edit metadata",
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"item": {
"$ref": "#/components/schemas/Item"
}
},
"required": [
"item"
]
},
{
"$ref": "#/components/requestBodies/Delete/content/application~1json/schema"
}
]
},
"example": {
"item": {
"labels": {
"en": "Jane Doe",
"ru": "Джейн Доу"
},
"descriptions": {
"en": "famous person",
"ru": "известная личность"
},
"aliases": {
"en": [
"Jane M. Doe",
"JD"
],
"ru": [
"Джейн М. Доу"
]
},
"statements": {
"P694": [
{
"property": {
"id": "P694"
},
"value": {
"type": "value",
"content": "Q626683"
}
}
],
"P476": [
{
"property": {
"id": "P476"
},
"value": {
"type": "value",
"content": {
"time": "+1986-01-27T00:00:00Z",
"precision": 11,
"calendarmodel": "http://www.wikidata.org/entity/Q1985727"
}
}
}
],
"P17": [
{
"property": {
"id": "P17"
},
"value": {
"type": "value",
"content": "Senior Team Supervisor"
},
"qualifiers": [
{
"property": {
"id": "P706"
},
"value": {
"type": "value",
"content": {
"time": "+2023-06-13T00:00:00Z",
"precision": 11,
"calendarmodel": "http://www.wikidata.org/entity/Q1985727"
}
}
}
],
"references": [
{
"parts": [
{
"property": {
"id": "P709"
},
"value": {
"type": "value",
"content": "http://www.example.org"
}
}
]
}
]
}
]
},
"sitelinks": {
"enwiki": {
"title": "Jane Doe"
},
"ruwiki": {
"title": "Джейн Доу"
}
}
},
"comment": "Create an Item for Jane Doe"
}
}
}
},
"responses": {
"201": {
"$ref": "#/components/responses/Item"
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
},
"statement-group-property-id-mismatch": {
"$ref": "#/components/examples/StatementGroupPropertyIdMismatch"
},
"referenced-resource-not-found": {
"$ref": "#/components/examples/ReferencedResourceNotFoundExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"missing-field": {
"$ref": "#/components/examples/MissingFieldExample"
},
"invalid-key": {
"$ref": "#/components/examples/InvalidKeyExample"
},
"resource-too-large": {
"$ref": "#/components/examples/ResourceTooLargeExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"422": {
"$ref": "#/components/responses/DataPolicyViolation"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/items/{item_id}": {
"get": {
"operationId": "getItem",
"tags": [
"items"
],
"summary": "Retrieve a single Wikibase Item by ID",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/ItemFields"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Item"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"308": {
"$ref": "#/components/responses/MovedPermanently"
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"invalid-query-parameter": {
"$ref": "#/components/examples/InvalidQueryParameterExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"patch": {
"operationId": "patchItem",
"tags": [
"items"
],
"summary": "Change a single Wikibase Item by ID",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"required": true,
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D/patch/requestBody/content/application~1json/example"
}
},
"application/json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"value": {
"patch": [
{
"op": "replace",
"path": "/labels/en",
"value": "Jane Doe"
}
],
"tags": [],
"bot": false,
"comment": "Update the English label"
}
}
}
}
},
"responses": {
"200": {
"$ref": "#/components/responses/Item"
},
"400": {
"$ref": "#/components/responses/InvalidPatch"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/CannotApplyItemPatch"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/InvalidPatchedItem"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/items/{item_id}/sitelinks": {
"get": {
"operationId": "getSitelinks",
"tags": [
"sitelinks"
],
"summary": "Retrieve an Item's Sitelinks",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Sitelinks"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"308": {
"$ref": "#/components/responses/MovedPermanently"
},
"400": {
"$ref": "#/components/responses/InvalidEntityIdInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"patch": {
"operationId": "patchSitelinks",
"tags": [
"sitelinks"
],
"summary": "Change an Item's Sitelinks",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"required": true,
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1sitelinks/patch/requestBody/content/application~1json/example"
}
},
"application/json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"value": {
"patch": [
{
"op": "add",
"path": "/ruwiki/title",
"value": "Джейн Доу"
}
],
"tags": [],
"bot": false,
"comment": "Add sitelink to ruwiki"
}
}
}
}
},
"responses": {
"200": {
"$ref": "#/components/responses/Sitelinks"
},
"400": {
"$ref": "#/components/responses/InvalidPatch"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/CannotApplyItemPatch"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"description": "Applying the provided JSON Patch results in invalid Sitelinks",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"patch-result-referenced-resource-not-found": {
"$ref": "#/components/examples/PatchResultResourceNotFoundExample"
},
"patch-result-invalid-value": {
"$ref": "#/components/examples/PatchResultInvalidValueExample"
},
"patch-result-missing-field": {
"$ref": "#/components/examples/PatchResultMissingFieldExample"
},
"patch-result-invalid-key": {
"$ref": "#/components/examples/PatchResultInvalidKeyExample"
},
"patch-result-modified-read-only-value": {
"$ref": "#/components/examples/PatchResultModifiedReadOnlyValue"
},
"data-policy-violation": {
"$ref": "#/components/examples/DataPolicyViolationExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/items/{item_id}/sitelinks/{site_id}": {
"get": {
"operationId": "getSitelink",
"tags": [
"sitelinks"
],
"summary": "Retrieve an Item's Sitelink",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/SiteId"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Sitelink"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"308": {
"$ref": "#/components/responses/MovedPermanently"
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"put": {
"operationId": "setSitelink",
"tags": [
"sitelinks"
],
"summary": "Add / Replace an Item's Sitelink",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/SiteId"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"description": "Payload containing a Wikibase Sitelink object and edit metadata",
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"sitelink": {
"$ref": "#/components/schemas/Sitelink"
}
},
"required": [
"sitelink"
]
},
{
"$ref": "#/components/requestBodies/Delete/content/application~1json/schema"
}
]
},
"example": {
"sitelink": {
"title": "Jane Doe",
"badges": []
},
"tags": [],
"bot": false,
"comment": "Add enwiki sitelink"
}
}
}
},
"responses": {
"200": {
"$ref": "#/components/responses/Sitelink",
"description": "The updated Sitelink"
},
"201": {
"$ref": "#/components/responses/Sitelink",
"description": "The newly added Sitelink"
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"missing-field": {
"$ref": "#/components/examples/MissingFieldExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
},
"referenced-resource-not-found": {
"$ref": "#/components/examples/ReferencedResourceNotFoundExample"
},
"resource-too-large": {
"$ref": "#/components/examples/ResourceTooLargeExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/ItemRedirected"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/DataPolicyViolation"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"delete": {
"operationId": "deleteSitelink",
"tags": [
"sitelinks"
],
"summary": "Delete an Item's Sitelink",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/SiteId"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Delete"
},
"responses": {
"200": {
"description": "The resource 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": "Sitelink deleted"
}
}
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/ItemRedirected"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/properties": {
"post": {
"operationId": "addProperty",
"tags": [
"properties"
],
"summary": "[WIP] Create a Wikibase Property",
"description": "This endpoint is currently in development and is not recommended for production use",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"description": "Payload containing a Wikibase Property and edit metadata",
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"property": {
"$ref": "#/components/schemas/Property"
}
},
"required": [
"property"
]
},
{
"$ref": "#/components/requestBodies/Delete/content/application~1json/schema"
}
]
},
"example": {
"property": {
"data_type": "wikibase-item",
"labels": {
"en": "instance of",
"ru": "это частный случай понятия"
},
"descriptions": {
"en": "this item is a concrete object (instance) of this class, category or object group",
"ru": "данный элемент представляет собой конкретный объект (экземпляр / частный случай) класса, категории"
},
"aliases": {
"en": [
"is a",
"is an"
],
"ru": [
"представляет собой",
"является"
]
},
"statements": {
"P1628": [
{
"property": {
"id": "P1628"
},
"value": {
"type": "value",
"content": "http://www.w3.org/1999/02/22-rdf-syntax-ns#type"
}
}
]
}
}
}
}
}
},
"responses": {
"201": {
"$ref": "#/components/responses/Property"
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
},
"statement-group-property-id-mismatch": {
"$ref": "#/components/examples/StatementGroupPropertyIdMismatch"
},
"referenced-resource-not-found": {
"$ref": "#/components/examples/ReferencedResourceNotFoundExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"missing-field": {
"$ref": "#/components/examples/MissingFieldExample"
},
"invalid-key": {
"$ref": "#/components/examples/InvalidKeyExample"
},
"resource-too-large": {
"$ref": "#/components/examples/ResourceTooLargeExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"422": {
"$ref": "#/components/responses/DataPolicyViolation"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/properties/{property_id}": {
"get": {
"operationId": "getProperty",
"tags": [
"properties"
],
"summary": "Retrieve a single Wikibase Property by ID",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/PropertyFields"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Property"
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"invalid-query-parameter": {
"$ref": "#/components/examples/InvalidQueryParameterExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"patch": {
"operationId": "patchProperty",
"tags": [
"properties"
],
"summary": "Change a single Wikibase Property by ID",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"required": true,
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"$ref": "#/paths/~1entities~1properties~1%7Bproperty_id%7D/patch/requestBody/content/application~1json/example"
}
},
"application/json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"patch": [
{
"op": "add",
"path": "/aliases/en/-",
"value": "is an"
}
],
"tags": [],
"bot": false,
"comment": "add 'is an' as an English alias"
}
}
}
},
"responses": {
"200": {
"$ref": "#/components/responses/Property"
},
"400": {
"$ref": "#/components/responses/InvalidPatch"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/CannotApplyPropertyPatch"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/InvalidPatchedProperty"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/items/{item_id}/descriptions": {
"get": {
"operationId": "getItemDescriptions",
"tags": [
"descriptions"
],
"summary": "Retrieve an Item's descriptions",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"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": "#/components/schemas/Descriptions"
},
"example": {
"en": "famous person",
"ru": "известная личность"
}
}
}
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"308": {
"$ref": "#/components/responses/MovedPermanently"
},
"400": {
"$ref": "#/components/responses/InvalidEntityIdInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"patch": {
"operationId": "patchItemDescriptions",
"tags": [
"descriptions"
],
"summary": "Change an Item's descriptions",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"description": "Payload containing a JSON Patch document to be applied to an Item's descriptions and edit metadata",
"required": true,
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1descriptions/patch/requestBody/content/application~1json/example"
}
},
"application/json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"patch": [
{
"op": "replace",
"path": "/en",
"value": "famous person"
}
],
"tags": [],
"bot": false,
"comment": "update English description"
}
}
}
},
"responses": {
"200": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1descriptions/get/responses/200"
},
"400": {
"$ref": "#/components/responses/InvalidPatch"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/CannotApplyItemPatch"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/InvalidPatchedDescriptions"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/properties/{property_id}/descriptions": {
"get": {
"operationId": "getPropertyDescriptions",
"tags": [
"descriptions"
],
"summary": "Retrieve a Property's descriptions",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"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": "#/components/schemas/Descriptions"
},
"example": {
"en": "this item is a concrete object (instance) of this class, category or object group",
"ru": "данный элемент представляет собой конкретный объект (экземпляр / частный случай) класса, категории"
}
}
}
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"$ref": "#/components/responses/InvalidEntityIdInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"patch": {
"operationId": "patchPropertyDescriptions",
"tags": [
"descriptions"
],
"summary": "Change a Property's descriptions",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"description": "Payload containing a JSON Patch document to be applied to a Property's descriptions and edit metadata",
"required": true,
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"$ref": "#/paths/~1entities~1properties~1%7Bproperty_id%7D~1descriptions/patch/requestBody/content/application~1json/example"
}
},
"application/json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"patch": [
{
"op": "replace",
"path": "/en",
"value": "this item is a concrete object (instance) of this class, category or object group"
}
],
"tags": [],
"bot": false,
"comment": "update English description"
}
}
}
},
"responses": {
"200": {
"$ref": "#/paths/~1entities~1properties~1%7Bproperty_id%7D~1descriptions/get/responses/200"
},
"400": {
"$ref": "#/components/responses/InvalidPatch"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/CannotApplyPropertyPatch"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/InvalidPatchedDescriptions"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/items/{item_id}/descriptions/{language_code}": {
"get": {
"operationId": "getItemDescription",
"tags": [
"descriptions"
],
"summary": "Retrieve an Item's description in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"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"
}
}
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"308": {
"$ref": "#/components/responses/MovedPermanently"
},
"400": {
"$ref": "#/components/responses/InvalidTermByLanguageInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"put": {
"operationId": "replaceItemDescription",
"tags": [
"descriptions"
],
"summary": "Add / Replace an Item's description in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"description": "Payload containing Item description in the specified language and edit metadata",
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"description": {
"type": "string"
}
},
"required": [
"description"
]
},
{
"$ref": "#/components/requestBodies/Delete/content/application~1json/schema"
}
]
},
"example": {
"description": "famous person",
"tags": [],
"bot": false,
"comment": "set English description"
}
}
}
},
"responses": {
"200": {
"description": "The updated description",
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1descriptions~1%7Blanguage_code%7D/get/responses/200"
},
"201": {
"description": "The newly added description",
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1descriptions~1%7Blanguage_code%7D/get/responses/200"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"$ref": "#/components/responses/InvalidSetDescriptionInput"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/ItemRedirected"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/DataPolicyViolation"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"delete": {
"operationId": "deleteItemDescription",
"tags": [
"descriptions"
],
"summary": "Delete an Item's description in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Delete"
},
"responses": {
"200": {
"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"
}
}
},
"400": {
"$ref": "#/components/responses/InvalidRemoveDescriptionInput"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/ItemRedirected"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/items/{item_id}/descriptions_with_language_fallback/{language_code}": {
"get": {
"operationId": "getItemDescriptionWithFallback",
"tags": [
"descriptions"
],
"summary": "Retrieve an Item's description in a specific language, with language fallback",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1descriptions~1%7Blanguage_code%7D/get/responses/200"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"307": {
"$ref": "#/components/responses/MovedTemporarily"
},
"308": {
"$ref": "#/components/responses/MovedPermanently"
},
"400": {
"$ref": "#/components/responses/InvalidTermByLanguageInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/properties/{property_id}/descriptions/{language_code}": {
"get": {
"operationId": "getPropertyDescription",
"tags": [
"descriptions"
],
"summary": "Retrieve a Property's description in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"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"
}
}
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"$ref": "#/components/responses/InvalidTermByLanguageInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"put": {
"operationId": "setPropertyDescription",
"tags": [
"descriptions"
],
"summary": "Add / Replace a Property's description in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"description": "Payload containing Property description in the specified language and edit metadata",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1descriptions~1%7Blanguage_code%7D/put/requestBody/content/application~1json/schema"
},
"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": "#/paths/~1entities~1properties~1%7Bproperty_id%7D~1descriptions~1%7Blanguage_code%7D/get/responses/200"
},
"201": {
"description": "The newly added description",
"$ref": "#/paths/~1entities~1properties~1%7Bproperty_id%7D~1descriptions~1%7Blanguage_code%7D/get/responses/200"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"$ref": "#/components/responses/InvalidSetDescriptionInput"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/DataPolicyViolation"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"delete": {
"operationId": "deletePropertyDescription",
"tags": [
"descriptions"
],
"summary": "Delete a Property's description in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Delete"
},
"responses": {
"200": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1descriptions~1%7Blanguage_code%7D/delete/responses/200"
},
"400": {
"$ref": "#/components/responses/InvalidRemoveDescriptionInput"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/properties/{property_id}/descriptions_with_language_fallback/{language_code}": {
"get": {
"operationId": "getPropertyDescriptionWithFallback",
"tags": [
"descriptions"
],
"summary": "Retrieve a Property's description in a specific language, with language fallback",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"$ref": "#/paths/~1entities~1properties~1%7Bproperty_id%7D~1descriptions~1%7Blanguage_code%7D/get/responses/200"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"307": {
"$ref": "#/components/responses/MovedTemporarily"
},
"400": {
"$ref": "#/components/responses/InvalidTermByLanguageInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/items/{item_id}/statements": {
"get": {
"operationId": "getItemStatements",
"tags": [
"statements"
],
"summary": "Retrieve Statements from an Item",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/PropertyFilter"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"description": "The Statements of an Item",
"headers": {
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date"
},
"ETag": {
"schema": {
"type": "string"
},
"description": "Last entity revision number"
},
"X-Authenticated-User": {
"schema": {
"type": "string"
},
"description": "Optional username of the user making the request"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/responses/Statement/content/application~1json/schema"
}
}
},
"example": {
"P370": [
{
"id": "Q11$6403c562-401a-2b26-85cc-8327801145e1",
"rank": "normal",
"property": {
"id": "P370",
"data_type": "string"
},
"value": {
"content": "I am a goat",
"type": "value"
},
"qualifiers": [],
"references": []
}
],
"P92": [
{
"id": "Q11$6403c562-401a-2b26-85cc-8327801145e1",
"rank": "normal",
"property": {
"id": "P92",
"data_type": "string"
},
"value": {
"content": "I am a goat",
"type": "value"
},
"qualifiers": [],
"references": []
}
]
}
}
}
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"308": {
"$ref": "#/components/responses/MovedPermanently"
},
"400": {
"$ref": "#/components/responses/InvalidRetrieveStatementsInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"post": {
"operationId": "addItemStatement",
"tags": [
"statements"
],
"summary": "Add a new Statement to an Item",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Statement"
},
"responses": {
"201": {
"description": "A single newly created Wikibase Statement. Please note that the value of the `ETag` header field refers to the entity's revision ID.",
"headers": {
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date"
},
"ETag": {
"schema": {
"type": "string"
},
"description": "Last entity revision number"
},
"X-Authenticated-User": {
"schema": {
"type": "string"
},
"description": "Optional username of the user making the request"
},
"Location": {
"schema": {
"type": "string"
},
"description": "The URI of the newly created Statement"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/Statement/content/application~1json/schema"
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidNewStatementInput"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/ItemRedirected"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/items/{item_id}/statements/{statement_id}": {
"get": {
"operationId": "getItemStatement",
"tags": [
"statements"
],
"summary": "Retrieve a single Statement from an Item",
"description": "This endpoint is also accessible through `/statements/{statement_id}`",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/ItemStatementId"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemStatement"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"item-statement-id-mismatch": {
"$ref": "#/components/examples/ItemStatementIdMismatchExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"put": {
"operationId": "replaceItemStatement",
"tags": [
"statements"
],
"summary": "Replace a single Statement of an Item",
"description": "This endpoint is also accessible through `/statements/{statement_id}`",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/ItemStatementId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Statement"
},
"responses": {
"200": {
"$ref": "#/components/responses/ItemStatement"
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"item-statement-id-mismatch": {
"$ref": "#/components/examples/ItemStatementIdMismatchExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"missing-field": {
"$ref": "#/components/examples/MissingFieldExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
},
"cannot-modify-read-only-value": {
"$ref": "#/components/examples/CannotModifyReadOnlyValue"
},
"referenced-resource-not-found": {
"$ref": "#/components/examples/ReferencedResourceNotFoundExample"
},
"resource-too-large": {
"$ref": "#/components/examples/ResourceTooLargeExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"patch": {
"operationId": "patchItemStatement",
"tags": [
"statements"
],
"summary": "Change elements of a single Statement of an Item",
"description": "This endpoint is also accessible through `/statements/{statement_id}`.",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/ItemStatementId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/StatementPatch"
},
"responses": {
"200": {
"$ref": "#/components/responses/ItemStatement"
},
"400": {
"description": "The provided JSON Patch is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"item-statement-id-mismatch": {
"$ref": "#/components/examples/ItemStatementIdMismatchExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"missing-field": {
"$ref": "#/components/examples/MissingFieldExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
},
"resource-too-large": {
"$ref": "#/components/examples/ResourceTooLargeExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/CannotApplyStatementPatch"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/InvalidPatchedStatement"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"delete": {
"operationId": "deleteItemStatement",
"tags": [
"statements"
],
"summary": "Delete a single Statement from an Item",
"description": "This endpoint is also accessible through `/statements/{statement_id}`",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/ItemStatementId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Delete"
},
"responses": {
"200": {
"$ref": "#/components/responses/StatementDeleted"
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"item-statement-id-mismatch": {
"$ref": "#/components/examples/ItemStatementIdMismatchExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/items/{item_id}/labels": {
"get": {
"operationId": "getItemLabels",
"tags": [
"labels"
],
"summary": "Retrieve an Item's labels",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"description": "Item's labels 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": "#/components/schemas/Labels"
},
"example": {
"en": "Jane Doe",
"ru": "Джейн Доу"
}
}
}
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"308": {
"$ref": "#/components/responses/MovedPermanently"
},
"400": {
"$ref": "#/components/responses/InvalidEntityIdInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"patch": {
"operationId": "patchItemLabels",
"tags": [
"labels"
],
"summary": "Change an Item's Labels",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"description": "Payload containing a JSON Patch document to be applied to Labels and edit metadata",
"required": true,
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1labels/patch/requestBody/content/application~1json/example"
}
},
"application/json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"patch": [
{
"op": "replace",
"path": "/en",
"value": "Jane Doe"
}
],
"tags": [],
"bot": false,
"comment": "replace English label"
}
}
}
},
"responses": {
"200": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1labels/get/responses/200"
},
"400": {
"$ref": "#/components/responses/InvalidPatch"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/CannotApplyItemPatch"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/InvalidPatchedLabels"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/properties/{property_id}/labels": {
"get": {
"operationId": "getPropertyLabels",
"tags": [
"labels"
],
"summary": "Retrieve a Property's labels",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"description": "Property's labels 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": "#/components/schemas/Labels"
},
"example": {
"en": "instance of",
"ru": "это частный случай понятия"
}
}
}
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"$ref": "#/components/responses/InvalidEntityIdInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"patch": {
"operationId": "patchPropertyLabels",
"tags": [
"labels"
],
"summary": "Change a Property's Labels",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"description": "Payload containing a JSON Patch document to be applied to Labels and edit metadata",
"required": true,
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"$ref": "#/paths/~1entities~1properties~1%7Bproperty_id%7D~1labels/patch/requestBody/content/application~1json/example"
}
},
"application/json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"patch": [
{
"op": "replace",
"path": "/en",
"value": "instance of"
}
],
"tags": [],
"bot": false,
"comment": "replace English label"
}
}
}
},
"responses": {
"200": {
"$ref": "#/paths/~1entities~1properties~1%7Bproperty_id%7D~1labels/get/responses/200"
},
"400": {
"$ref": "#/components/responses/InvalidPatch"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/CannotApplyPropertyPatch"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/InvalidPatchedLabels"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/items/{item_id}/labels/{language_code}": {
"get": {
"operationId": "getItemLabel",
"tags": [
"labels"
],
"summary": "Retrieve an Item's label in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"description": "A label 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": "Jane Doe"
}
}
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"308": {
"$ref": "#/components/responses/MovedPermanently"
},
"400": {
"$ref": "#/components/responses/InvalidTermByLanguageInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"put": {
"operationId": "replaceItemLabel",
"tags": [
"labels"
],
"summary": "Add / Replace an Item's label in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"description": "Payload containing an Item label in the specified language and edit metadata",
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"label": {
"type": "string"
}
},
"required": [
"label"
]
},
{
"$ref": "#/components/requestBodies/Delete/content/application~1json/schema"
}
]
},
"example": {
"label": "Jane Doe",
"tags": [],
"bot": false,
"comment": "Update the English label"
}
}
}
},
"responses": {
"200": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1labels~1%7Blanguage_code%7D/get/responses/200",
"description": "The updated Label in a specific language"
},
"201": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1labels~1%7Blanguage_code%7D/get/responses/200",
"description": "The newly added Label in a specific language"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"$ref": "#/components/responses/InvalidSetLabelInput"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/ItemRedirected"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/DataPolicyViolation"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"delete": {
"operationId": "deleteItemLabel",
"tags": [
"labels"
],
"summary": "Delete an Item's label in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Delete"
},
"responses": {
"200": {
"description": "The resource 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": "Label deleted"
}
}
},
"400": {
"$ref": "#/components/responses/InvalidRemoveLabelInput"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/ItemRedirected"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/items/{item_id}/labels_with_language_fallback/{language_code}": {
"get": {
"operationId": "getItemLabelWithFallback",
"tags": [
"labels"
],
"summary": "Retrieve an Item's label in a specific language, with language fallback",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1labels~1%7Blanguage_code%7D/get/responses/200"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"307": {
"$ref": "#/components/responses/MovedTemporarily"
},
"308": {
"$ref": "#/components/responses/MovedPermanently"
},
"400": {
"$ref": "#/components/responses/InvalidTermByLanguageInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/properties/{property_id}/labels/{language_code}": {
"get": {
"operationId": "getPropertyLabel",
"tags": [
"labels"
],
"summary": "Retrieve a Property's label in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"description": "A label 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": "instance of"
}
}
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"$ref": "#/components/responses/InvalidTermByLanguageInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"put": {
"operationId": "replacePropertyLabel",
"tags": [
"labels"
],
"summary": "Add / Replace a Property's label in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"description": "Payload containing a Property label in the specified language and edit metadata",
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"label": {
"type": "string"
}
},
"required": [
"label"
]
},
{
"$ref": "#/components/requestBodies/Delete/content/application~1json/schema"
}
]
},
"example": {
"label": "instance of",
"tags": [],
"bot": false,
"comment": "Update the English label"
}
}
}
},
"responses": {
"200": {
"$ref": "#/paths/~1entities~1properties~1%7Bproperty_id%7D~1labels~1%7Blanguage_code%7D/get/responses/200",
"description": "The updated Label in a specific language"
},
"201": {
"$ref": "#/paths/~1entities~1properties~1%7Bproperty_id%7D~1labels~1%7Blanguage_code%7D/get/responses/200",
"description": "The newly added Label in a specific language"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"$ref": "#/components/responses/InvalidSetLabelInput"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/DataPolicyViolation"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"delete": {
"operationId": "deletePropertyLabel",
"tags": [
"labels"
],
"summary": "Delete a Property's label in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Delete"
},
"responses": {
"200": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1labels~1%7Blanguage_code%7D/delete/responses/200"
},
"400": {
"$ref": "#/components/responses/InvalidRemoveLabelInput"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/properties/{property_id}/labels_with_language_fallback/{language_code}": {
"get": {
"operationId": "getPropertyLabelWithFallback",
"tags": [
"labels"
],
"summary": "Retrieve a Property's label in a specific language, with language fallback",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"$ref": "#/paths/~1entities~1properties~1%7Bproperty_id%7D~1labels~1%7Blanguage_code%7D/get/responses/200"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"307": {
"$ref": "#/components/responses/MovedTemporarily"
},
"400": {
"$ref": "#/components/responses/InvalidTermByLanguageInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/items/{item_id}/aliases": {
"get": {
"operationId": "getItemAliases",
"tags": [
"aliases"
],
"summary": "Retrieve an Item's aliases",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"description": "Item's aliases by language",
"headers": {
"ETag": {
"description": "Last entity revision number",
"schema": {
"type": "string"
}
},
"Last-Modified": {
"description": "Last modified date",
"schema": {
"type": "string"
}
},
"X-Authenticated-User": {
"description": "Optional username of the user making the request",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Aliases"
},
"example": {
"en": [
"Jane M. Doe",
"JD"
],
"ru": [
"Джейн М. Доу"
]
}
}
}
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"308": {
"$ref": "#/components/responses/MovedPermanently"
},
"400": {
"$ref": "#/components/responses/InvalidEntityIdInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"patch": {
"operationId": "patchItemAliases",
"tags": [
"aliases"
],
"summary": "Change an Item's aliases",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"description": "Payload containing a JSON Patch document to be applied to an Item's aliases and edit metadata",
"required": true,
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/example"
}
},
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"patch": {
"description": "A JSON Patch document as defined by RFC 6902",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"description": "The operation to perform",
"type": "string",
"enum": [
"add",
"copy",
"move",
"remove",
"replace",
"test"
]
},
"path": {
"description": "A JSON Pointer",
"type": "string"
},
"from": {
"description": "A JSON Pointer",
"type": "string"
},
"value": {
"description": "The value to be used within the operation"
}
},
"required": [
"op",
"path"
]
}
}
},
"required": [
"patch"
]
},
{
"$ref": "#/components/requestBodies/Delete/content/application~1json/schema"
}
]
},
"example": {
"patch": [
{
"op": "add",
"path": "/en/-",
"value": "JD"
}
],
"tags": [],
"bot": false,
"comment": "Add English alias"
}
}
}
},
"responses": {
"200": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/get/responses/200"
},
"400": {
"$ref": "#/components/responses/InvalidPatch"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/CannotApplyItemPatch"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/InvalidPatchedAliases"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/properties/{property_id}/aliases": {
"get": {
"operationId": "getPropertyAliases",
"tags": [
"aliases"
],
"summary": "Retrieve a Property's aliases",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"description": "Property's aliases by language",
"headers": {
"ETag": {
"description": "Last entity revision number",
"schema": {
"type": "string"
}
},
"Last-Modified": {
"description": "Last modified date",
"schema": {
"type": "string"
}
},
"X-Authenticated-User": {
"description": "Optional username of the user making the request",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Aliases"
},
"example": {
"en": [
"is a",
"is an"
],
"ru": [
"представляет собой",
"является"
]
}
}
}
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"$ref": "#/components/responses/InvalidEntityIdInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"patch": {
"operationId": "patchPropertyAliases",
"tags": [
"aliases"
],
"summary": "Change a Property's aliases",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"description": "Payload containing a JSON Patch document to be applied to a Property's aliases and edit metadata",
"required": true,
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"$ref": "#/paths/~1entities~1properties~1%7Bproperty_id%7D~1aliases/patch/requestBody/content/application~1json/example"
}
},
"application/json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema"
},
"example": {
"patch": [
{
"op": "add",
"path": "/en/-",
"value": "is an"
}
],
"tags": [],
"bot": false,
"comment": "Add English alias"
}
}
}
},
"responses": {
"200": {
"$ref": "#/paths/~1entities~1properties~1%7Bproperty_id%7D~1aliases/get/responses/200"
},
"400": {
"$ref": "#/components/responses/InvalidPatch"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/CannotApplyPropertyPatch"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/InvalidPatchedAliases"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/items/{item_id}/aliases/{language_code}": {
"get": {
"operationId": "getItemAliasesInLanguage",
"tags": [
"aliases"
],
"summary": "Retrieve an Item's aliases in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"description": "Item's aliases in a specific language",
"headers": {
"ETag": {
"description": "Last entity revision number",
"schema": {
"type": "string"
}
},
"Last-Modified": {
"description": "Last modified date",
"schema": {
"type": "string"
}
},
"X-Authenticated-User": {
"description": "Optional username of the user making the request",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"Jane M. Doe",
"JD"
]
}
}
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"308": {
"$ref": "#/components/responses/MovedPermanently"
},
"400": {
"$ref": "#/components/responses/InvalidTermByLanguageInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"post": {
"operationId": "addItemAliasesInLanguage",
"tags": [
"aliases"
],
"summary": "Create / Add an Item's aliases in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/ItemId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"description": "Payload containing a list of Item aliases in the specified language and edit metadata",
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"aliases": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"aliases"
]
},
{
"$ref": "#/components/requestBodies/Delete/content/application~1json/schema"
}
]
},
"example": {
"aliases": [
"JD"
],
"tags": [],
"bot": false,
"comment": "Add English alias"
}
}
}
},
"responses": {
"200": {
"description": "The updated list of aliases in a specific language",
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases~1%7Blanguage_code%7D/get/responses/200"
},
"201": {
"description": "The newly created list of aliases in a specific language",
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases~1%7Blanguage_code%7D/get/responses/200"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"$ref": "#/components/responses/InvalidAddAliasesInput"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/ItemRedirected"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/properties/{property_id}/aliases/{language_code}": {
"get": {
"operationId": "getPropertyAliasesInLanguage",
"tags": [
"aliases"
],
"summary": "Retrieve a Property's aliases in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"description": "Property's aliases in a specific language",
"headers": {
"ETag": {
"description": "Last entity revision number",
"schema": {
"type": "string"
}
},
"Last-Modified": {
"description": "Last modified date",
"schema": {
"type": "string"
}
},
"X-Authenticated-User": {
"description": "Optional username of the user making the request",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"is a",
"is an"
]
}
}
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"$ref": "#/components/responses/InvalidTermByLanguageInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"post": {
"operationId": "addPropertyAliasesInLanguage",
"tags": [
"aliases"
],
"summary": "Create / Add a Property's aliases in a specific language",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/LanguageCode"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"description": "Payload containing a list of Wikibase aliases in the specified language and edit metadata",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases~1%7Blanguage_code%7D/post/requestBody/content/application~1json/schema"
},
"example": {
"aliases": [
"is an"
],
"tags": [],
"bot": false,
"comment": "Add English alias"
}
}
}
},
"responses": {
"200": {
"description": "The updated list of aliases in a specific language",
"$ref": "#/paths/~1entities~1properties~1%7Bproperty_id%7D~1aliases~1%7Blanguage_code%7D/get/responses/200"
},
"201": {
"description": "The newly created list of aliases in a specific language",
"$ref": "#/paths/~1entities~1properties~1%7Bproperty_id%7D~1aliases~1%7Blanguage_code%7D/get/responses/200"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"$ref": "#/components/responses/InvalidAddAliasesInput"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/properties/{property_id}/statements": {
"get": {
"operationId": "getPropertyStatements",
"tags": [
"statements"
],
"summary": "Retrieve Statements from a Property",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/PropertyFilter"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"description": "The Statements of a Property",
"headers": {
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date"
},
"ETag": {
"schema": {
"type": "string"
},
"description": "Last entity revision number"
},
"X-Authenticated-User": {
"schema": {
"type": "string"
},
"description": "Optional username of the user making the request"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/responses/Statement/content/application~1json/schema"
}
}
},
"example": {
"P370": [
{
"id": "P11$6403c562-401a-2b26-85cc-8327801145e1",
"rank": "normal",
"property": {
"id": "P370",
"data_type": "string"
},
"value": {
"content": "I am a goat",
"type": "value"
},
"qualifiers": [],
"references": []
}
],
"P92": [
{
"id": "P11$6403c562-401a-2b26-85cc-8327801145e1",
"rank": "normal",
"property": {
"id": "P92",
"data_type": "string"
},
"value": {
"content": "I am a goat",
"type": "value"
},
"qualifiers": [],
"references": []
}
]
}
}
}
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"$ref": "#/components/responses/InvalidRetrieveStatementsInput"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"post": {
"operationId": "addPropertyStatement",
"tags": [
"statements"
],
"summary": "Add a new Statement to a Property",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Statement"
},
"responses": {
"201": {
"description": "A single newly created Wikibase Statement. Please note that the value of the `ETag` header field refers to the entity's revision ID.",
"headers": {
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date"
},
"ETag": {
"schema": {
"type": "string"
},
"description": "Last entity revision number"
},
"X-Authenticated-User": {
"schema": {
"type": "string"
},
"description": "Optional username of the user making the request"
},
"Location": {
"schema": {
"type": "string"
},
"description": "The URI of the newly created Statement"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/Statement/content/application~1json/schema"
},
"example": {
"$ref": "#/components/examples/PropertyStatementResponseExample/value"
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidNewStatementInput"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/entities/properties/{property_id}/statements/{statement_id}": {
"get": {
"operationId": "getPropertyStatement",
"tags": [
"statements"
],
"summary": "Retrieve a single Statement from a Property",
"description": "This endpoint is also accessible through `/statements/{statement_id}`",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/PropertyStatementId"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/PropertyStatement"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"property-statement-id-mismatch": {
"$ref": "#/components/examples/PropertyStatementIdMismatchExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"put": {
"operationId": "replacePropertyStatement",
"tags": [
"statements"
],
"summary": "Replace a single Statement of a Property",
"description": "This endpoint is also accessible through `/statements/{statement_id}`",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/PropertyStatementId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Statement"
},
"responses": {
"200": {
"$ref": "#/components/responses/PropertyStatement"
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"property-statement-id-mismatch": {
"$ref": "#/components/examples/PropertyStatementIdMismatchExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"missing-field": {
"$ref": "#/components/examples/MissingFieldExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
},
"cannot-modify-read-only-value": {
"$ref": "#/components/examples/CannotModifyReadOnlyValue"
},
"referenced-resource-not-found": {
"$ref": "#/components/examples/ReferencedResourceNotFoundExample"
},
"resource-too-large": {
"$ref": "#/components/examples/ResourceTooLargeExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"patch": {
"operationId": "patchPropertyStatement",
"tags": [
"statements"
],
"summary": "Change elements of a single Statement of a Property",
"description": "This endpoint is also accessible through `/statements/{statement_id}`.",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/PropertyStatementId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/StatementPatch"
},
"responses": {
"200": {
"$ref": "#/components/responses/PropertyStatement"
},
"400": {
"description": "The provided JSON Patch is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"property-statement-id-mismatch": {
"$ref": "#/components/examples/PropertyStatementIdMismatchExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"missing-field": {
"$ref": "#/components/examples/MissingFieldExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
},
"resource-too-large": {
"$ref": "#/components/examples/ResourceTooLargeExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/CannotApplyStatementPatch"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/InvalidPatchedStatement"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"delete": {
"operationId": "deletePropertyStatement",
"tags": [
"statements"
],
"summary": "Delete a single Statement from a Property",
"description": "This endpoint is also accessible through `/statements/{statement_id}`.",
"parameters": [
{
"$ref": "#/components/parameters/PropertyId"
},
{
"$ref": "#/components/parameters/PropertyStatementId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Delete"
},
"responses": {
"200": {
"$ref": "#/components/responses/StatementDeleted"
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"property-statement-id-mismatch": {
"$ref": "#/components/examples/PropertyStatementIdMismatchExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/statements/{statement_id}": {
"get": {
"operationId": "getStatement",
"tags": [
"statements"
],
"summary": "Retrieve a single Statement",
"description": "This endpoint is also accessible through `/entities/items/{item_id}/statements/{statement_id}` and `/entities/properties/{property_id}/statements/{statement_id}`",
"parameters": [
{
"$ref": "#/components/parameters/StatementId"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfModifiedSince"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Statement"
},
"304": {
"$ref": "#/components/responses/NotModified"
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"put": {
"operationId": "replaceStatement",
"tags": [
"statements"
],
"summary": "Replace a single Statement",
"description": "This endpoint is also accessible through `/entities/items/{item_id}/statements/{statement_id}` and `/entities/properties/{property_id}/statements/{statement_id}`",
"parameters": [
{
"$ref": "#/components/parameters/StatementId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Statement"
},
"responses": {
"200": {
"$ref": "#/components/responses/Statement"
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"missing-field": {
"$ref": "#/components/examples/MissingFieldExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
},
"cannot-modify-read-only-value": {
"$ref": "#/components/examples/CannotModifyReadOnlyValue"
},
"resource-too-large": {
"$ref": "#/components/examples/ResourceTooLargeExample"
},
"referenced-resource-not-found": {
"$ref": "#/components/examples/ReferencedResourceNotFoundExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"patch": {
"operationId": "patchStatement",
"tags": [
"statements"
],
"summary": "Change elements of a single Statement",
"description": "This endpoint is also accessible through `/entities/items/{item_id}/statements/{statement_id}` and `/entities/properties/{property_id}/statements/{statement_id}`",
"parameters": [
{
"$ref": "#/components/parameters/StatementId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/StatementPatch"
},
"responses": {
"200": {
"$ref": "#/components/responses/Statement"
},
"400": {
"$ref": "#/components/responses/InvalidPatch"
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"409": {
"$ref": "#/components/responses/CannotApplyStatementPatch"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"422": {
"$ref": "#/components/responses/InvalidPatchedStatement"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"delete": {
"operationId": "deleteStatement",
"tags": [
"statements"
],
"summary": "Delete a single Statement",
"description": "This endpoint is also accessible through `/entities/items/{item_id}/statements/{statement_id}` and `/entities/properties/{property_id}/statements/{statement_id}`",
"parameters": [
{
"$ref": "#/components/parameters/StatementId"
},
{
"$ref": "#/components/parameters/IfMatch"
},
{
"$ref": "#/components/parameters/IfNoneMatch"
},
{
"$ref": "#/components/parameters/IfUnmodifiedSince"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Delete"
},
"responses": {
"200": {
"$ref": "#/components/responses/StatementDeleted"
},
"400": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"403": {
"$ref": "#/components/responses/PermissionDenied"
},
"404": {
"$ref": "#/components/responses/ResourceNotFound"
},
"412": {
"$ref": "#/components/responses/PreconditionFailedError"
},
"429": {
"$ref": "#/components/responses/RequestLimitReached"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
}
},
"components": {
"parameters": {
"ItemId": {
"in": "path",
"name": "item_id",
"description": "The ID of the required Item",
"required": true,
"schema": {
"type": "string",
"pattern": "^Q[1-9]\\d{0,9}$"
},
"example": "Q24"
},
"PropertyId": {
"in": "path",
"name": "property_id",
"description": "The ID of the required Property",
"required": true,
"schema": {
"type": "string",
"pattern": "^P[1-9]\\d{0,9}$"
},
"example": "P694"
},
"StatementId": {
"in": "path",
"name": "statement_id",
"description": "The ID of the required Statement",
"required": true,
"schema": {
"type": "string",
"pattern": "^(Q|q|P|p)[1-9]\\d{0,9}\\$.+$"
},
"examples": {
"Statement on an Item": {
"$ref": "#/components/examples/ItemStatementIdExample"
},
"Statement on a Property": {
"$ref": "#/components/examples/PropertyStatementIdExample"
}
}
},
"ItemStatementId": {
"in": "path",
"name": "statement_id",
"description": "The ID of the required Item Statement",
"required": true,
"schema": {
"type": "string",
"pattern": "^(Q|q)[1-9]\\d{0,9}\\$.+$"
},
"example": {
"$ref": "#/components/examples/ItemStatementIdExample/value"
}
},
"PropertyStatementId": {
"in": "path",
"name": "statement_id",
"description": "The ID of the required Property Statement",
"required": true,
"schema": {
"type": "string",
"pattern": "^(P|p)[1-9]\\d{0,9}\\$.+$"
},
"example": {
"$ref": "#/components/examples/PropertyStatementIdExample/value"
}
},
"LanguageCode": {
"in": "path",
"name": "language_code",
"description": "The requested resource language",
"required": true,
"schema": {
"type": "string",
"pattern": "^[a-z]{2}[a-z0-9-]*$"
},
"example": "en"
},
"SiteId": {
"in": "path",
"name": "site_id",
"description": "The ID of the required Site",
"required": true,
"schema": {
"type": "string"
},
"example": "enwiki"
},
"ItemFields": {
"in": "query",
"name": "_fields",
"description": "Comma-separated list of fields to include in each response object.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"type",
"labels",
"descriptions",
"aliases",
"statements",
"sitelinks"
]
}
},
"explode": false,
"style": "form"
},
"PropertyFields": {
"in": "query",
"name": "_fields",
"description": "Comma-separated list of fields to include in each response object.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"type",
"data_type",
"labels",
"descriptions",
"aliases",
"statements"
]
}
},
"explode": false,
"style": "form"
},
"PropertyFilter": {
"in": "query",
"name": "property",
"description": "Single Property ID to filter Statements by.",
"required": false,
"schema": {
"type": "string",
"pattern": "^P[1-9]\\d{0,9}$"
},
"style": "form",
"example": "P31"
},
"IfNoneMatch": {
"name": "If-None-Match",
"in": "header",
"description": "Conditionally perform the request only if the resource has been modified since the specified entity revision numbers",
"schema": {
"type": "array",
"items": {
"type": "string",
"pattern": "^(?:\".+\"|\\*)$"
}
},
"example": [
"\"1276705620\""
]
},
"IfModifiedSince": {
"name": "If-Modified-Since",
"in": "header",
"description": "Conditionally perform the request only if the resource has been modified after the specified date",
"schema": {
"type": "string",
"format": "http-date"
},
"example": "Sat, 06 Jun 2020 16:38:47 GMT"
},
"IfMatch": {
"name": "If-Match",
"in": "header",
"description": "Conditionally perform the request only if the resource has not been modified since one of the specified entity revision numbers",
"schema": {
"type": "array",
"items": {
"type": "string",
"pattern": "^(?:\".+\"|\\*)$"
}
},
"example": [
"\"1276705620\""
]
},
"IfUnmodifiedSince": {
"name": "If-Unmodified-Since",
"in": "header",
"description": "Conditionally perform the request only if the resource has not been modified after the specified date",
"schema": {
"type": "string",
"format": "http-date"
},
"example": "Sat, 06 Jun 2020 16:38:47 GMT"
},
"Authorization": {
"name": "Authorization",
"in": "header",
"description": "Make authenticated request using a provided bearer token",
"schema": {
"type": "string"
},
"example": "Bearer mF_9.B5f-4.1JqM"
}
},
"requestBodies": {
"Statement": {
"description": "Payload containing a Wikibase Statement object and edit metadata",
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"statement": {
"allOf": [
{
"$ref": "#/components/schemas/Statement"
},
{
"allOf": [
{
"required": [
"property",
"value"
],
"properties": {
"property": {
"required": [
"id"
]
},
"value": {
"required": [
"type"
]
}
}
},
{
"properties": {
"qualifiers": {
"items": {
"$ref": "#/paths/~1statements~1%7Bstatement_id%7D/put/requestBody/content/application~1json/schema/allOf/0/properties/statement/allOf/1/allOf/0"
}
},
"references": {
"items": {
"required": [
"parts"
],
"properties": {
"parts": {
"items": {
"$ref": "#/paths/~1statements~1%7Bstatement_id%7D/put/requestBody/content/application~1json/schema/allOf/0/properties/statement/allOf/1/allOf/0"
}
}
}
}
}
}
}
]
}
]
}
},
"required": [
"statement"
]
},
{
"$ref": "#/components/requestBodies/Delete/content/application~1json/schema"
}
]
}
}
}
},
"StatementPatch": {
"description": "Payload containing a JSON Patch document to be applied to a Statement and edit metadata",
"required": true,
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/requestBodies/StatementPatch/content/application~1json/schema"
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1entities~1items~1%7Bitem_id%7D~1aliases/patch/requestBody/content/application~1json/schema/allOf/0"
},
{
"properties": {
"patch": {
"items": {
"properties": {
"path": {
"example": "/value/content"
},
"value": {
"example": "Q5"
}
}
}
}
}
},
{
"$ref": "#/components/requestBodies/Delete/content/application~1json/schema"
}
]
}
}
}
},
"Delete": {
"description": "Edit payload containing edit metadata",
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"bot": {
"type": "boolean",
"default": false
},
"comment": {
"type": "string"
}
}
},
"example": {
"tags": [],
"bot": false,
"comment": "API edit fixing the modelling as discussed in ..."
}
}
}
}
},
"responses": {
"StatementDeleted": {
"description": "The resource 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": "Statement deleted"
}
}
},
"ItemRedirected": {
"description": "The specified Item was redirected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"redirected-item": {
"$ref": "#/components/examples/RedirectedItemExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"DataPolicyViolation": {
"description": "The edit request violates data policy",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"data-policy-violation": {
"$ref": "#/components/examples/DataPolicyViolationExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"PermissionDenied": {
"description": "The access to resource was denied",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"permission-denied": {
"$ref": "#/components/examples/PermissionDeniedExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"RequestLimitReached": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"request-limit-reached": {
"value": {
"code": "request-limit-reached",
"message": "Exceeded the limit of actions that can be performed in a given span of time",
"context": {
"reason": "{reason_code}"
}
}
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"ResourceNotFound": {
"description": "The specified resource was not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"resource-not-found": {
"$ref": "#/components/examples/ResourceNotFoundExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidEntityIdInput": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidRetrieveStatementsInput": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"invalid-query-parameter": {
"$ref": "#/components/examples/InvalidQueryParameterExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidNewStatementInput": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"missing-field": {
"$ref": "#/components/examples/MissingFieldExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
},
"resource-too-large": {
"$ref": "#/components/examples/ResourceTooLargeExample"
},
"referenced-resource-not-found": {
"$ref": "#/components/examples/ReferencedResourceNotFoundExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidSetLabelInput": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"missing-field": {
"$ref": "#/components/examples/MissingFieldExample"
},
"resource-too-large": {
"$ref": "#/components/examples/ResourceTooLargeExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidSetDescriptionInput": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"missing-field": {
"$ref": "#/components/examples/MissingFieldExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
},
"resource-too-large": {
"$ref": "#/components/examples/ResourceTooLargeExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidRemoveLabelInput": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidRemoveDescriptionInput": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidAddAliasesInput": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"missing-field": {
"$ref": "#/components/examples/MissingFieldExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
},
"resource-too-large": {
"$ref": "#/components/examples/ResourceTooLargeExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidTermByLanguageInput": {
"description": "The request cannot be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidPatch": {
"description": "The provided JSON Patch request is invalid",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"context": {
"type": "object"
}
},
"required": [
"code",
"message"
]
},
"examples": {
"invalid-path-parameter": {
"$ref": "#/components/examples/InvalidPathParameterExample"
},
"invalid-value": {
"$ref": "#/components/examples/InvalidValueExample"
},
"missing-field": {
"$ref": "#/components/examples/MissingFieldExample"
},
"value-too-long": {
"$ref": "#/components/examples/ValueTooLongExample"
},
"resource-too-large": {
"$ref": "#/components/examples/ResourceTooLargeExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"CannotApplyItemPatch": {
"description": "The provided JSON Patch cannot be applied",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"redirected-item": {
"$ref": "#/components/examples/RedirectedItemExample"
},
"patch-test-failed": {
"$ref": "#/components/examples/PatchTestFailedExample"
},
"patch-target-not-found": {
"$ref": "#/components/examples/PatchTargetNotFoundExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"CannotApplyPropertyPatch": {
"description": "The provided JSON Patch cannot be applied",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"patch-test-failed": {
"$ref": "#/components/examples/PatchTestFailedExample"
},
"patch-target-not-found": {
"$ref": "#/components/examples/PatchTargetNotFoundExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidPatchedItem": {
"description": "Applying the provided JSON Patch results in an invalid Property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"patch-result-invalid-value": {
"$ref": "#/components/examples/PatchResultInvalidValueExample"
},
"patched-statement-group-property-id-mismatch": {
"$ref": "#/components/examples/PatchedStatementGroupPropertyIdMismatchExample"
},
"patch-result-referenced-resource-not-found": {
"$ref": "#/components/examples/PatchResultResourceNotFoundExample"
},
"patch-result-missing-field": {
"$ref": "#/components/examples/PatchResultMissingFieldExample"
},
"patch-result-invalid-key": {
"$ref": "#/components/examples/PatchResultInvalidKeyExample"
},
"patch-result-value-too-long": {
"$ref": "#/components/examples/PatchResultValueTooLongExample"
},
"patch-result-modified-read-only-value": {
"$ref": "#/components/examples/PatchResultModifiedReadOnlyValue"
},
"data-policy-violation": {
"$ref": "#/components/examples/DataPolicyViolationExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidPatchedProperty": {
"description": "Applying the provided JSON Patch results in an invalid Property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"patch-result-missing-field": {
"$ref": "#/components/examples/PatchResultMissingFieldExample"
},
"patched-statement-group-property-id-mismatch": {
"$ref": "#/components/examples/PatchedStatementGroupPropertyIdMismatchExample"
},
"patch-result-invalid-key": {
"$ref": "#/components/examples/PatchResultInvalidKeyExample"
},
"patch-result-invalid-value": {
"$ref": "#/components/examples/PatchResultInvalidValueExample"
},
"patch-result-referenced-resource-not-found": {
"$ref": "#/components/examples/PatchResultResourceNotFoundExample"
},
"patch-result-value-too-long": {
"$ref": "#/components/examples/PatchResultValueTooLongExample"
},
"patch-result-modified-read-only-value": {
"$ref": "#/components/examples/PatchResultModifiedReadOnlyValue"
},
"data-policy-violation": {
"$ref": "#/components/examples/DataPolicyViolationExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidPatchedLabels": {
"description": "Applying the provided JSON Patch results in invalid Labels",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"patch-result-invalid-key": {
"$ref": "#/components/examples/PatchResultInvalidKeyExample"
},
"patch-result-invalid-value": {
"$ref": "#/components/examples/PatchResultInvalidValueExample"
},
"patch-result-value-too-long": {
"$ref": "#/components/examples/PatchResultValueTooLongExample"
},
"data-policy-violation": {
"$ref": "#/components/examples/DataPolicyViolationExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidPatchedDescriptions": {
"description": "Applying the provided JSON Patch results in invalid descriptions",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"patch-result-invalid-key": {
"$ref": "#/components/examples/PatchResultInvalidKeyExample"
},
"patch-result-invalid-value": {
"$ref": "#/components/examples/PatchResultInvalidValueExample"
},
"patch-result-value-too-long": {
"$ref": "#/components/examples/PatchResultValueTooLongExample"
},
"data-policy-violation": {
"$ref": "#/components/examples/DataPolicyViolationExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidPatchedAliases": {
"description": "Applying the provided JSON Patch results in invalid Aliases",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"patch-result-invalid-value": {
"$ref": "#/components/examples/PatchResultInvalidValueExample"
},
"patch-result-invalid-key": {
"$ref": "#/components/examples/PatchResultInvalidKeyExample"
},
"patch-result-value-too-long": {
"$ref": "#/components/examples/PatchResultValueTooLongExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"CannotApplyStatementPatch": {
"description": "The provided JSON Patch cannot be applied",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"patch-test-failed": {
"$ref": "#/components/examples/PatchTestFailedExample"
},
"patch-target-not-found": {
"$ref": "#/components/examples/PatchTargetNotFoundExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"InvalidPatchedStatement": {
"description": "Applying the provided JSON Patch results in an invalid Statement",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"examples": {
"patch-result-missing-field": {
"$ref": "#/components/examples/PatchResultMissingFieldExample"
},
"patch-result-invalid-value": {
"$ref": "#/components/examples/PatchResultInvalidValueExample"
},
"patch-result-modified-read-only-value": {
"$ref": "#/components/examples/PatchResultModifiedReadOnlyValue"
},
"patch-result-referenced-resource-not-found": {
"$ref": "#/components/examples/PatchResultResourceNotFoundExample"
}
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"PreconditionFailedError": {
"description": "The condition defined by a conditional request header is not fulfilled"
},
"UnexpectedError": {
"description": "An unexpected error has occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/InvalidPatch/content/application~1json/schema"
},
"example": {
"code": "unexpected-error",
"message": "Unexpected Error"
}
}
},
"headers": {
"Content-Language": {
"schema": {
"type": "string"
},
"description": "Language code of the language in which error message is provided"
}
}
},
"Item": {
"description": "A single Wikibase Item",
"headers": {
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date"
},
"ETag": {
"schema": {
"type": "string"
},
"description": "Last entity revision number"
},
"X-Authenticated-User": {
"schema": {
"type": "string"
},
"description": "Optional username of the user making the request"
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Item"
},
{
"required": [
"id",
"type",
"labels",
"descriptions",
"aliases",
"statements",
"sitelinks"
],
"properties": {
"sitelinks": {
"additionalProperties": {
"required": [
"title",
"badges",
"url"
]
}
},
"statements": {
"additionalProperties": {
"items": {
"$ref": "#/paths/~1statements~1%7Bstatement_id%7D/get/responses/200/content/application~1json/schema/allOf/1"
}
}
}
}
}
]
},
"example": {
"id": "Q24",
"type": "item",
"labels": {
"en": "Jane Doe",
"ru": "Джейн Доу"
},
"descriptions": {
"en": "famous person",
"ru": "известная личность"
},
"aliases": {
"en": [
"Jane M. Doe",
"JD"
],
"ru": [
"Джейн М. Доу"
]
},
"statements": {
"P694": [
{
"id": "Q24$BB728546-A400-4116-A772-16D54B62AC2B",
"rank": "normal",
"qualifiers": [],
"references": [],
"property": {
"id": "P694",
"data_type": "wikibase-item"
},
"value": {
"type": "value",
"content": "Q626683"
}
}
],
"P476": [
{
"id": "Q24$F3B2F956-B6AB-4984-8D89-BEE0FFFA3385",
"rank": "normal",
"qualifiers": [],
"references": [],
"property": {
"id": "P476",
"data_type": "time"
},
"value": {
"type": "value",
"content": {
"time": "+1986-01-27T00:00:00Z",
"precision": 11,
"calendarmodel": "http://www.wikidata.org/entity/Q1985727"
}
}
}
],
"P17": [
{
"id": "Q24$9966A1CA-F3F5-4B1D-A534-7CD5953169DA",
"rank": "normal",
"qualifiers": [
{
"property": {
"id": "P706",
"data_type": "time"
},
"value": {
"type": "value",
"content": {
"time": "+2023-06-13T00:00:00Z",
"precision": 11,
"calendarmodel": "http://www.wikidata.org/entity/Q1985727"
}
}
}
],
"references": [
{
"hash": "7ccd777f870b71a4c5056c7fd2a83a22cc39be6d",
"parts": [
{
"property": {
"id": "P709",
"data_type": "url"
},
"value": {
"type": "value",
"content": "https://news.example.org"
}
}
]
}
],
"property": {
"id": "P17",
"data_type": "string"
},
"value": {
"type": "value",
"content": "Senior Team Supervisor"
}
}
]
},
"sitelinks": {
"enwiki": {
"title": "Jane Doe",
"badges": [],
"url": "https://enwiki.example.org/wiki/Jane_Doe"
},
"ruwiki": {
"title": "Джейн Доу",
"badges": [],
"url": "https://ruwiki.example.org/wiki/Джейн_Доу"
}
}
}
}
}
},
"Sitelinks": {
"description": "A list of Sitelinks by Item id",
"headers": {
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date"
},
"ETag": {
"schema": {
"type": "string"
},
"description": "Last entity revision number"
},
"X-Authenticated-User": {
"schema": {
"type": "string"
},
"description": "Optional username of the user making the request"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Item/properties/sitelinks"
},
"example": {
"sitelinks": {
"enwiki": {
"title": "Jane Doe",
"badges": [],
"url": "https://enwiki.example.org/wiki/Jane_Doe"
},
"ruwiki": {
"title": "Джейн Доу",
"badges": [],
"url": "https://ruwiki.example.org/wiki/Джейн_Доу"
}
}
}
}
}
},
"Sitelink": {
"description": "A Sitelink by Item id",
"headers": {
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date"
},
"ETag": {
"schema": {
"type": "string"
},
"description": "Last entity revision number"
},
"X-Authenticated-User": {
"schema": {
"type": "string"
},
"description": "Optional username of the user making the request"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Sitelink"
},
"example": {
"title": "Jane Doe",
"badges": [],
"url": "https://enwiki.example.org/wiki/Jane_Doe"
}
}
}
},
"Property": {
"description": "A single Wikibase Property",
"headers": {
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date"
},
"ETag": {
"schema": {
"type": "string"
},
"description": "Last entity revision number"
},
"X-Authenticated-User": {
"schema": {
"type": "string"
},
"description": "Optional username of the user making the request"
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Property"
},
{
"required": [
"id",
"type",
"data_type",
"labels",
"descriptions",
"aliases",
"statements"
],
"properties": {
"statements": {
"additionalProperties": {
"items": {
"$ref": "#/paths/~1statements~1%7Bstatement_id%7D/get/responses/200/content/application~1json/schema/allOf/1"
}
}
}
}
}
]
},
"example": {
"id": "P694",
"type": "property",
"data_type": "wikibase-item",
"labels": {
"en": "instance of",
"ru": "это частный случай понятия"
},
"descriptions": {
"en": "this item is a concrete object (instance) of this class, category or object group",
"ru": "данный элемент представляет собой конкретный объект (экземпляр / частный случай) класса, категории."
},
"aliases": {
"en": [
"is a",
"is an"
],
"ru": [
"представляет собой",
"является"
]
},
"statements": {
"P1628": [
{
"id": "P694$b4c349a2-c504-4fc5-b7d5-8b781c719d71",
"rank": "normal",
"property": {
"id": "P1628",
"data_type": "url"
},
"value": {
"type": "value",
"content": "http://www.w3.org/1999/02/22-rdf-syntax-ns#type"
},
"qualifiers": [],
"references": []
}
]
}
}
}
}
},
"Statement": {
"description": "A single Wikibase Statement. Please note that the value of the `ETag` header field refers to the entity's revision ID.",
"headers": {
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date"
},
"ETag": {
"schema": {
"type": "string"
},
"description": "Last entity revision number"
},
"X-Authenticated-User": {
"schema": {
"type": "string"
},
"description": "Optional username of the user making the request"
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Statement"
},
{
"allOf": [
{
"required": [
"property",
"value"
],
"properties": {
"property": {
"required": [
"id",
"data_type"
]
},
"value": {
"required": [
"type"
]
}
}
},
{
"required": [
"id",
"rank",
"qualifiers",
"references"
],
"properties": {
"qualifiers": {
"items": {
"$ref": "#/paths/~1statements~1%7Bstatement_id%7D/get/responses/200/content/application~1json/schema/allOf/1/allOf/0"
}
},
"references": {
"items": {
"required": [
"hash",
"parts"
],
"properties": {
"parts": {
"items": {
"$ref": "#/paths/~1statements~1%7Bstatement_id%7D/get/responses/200/content/application~1json/schema/allOf/1/allOf/0"
}
}
}
}
}
}
}
]
}
]
},
"examples": {
"Statement on an Item": {
"$ref": "#/components/examples/ItemStatementResponseExample"
},
"Statement on a Property": {
"$ref": "#/components/examples/PropertyStatementResponseExample"
}
}
}
}
},
"ItemStatement": {
"description": "A single Wikibase Statement. Please note that the value of the `ETag` header field refers to the Item's revision ID.",
"headers": {
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date"
},
"ETag": {
"schema": {
"type": "string"
},
"description": "Last entity revision number"
},
"X-Authenticated-User": {
"schema": {
"type": "string"
},
"description": "Optional username of the user making the request"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/Statement/content/application~1json/schema"
},
"example": {
"$ref": "#/components/examples/ItemStatementResponseExample/value"
}
}
}
},
"PropertyStatement": {
"description": "A single Wikibase Statement. Please note that the value of the `ETag` header field refers to the Property's Revision ID.",
"headers": {
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date"
},
"ETag": {
"schema": {
"type": "string"
},
"description": "Last entity revision number"
},
"X-Authenticated-User": {
"schema": {
"type": "string"
},
"description": "Optional username of the user making the request"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/responses/Statement/content/application~1json/schema"
},
"example": {
"$ref": "#/components/examples/PropertyStatementResponseExample/value"
}
}
}
},
"NotModified": {
"description": "The specified resource has not been modified since last provided revision number or date",
"headers": {
"ETag": {
"schema": {
"type": "string"
},
"description": "Last entity revision number"
}
}
},
"MovedPermanently": {
"description": "The specified resource has permanently moved to the indicated location",
"headers": {
"Location": {
"schema": {
"type": "string"
},
"description": "The URL to which the requested resource has been moved"
}
}
},
"MovedTemporarily": {
"description": "The specified resource has temporarily moved to the indicated location",
"headers": {
"Location": {
"schema": {
"type": "string"
},
"description": "The URL to which the requested resource has been moved"
}
}
}
},
"schemas": {
"Item": {
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string",
"enum": [
"item"
],
"readOnly": true
},
"labels": {
"$ref": "#/components/schemas/Labels"
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"aliases": {
"$ref": "#/components/schemas/Aliases"
},
"sitelinks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Sitelink"
}
},
"statements": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Statement"
}
}
}
}
},
"Property": {
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string",
"enum": [
"property"
],
"readOnly": true
},
"data_type": {
"type": "string"
},
"labels": {
"$ref": "#/components/schemas/Labels"
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"aliases": {
"$ref": "#/components/schemas/Aliases"
},
"statements": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Statement"
}
}
}
},
"required": [
"data_type"
]
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"Descriptions": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"Aliases": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Sitelink": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"badges": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string",
"readOnly": true
}
},
"required": [
"title"
]
},
"Statement": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"description": "The globally unique identifier for this Statement",
"type": "string",
"readOnly": true
},
"rank": {
"description": "The rank of the Statement",
"type": "string",
"enum": [
"deprecated",
"normal",
"preferred"
],
"default": "normal"
}
}
},
{
"$ref": "#/components/schemas/Qualifier"
},
{
"type": "object",
"properties": {
"qualifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Qualifier"
},
"default": []
},
"references": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference"
},
"default": []
}
}
}
]
},
"Qualifier": {
"type": "object",
"properties": {
"property": {
"type": "object",
"properties": {
"id": {
"description": "The ID of the Property",
"type": "string"
},
"data_type": {
"description": "The data type of the Property",
"type": "string",
"readOnly": true,
"nullable": true
}
}
},
"value": {
"type": "object",
"properties": {
"content": {
"description": "The value, if type == \"value\", otherwise omitted"
},
"type": {
"description": "The value type",
"type": "string",
"enum": [
"value",
"somevalue",
"novalue"
]
}
}
}
}
},
"Reference": {
"type": "object",
"properties": {
"hash": {
"description": "Hash of the Reference",
"type": "string",
"readOnly": true
},
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Qualifier"
}
}
}
}
},
"examples": {
"InvalidValueExample": {
"value": {
"code": "invalid-value",
"message": "Invalid value at '{json_pointer}'",
"context": {
"path": "{json_pointer}"
}
}
},
"InvalidKeyExample": {
"value": {
"code": "invalid-key",
"message": "Invalid key '{key}' in '{json_pointer_to_parent}'",
"context": {
"path": "{json_pointer_to_parent}",
"key": "{key}"
}
}
},
"MissingFieldExample": {
"value": {
"code": "missing-field",
"message": "Required field missing",
"context": {
"path": "{json_pointer_to_parent}",
"field": "{missing_field}"
}
}
},
"ValueTooLongExample": {
"value": {
"code": "value-too-long",
"message": "The input value is too long",
"context": {
"path": "{json_pointer_to_element}",
"limit": "{configured_limit}"
}
}
},
"DataPolicyViolationExample": {
"value": {
"code": "data-policy-violation",
"message": "Edit violates data policy",
"context": {
"violation": "{violation_code}",
"violation_context": {
"some": "context"
}
}
}
},
"PatchResultValueTooLongExample": {
"value": {
"code": "patch-result-value-too-long",
"message": "Patched value is too long",
"context": {
"path": "{json_pointer_to_patched_element}",
"limit": "{configured_limit}"
}
}
},
"InvalidQueryParameterExample": {
"value": {
"code": "invalid-query-parameter",
"message": "Invalid query parameter: '{parameter}'",
"context": {
"parameter": "{parameter}"
}
}
},
"InvalidPathParameterExample": {
"value": {
"code": "invalid-path-parameter",
"message": "Invalid path parameter: '{path_parameter}'",
"context": {
"parameter": "{path_parameter}"
}
}
},
"ResourceTooLargeExample": {
"value": {
"code": "resource-too-large",
"message": "Edit resulted in a resource that exceeds the size limit of {configured_limit}",
"context": {
"limit": "configured_limit_as_int"
}
}
},
"ReferencedResourceNotFoundExample": {
"value": {
"code": "referenced-resource-not-found",
"message": "The referenced resource does not exist",
"context": {
"path": "{json_pointer}"
}
}
},
"CannotModifyReadOnlyValue": {
"value": {
"code": "cannot-modify-read-only-value",
"message": "The input value cannot be modified",
"context": {
"path": "{readonly_value_pointer}"
}
}
},
"PatchResultModifiedReadOnlyValue": {
"value": {
"code": "patch-result-modified-read-only-value",
"message": "Read only value in patch result cannot be modified",
"context": {
"path": "{json_pointer_to_readonly_value}"
}
}
},
"PatchTestFailedExample": {
"value": {
"code": "patch-test-failed",
"message": "Test operation in the provided patch failed",
"context": {
"path": "{json_pointer_to_patch_operation}",
"actual_value": "actual value"
}
}
},
"PatchTargetNotFoundExample": {
"value": {
"code": "patch-target-not-found",
"message": "Target not found on resource",
"context": {
"path": "{json_pointer_to_target_in_patch}"
}
}
},
"RedirectedItemExample": {
"value": {
"code": "redirected-item",
"message": "Item {item_id} has been redirected to {redirect_target_id}",
"context": {
"redirect_target": "{redirect_target_id}"
}
}
},
"ResourceNotFoundExample": {
"value": {
"code": "resource-not-found",
"message": "The requested resource does not exist",
"context": {
"resource_type": "{resource_type}"
}
}
},
"PatchResultResourceNotFoundExample": {
"value": {
"code": "patch-result-referenced-resource-not-found",
"message": "The referenced resource does not exist",
"context": {
"path": "{json_pointer_to_missing_resource_in_patch_result}",
"value": "{value}"
}
}
},
"PatchResultInvalidKeyExample": {
"value": {
"code": "patch-result-invalid-key",
"message": "Invalid key in patch result",
"context": {
"path": "{json_pointer_to_parent_in_patch_result}",
"key": "{key}"
}
}
},
"PatchResultInvalidValueExample": {
"value": {
"code": "patch-result-invalid-value",
"message": "Invalid value in patch result",
"context": {
"value": "{value}",
"path": "{path}"
}
}
},
"PatchResultMissingFieldExample": {
"value": {
"code": "patch-result-missing-field",
"message": "Required field missing in patch result",
"context": {
"path": "{json_pointer_to_parent}",
"field": "{missing_field}"
}
}
},
"PatchedStatementGroupPropertyIdMismatchExample": {
"value": {
"code": "patched-statement-group-property-id-mismatch",
"message": "Statement's Property ID does not match the Statement group key",
"context": {
"path": "{property_id_key}/{index}/property/id",
"statement_group_property_id": "{property_id_key}",
"statement_property_id": "{property_id_value}"
}
}
},
"ItemStatementIdMismatchExample": {
"value": {
"code": "item-statement-id-mismatch",
"message": "IDs of the Item and the Statement do not match",
"context": {
"item_id": "{item_id}",
"statement_id": "{statement_id}"
}
}
},
"PropertyStatementIdMismatchExample": {
"value": {
"code": "property-statement-id-mismatch",
"message": "IDs of the Property and the Statement do not match",
"context": {
"property_id": "{property_id}",
"statement_id": "{statement_id}"
}
}
},
"ItemStatementIdExample": {
"value": "Q42$F078E5B3-F9A8-480E-B7AC-D97778CBBEF9"
},
"PropertyStatementIdExample": {
"value": "P31$9d042001-4a7e-2432-a7e1-233360062379"
},
"ItemStatementResponseExample": {
"value": {
"id": "Q42$F078E5B3-F9A8-480E-B7AC-D97778CBBEF9",
"rank": "normal",
"property": {
"id": "P31",
"data_type": "wikibase-item"
},
"value": {
"type": "value",
"content": "Q5"
},
"qualifiers": [],
"references": []
}
},
"PropertyStatementResponseExample": {
"value": {
"id": "P31$9d042001-4a7e-2432-a7e1-233360062379",
"rank": "normal",
"property": {
"id": "P31",
"data_type": "wikibase-item"
},
"value": {
"type": "value",
"content": "Q5"
},
"qualifiers": [],
"references": []
}
},
"StatementGroupPropertyIdMismatch": {
"value": {
"code": "statement-group-property-id-mismatch",
"message": "Statement's Property ID does not match the Statement group key",
"context": {
"path": "{property_id_key}/{index}/property/id",
"statement_group_property_id": "{property_id_key}",
"statement_property_id": "{property_id_value}"
}
}
},
"PermissionDeniedExample": {
"value": {
"code": "permission-denied",
"message": "Access to resource is denied",
"context": {
"denial_reason": "{reason_code}",
"denial_context": "{additional_context}"
}
}
}
}
},
"tags": [
{
"name": "items",
"description": "Wikibase Items",
"externalDocs": {
"description": "Wikibase Data Model - Items",
"url": "https://www.mediawiki.org/wiki/Wikibase/DataModel#Items"
}
},
{
"name": "sitelinks",
"description": "Wikibase Item Sitelinks",
"externalDocs": {
"description": "Wikibase Data Model - Sitelinks",
"url": "https://www.mediawiki.org/wiki/Wikibase/DataModel#Sitelinks"
}
},
{
"name": "properties",
"description": "Wikibase Properties",
"externalDocs": {
"description": "Wikibase Data Model - Properties",
"url": "https://www.mediawiki.org/wiki/Wikibase/DataModel#Properties"
}
},
{
"name": "labels",
"description": "Wikibase Labels",
"externalDocs": {
"description": "Wikibase Data Model - Terms",
"url": "https://www.mediawiki.org/wiki/Wikibase/DataModel#EntityDescriptions_of_Items_and_Properties"
}
},
{
"name": "descriptions",
"description": "Wikibase Descriptions",
"externalDocs": {
"description": "Wikibase Data Model - Terms",
"url": "https://www.mediawiki.org/wiki/Wikibase/DataModel#EntityDescriptions_of_Items_and_Properties"
}
},
{
"name": "aliases",
"description": "Wikibase Aliases",
"externalDocs": {
"description": "Wikibase Data Model - Terms",
"url": "https://www.mediawiki.org/wiki/Wikibase/DataModel#EntityDescriptions_of_Items_and_Properties"
}
},
{
"name": "statements",
"description": "Wikibase Statements",
"externalDocs": {
"description": "Wikibase Data Model - Statements",
"url": "https://www.mediawiki.org/wiki/Wikibase/DataModel#Statements"
}
}
],
"servers": [
{
"url": "https://wikibase.example/w/rest.php/wikibase/v0"
}
]
}