Write an API for accessing the Community configuration
Closed, ResolvedPublic3 Estimated Story Points
Actions

Description

To make it possible for non-MediaWiki software (such as the Wikipedia mobile apps) to work with (and/or respect) Community configuration 2.0, there needs to be an API that supports reading the available configuration.

This API can then be used by mobile apps, gadget authors and similar to customize their behavior based on Community configuration. The API should also be as stable as possible (without being impacted by config schema changes). It should also ensure the returned configuration is valid.

Acceptance Criteria

An API that exposes the currently available configuration

Details

Related Changes in Gerrit:

	Subject	Author	Repo	Branch	Lines +/-
	Add ApiQueryRead for reading the configuration	Urbanecm	mediawiki/extensions/CommunityConfiguration	master	+88 -2

Customize query in gerrit

Related Objects

Mentioned In: rECOMe814620695e6: Add ApiQueryRead for reading the configuration

Event Timeline

Urbanecm_WMF created this task.Feb 22 2024, 11:19 AM

Herald added a project: Growth-Team. · View Herald TranscriptFeb 22 2024, 11:19 AM

Herald added a subscriber: Aklapper. · View Herald Transcript

Urbanecm_WMF triaged this task as High priority.Feb 22 2024, 11:19 AM

Urbanecm_WMF set the point value for this task to 3.Feb 22 2024, 11:22 AM

Urbanecm_WMF moved this task from Backlog to Needed before deploy to Beta on the MediaWiki-extensions-CommunityConfiguration board.Feb 22 2024, 2:53 PM

Sgs moved this task from Inbox to Backlog on the Growth-Team board.Feb 23 2024, 12:27 PM

Sgs moved this task from Backlog to Estimated tasks backlog on the Growth-Team board.Mar 14 2024, 6:20 PM

Sgs lowered the priority of this task from High to Medium.Mar 14 2024, 6:32 PM

Urbanecm_WMF moved this task from Needed before deploy to Beta to Needed before pilot release on the MediaWiki-extensions-CommunityConfiguration board.Mar 18 2024, 10:54 PM

Urbanecm_WMF moved this task from Needed before pilot release to Support non-Growth use cases on the MediaWiki-extensions-CommunityConfiguration board.Apr 3 2024, 4:37 PM

Urbanecm_WMF claimed this task.May 4 2024, 9:50 AM

Urbanecm_WMF edited projects, added: Growth-Team (Sprint 13 (Growth Team)); removed: Growth-Team.

Change #1027132 had a related patch set uploaded (by Urbanecm; author: Urbanecm):

[mediawiki/extensions/CommunityConfiguration@master] Add ApiQueryRead for reading the configuration

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

gerritbot added a project: Patch-For-Review.May 4 2024, 12:45 PM

Change #1027158 had a related patch set uploaded (by Urbanecm; author: Urbanecm):

[mediawiki/extensions/CommunityConfiguration@master] Support dynamic defaults

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

Urbanecm_WMF moved this task from Incoming to Doing on the Growth-Team (Sprint 13 (Growth Team)) board.May 4 2024, 2:49 PM

Urbanecm_WMF moved this task from Doing to Code Review on the Growth-Team (Sprint 13 (Growth Team)) board.May 5 2024, 4:03 PM

Requested by @Dogu at Wikimedia-Hackathon-2024.

Urbanecm_WMF added a project: Wikimedia-Hackathon-2024.May 5 2024, 4:09 PM

Urbanecm_WMF moved this task from Backlog to Hacking projects on the Wikimedia-Hackathon-2024 board.

Change #1027132 merged by jenkins-bot:

[mediawiki/extensions/CommunityConfiguration@master] Add ApiQueryRead for reading the configuration

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

Urbanecm_WMF mentioned this in rECOMe814620695e6: Add ApiQueryRead for reading the configuration.May 7 2024, 11:42 AM

ReleaseTaggerBot added a project: MW-1.43-notes (1.43.0-wmf.5; 2024-05-14).May 7 2024, 12:00 PM

Urbanecm_WMF edited projects, added: Growth-Team (Sprint 14 (Growth Team)); removed: Patch-For-Review, Growth-Team (Sprint 13 (Growth Team)).May 14 2024, 4:13 PM

Urbanecm_WMF moved this task from Incoming to QA on the Growth-Team (Sprint 14 (Growth Team)) board.

Urbanecm_WMF edited projects, added: Growth-Team (Sprint 15 (Growth Team)); removed: Growth-Team (Sprint 14 (Growth Team)).May 28 2024, 4:03 PM

Urbanecm_WMF moved this task from Incoming to QA on the Growth-Team (Sprint 15 (Growth Team)) board.

Checked on beta - works as expected, e.g. https://es.wikipedia.beta.wmflabs.org/wiki/Especial:Zona_de_pruebas_de_la_API#action=query&format=json&prop=&list=&meta=communityconfiguration&formatversion=2&ccrprovider=HelpPanel
displays:

{
    "batchcomplete": true,
    "communityconfiguration": {
        "data": {
            "GEHelpPanelAskMentor": "mentor-talk-page",
            "GEHelpPanelExcludedNamespaces": [],
            "GEHelpPanelHelpDeskPostOnTop": "top",
            "GEHelpPanelHelpDeskTitle": "",
            "GEHelpPanelLinks": [],
            "GEHelpPanelReadingModeNamespaces": [],
            "GEHelpPanelSearchNamespaces": [],
            "GEHelpPanelViewMoreTitle": ""
        }
    }
}

Write an API for accessing the Community configurationClosed, ResolvedPublic3 Estimated Story PointsActions