Page MenuHomePhabricator

Add annotations for taxonomy v2 controlled vocabulary fields to tools API
Closed, ResolvedPublicFeature

Description

Add new annotation fields which will be used by the community to better categorize toolinfo records to the GET|PUT /api/tools/{name}/annotations/ API end points.

Each field should be multi-value capable meaning that users can add one or more values from the allowed vocabulary.

The vocabulary for each field should be extensible over time, but there is currently no requirement that this mutability be implemented beyond the source code level (meaning that we do not need to make the vocabularies editable via the UI/API).

Fields and values from https://meta.wikimedia.org/wiki/Toolhub/Data_model#Taxonomy_v2:

  • Audiences
    • Admins
    • Organizers and program coordinators
    • Editors and content contributors
    • Readers and content consumers
    • Researchers
    • Developers
  • Content types
    • Articles
    • Audio
    • Books
    • Data
      • Bibliographic data
      • Categories or labels
      • Diffs and revision data
      • Event data
      • Geographic data
      • Linguistic data
      • Page metadata
      • Structured data
      • User data
    • Discussions
    • Drafts
    • Emails
    • Images
    • Links
    • Lists
    • Logs
    • Maps
    • References
    • Software or code
    • Templates
    • Videos
    • Watchlist
    • Webpages
    • Wikitext
  • Tasks
    • Analysis
    • Annotating and linking
    • Archiving and cleanup
    • Categorizing and tagging
    • Citing and referencing
    • Communication and supporting users
    • Converting and formatting content
    • Creating content
    • Deleting and reverting
    • Disambiguation
    • Downloading or reusing content
    • Editing or updating content
    • Event and contest planning
    • Hosting and maintaining tools
    • Identifying policy violations
    • Identifying spam
    • Identifying vandalism
    • Listing and ranking
    • Merging content
    • Migrating content
    • Patrolling recent changes
    • Project management and reporting
    • Reading
    • Recommending content
    • Translating and localizing
    • Uploading or importing
    • User management
    • Warning users
  • Subject domains
    • Biography
    • Cultural heritage
    • Education
    • Geography and mapping
    • GLAM
    • History
    • Language and internationalization
    • Outreach
    • Science

Event Timeline

bd808 renamed this task from Add annotations for taxonomy v2 controlled vocabulary fields to API to Add annotations for taxonomy v2 controlled vocabulary fields to tools API.Oct 3 2022, 10:45 PM
bd808 updated the task description. (Show Details)
bd808 triaged this task as High priority.Oct 3 2022, 11:02 PM
bd808 moved this task from Backlog to Groomed/Ready on the Toolhub board.
bd808 changed the subtype of this task from "Task" to "Feature Request".

Change 854126 had a related patch set uploaded (by BryanDavis; author: Bryan Davis):

[wikimedia/toolhub@main] api: Add taxonomy fields to annotations

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

bd808 changed the task status from Open to In Progress.Nov 7 2022, 10:00 PM
bd808 claimed this task.
bd808 moved this task from Groomed/Ready to In Progress on the Toolhub board.

Change 854126 merged by jenkins-bot:

[wikimedia/toolhub@main] api: Add taxonomy fields to annotations

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

Change 868183 had a related patch set uploaded (by BryanDavis; author: Bryan Davis):

[operations/deployment-charts@master] toolhub: bump container to 2022-12-14-185830-production

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

Change 868183 merged by jenkins-bot:

[operations/deployment-charts@master] toolhub: bump container to 2022-12-14-185830-production

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