Description
PUT entities/items/{item_id}/sitelinks/{site_id}

Request payload:

{
  "sitelink": {
    "title": ...,
    "badges": [ Q-ID, ... ] (optional)
  },
  "comment": ... (optional)
  "tags": [ ... ] (optional)
  "bot": false (optional)
}

Acceptance criteria:

• The respective successful responses should present the relevant data as a JSON object -- similar to the responses of GET /entities/items/{item_id}/sitelinks/{site_id}.
• If a sitelink in the given wiki didn't exist before the successful request the response should use 201 code.
• If the request changed the existing sitelink, the response code should be 200.
• If the request payload contains the URL, it is ignored (and not rejected)

Error cases to consider

Notes

• Automated edit summaries to be of the form:
  • if the edit resulted in adding a site link to a wiki which was not connected before, and no badges: /* wbsetsitelink-add:1|SITE_ID */ TITLE
  • if the edit resulted in adding a site link to a wiki which was not connected before, and there are badges: /* wbsetsitelink-add-both:2|SITE_ID */ TITLE, BADGE_ITEMS_FORMATTED
  • if the edit resulted in setting a title to a different page on a wiki which has been connected as a site link before, and there are no badges: /* wbsetsitelink-set:1|SITE_ID */ TITLE
  • if the edit resulted in setting a title to a different page on a wiki which has been connected as a site link before, and there are badges: /* wbsetsitelink-set-both:2|SITE_ID */ TITLE, BADGE_ITEMS_FORMATTED
  • if the edit resulted in changes badges of an existing sitelink (and not change the title): /* wbsetsitelink-set-badges:1|SITE_ID */ BADGE_ITEMS_FORMATTED
  • where BADGE_ITEMS_FORMATTED is a comma-separated list of wikitext links to item pages
  • see Wikibase\Repo\ChangeOp\ChangeOpSiteLink class, and surrounding classes, for further details of the existing Wikibase automated edit summary logic
• client can provide additional edit metadata: mediawiki tags, edit summary text to append to the automated summary, and a bot edit flag, like in PUT /entities/items/{item_id}/labels/{language_code}
• Handle HTTP conditional request headers as in PUT /entities/items/{item_id}/statements
• Handle user authentication/authorization like in PUT /entities/items/{item_id}/statements

Additional notes:

How Action API handles it: https://www.wikidata.org/w/api.php?action=help&modules=wbsetsitelink

Task breakdown notes:

• Add the new route to OAS
• happy path (with empty edit summary)
  • including ETag and Last-Modified headers
  • create SiteLinkDeserializer
  • differentiate 200/201
• validate sitelink badges
• validate sitelink title
  • skip title existence check
• validate title existence
• Implement edit summaries
• handle sitelink conflict
• Respond 404/409 if item not found/redirect
• Authorization
• Use the usual middlewares and add the route handler to RouteHandlersTest
• Add spec tests.
• Mark as production ready.