Page MenuHomePhabricator

Reader gets file license offline
Open, LowPublic

Description

"As a reader, I want to know the license information for a file, so that I can use, distribute and modify the file."

We need to add machine-readable license information for the following endpoints:

The file representations in the output of each endpoint need the following additional properties:

  • license: Object for the preferred license of the page, including these properties:
    • spdx: SPDX code
    • url: URL for the license
    • title: title of the license
  • other_licenses: array of objects with {spdx, url, title} for other licenses the page is available under
  • contributors: Contributors to the file as an array of user objects with these properties:
    • id: user ID
    • name: user name

Event Timeline

We decided not to include this information in the first versions of the referenced endpoints, but the Wikimedia Engineering Architectural Principles have a MUST requirement for them:

"API/LICENSE: data formats and APIs that provide access to user generated content MUST be designed to provide easy access to all relevant information about authorship and licensing."

Adding missing MediaWiki-REST-API code project tag as Core Platform Team Initiatives (MW REST API in PHP) team tag is archived and its parent Platform Engineering team does not exist anymore