wikimedia/mediawiki-extensions-Wikibase

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

Summary

Maintainability
Test Coverage
{
    "InvalidPatchedItemSitelinks": {
        "description": "Applying the provided JSON Patch results in invalid Sitelinks",
        "content": {
            "application/json": {
                "schema": { "$ref": "../../global/response-parts.json#/Error" },
                "examples": {
                    "patch-result-referenced-resource-not-found": { "$ref": "../../global/examples.json#/PatchResultResourceNotFoundExample" },
                    "patch-result-invalid-value": { "$ref": "../../global/examples.json#/PatchResultInvalidValueExample" },
                    "patch-result-missing-field": { "$ref": "../../global/examples.json#/PatchResultMissingFieldExample" },
                    "patch-result-invalid-key": { "$ref": "../../global/examples.json#/PatchResultInvalidKeyExample" },
                    "patch-result-modified-read-only-value": {
                        "$ref": "../../global/examples.json#/PatchResultModifiedReadOnlyValue"
                    },
                    "data-policy-violation": { "$ref": "../../global/examples.json#/DataPolicyViolationExample" }
                }
            }
        },
        "headers": {
            "Content-Language": {
                "schema": { "type": "string" },
                "description": "Language code of the language in which error message is provided"
            }
        }
    },
    "SitelinkDeleted": {
        "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"
            }
        }
    },
    "InvalidRemoveSitelinkInput": {
        "description": "The request cannot be processed",
        "content": {
            "application/json": {
                "schema": { "$ref": "../../global/response-parts.json#/Error" },
                "examples": {
                    "invalid-path-parameter": { "$ref": "../../global/examples.json#/InvalidPathParameterExample" },
                    "invalid-value": { "$ref": "../../global/examples.json#/InvalidValueExample" },
                    "value-too-long": { "$ref": "../../global/examples.json#/ValueTooLongExample" }
                }
            }
        },
        "headers": {
            "Content-Language": {
                "schema": { "type": "string" },
                "description": "Language code of the language in which error message is provided"
            }
        }
    },
    "InvalidSetSitelinkInput": {
        "description": "The request cannot be processed",
        "content": {
            "application/json": {
                "schema": { "$ref": "../../global/response-parts.json#/Error" },
                "examples": {
                    "invalid-path-parameter": { "$ref": "../../global/examples.json#/InvalidPathParameterExample" },
                    "invalid-value": { "$ref": "../../global/examples.json#/InvalidValueExample" },
                    "missing-field": { "$ref": "../../global/examples.json#/MissingFieldExample" },
                    "value-too-long": { "$ref": "../../global/examples.json#/ValueTooLongExample" },
                    "referenced-resource-not-found": { "$ref": "../../global/examples.json#/ReferencedResourceNotFoundExample" },
                    "resource-too-large": { "$ref": "../../global/examples.json#/ResourceTooLargeExample" }
                }
            }
        },
        "headers": {
            "Content-Language": {
                "schema": { "type": "string" },
                "description": "Language code of the language in which error message is provided"
            }
        }
    },
    "InvalidGetSitelinkInput": {
        "description": "The request cannot be processed",
        "content": {
            "application/json": {
                "schema": { "$ref": "../../global/response-parts.json#/Error" },
                "examples": {
                    "invalid-path-parameter": { "$ref": "../../global/examples.json#/InvalidPathParameterExample" }
                }
            }
        },
        "headers": {
            "Content-Language": {
                "schema": { "type": "string" },
                "description": "Language code of the language in which error message is provided"
            }
        }
    }
}