Page MenuHomePhabricator

[Placeholder] Release beta module for basic Attribution
Closed, ResolvedPublic

Description

Conditions of acceptance

  • Create a basic attribution (aka: information explicitly required by the license) endpoint that reflects all information required by the most common (or largest superset of required data) license type across projects.
    • Implement a base endpoint that returns all expected/necessary data points for compliance (note: Might be subject to change, depending on the outcome of the audit).
      • - Source
      • - Author (currently implemented as 'uploader'; used for images/media files only) → Recommend having fall through logic to preferentially display the set "Author"/"Artist" etc if available; fallback to 'Uploader' if not.
      • - Link
      • - Title
      • - License (name + link to license details) → Currently pulled based on wiki config value; double check for media file specific licenses.
      • - Modification disclaimer (generated client-side; does not need to be returned)
  • REST endpoint(s) should be built in MediaWiki Core, and be contained in a dedicated "Attribution API" module.
  • The attribution API module is surfaced as a beta module
    • Start by deploying to Test Wiki only
    • The Attribution API module meets all API Platform requirements related to spec linting, documentation, and changelog entries.
    • NOTE: Open questions for degree of extensibility and pulling additional data points based on per-wiki customizations and other services.

Event Timeline

Change #1231041 had a related patch set uploaded (by Mooeypoo; author: Mooeypoo):

[mediawiki/core@master] Add a beta REST module endpoint for attribution API

https://gerrit.wikimedia.org/r/1231041

The patch above delivers information for pages with:

parametervaluedescription
titlestringCanonical title of the page
licenseObjectReturns an object with License string and License URL, taken from the wiki config.
last_modifiedstringFormatted timestamp for last revision
source_wikistringThe dbname of the project the page is from
content_languagestringThe content language for the page
linkstringCanonical URL to page

It's set up as a REST endpoint with a beta module so the iteration is less disruptive as we go forward.

The endpoint can then be expanded (or we can add other endpoints) for other details that are available outside of Core.

Change #1234513 had a related patch set uploaded (by Mooeypoo; author: Mooeypoo):

[mediawiki/extensions/WikimediaCustomizations@master] [WIP] Add an Attribution API REST beta module

https://gerrit.wikimedia.org/r/1234513

Change #1231041 abandoned by Mooeypoo:

[mediawiki/core@master] [EXPERIMENTAL] Add a beta REST module endpoint for attribution API

Reason:

Replaced by I2a2be8f50cf5710bc3a9e92f00336327f9240d9f

https://gerrit.wikimedia.org/r/1231041

Test wiki on Patch demo by Mooeypoo using patch(es) linked to this task was deleted:

https://7b74d43ebf.catalyst.wmcloud.org/w/

Change #1237940 had a related patch set uploaded (by Mooeypoo; author: Mooeypoo):

[mediawiki/extensions/WikimediaCustomizations@master] Add integration tests to Attribution API

https://gerrit.wikimedia.org/r/1237940

Change #1238006 had a related patch set uploaded (by Reedy; author: Reedy):

[integration/config@master] Zuul: Add extension-apitests to WikimediaCustomizations extension

https://gerrit.wikimedia.org/r/1238006

Change #1238006 merged by jenkins-bot:

[integration/config@master] Zuul: Add extension-apitests to WikimediaCustomizations extension

https://gerrit.wikimedia.org/r/1238006

Change #1234513 merged by jenkins-bot:

[mediawiki/extensions/WikimediaCustomizations@master] Add an Attribution API REST beta module

https://gerrit.wikimedia.org/r/1234513

Change #1238041 had a related patch set uploaded (by Mooeypoo; author: Mooeypoo):

[mediawiki/extensions/WikimediaCustomizations@master] Followup quick fixes to I2a2be8f50

https://gerrit.wikimedia.org/r/1238041

Change #1237940 merged by jenkins-bot:

[mediawiki/extensions/WikimediaCustomizations@master] Add integration tests to Attribution API

https://gerrit.wikimedia.org/r/1237940

Change #1238414 had a related patch set uploaded (by Mooeypoo; author: Mooeypoo):

[mediawiki/extensions/WikimediaCustomizations@master] Re-enable spec-validation tests for Attribution API module

https://gerrit.wikimedia.org/r/1238414

Change #1238041 merged by jenkins-bot:

[mediawiki/extensions/WikimediaCustomizations@master] Followup quick fixes to I2a2be8f50

https://gerrit.wikimedia.org/r/1238041

Change #1238414 merged by jenkins-bot:

[mediawiki/extensions/WikimediaCustomizations@master] Re-enable spec-validation tests and fix errors

https://gerrit.wikimedia.org/r/1238414

Test wiki on Patch demo by Mooeypoo using patch(es) linked to this task was deleted:

https://308c5df10c.catalyst.wmcloud.org/w/

Test wiki on Patch demo by Mooeypoo using patch(es) linked to this task was deleted:

https://d172eae88d.catalyst.wmcloud.org/w/