Page MenuHomePhabricator

Flow: API to determine if Flow is enabled on a page
Closed, ResolvedPublic

Description

It seems useful to provide some API to determine if Flow is enabled on a page, since that affects whether many API actions will work or make sense (bug 60808).

The equivalent for LiquidThreads is it returns use-liquid-threads="1" in pageprops queries. Compare LQT page:

https://www.mediawiki.org/w/api.php?action=query&prop=pageprops&titles=Talk:Flow_Portal/Archive2

with Flow board:

https://www.mediawiki.org/w/api.php?action=query&prop=pageprops&titles=Talk:Sandbox

(Note the way we enable Flow on a page is likely to change; editing PHP config files doesn't scale.)


Version: master
Severity: normal

Details

Reference
bz60809

Event Timeline

bzimport raised the priority of this task from to Normal.
bzimport set Reference to bz60809.
Spage created this task.Feb 4 2014, 4:10 AM

(In reply to comment #0)

(Note the way we enable Flow on a page is likely to change; editing PHP
config
files doesn't scale.)

Is there a bug / discussion somewhere discussing this? The pageprops module that LQT uses just pulls from the page_props table, which is what I think Flow should use as well. If we decide to go down that route, a custom API module won't be needed, it'll just work™.

(In reply to comment #1)

(In reply to comment #0)

> (Note the way we enable Flow on a page is likely to change; editing PHP
> config
> files doesn't scale.)

Is there a bug / discussion somewhere discussing this?

Not to my knowledge; it's one of those things where it's dependent on how we want to go about deploying it more widely (not: how we do that technically, but how we do that from a community perspective), and so it's on the back-burner until Flow itself just works™. I invite you to start up a thread on the E2 list, though, because it's a conversation we keep having in fits and starts and never quite finishing.

Anomie added a comment.Feb 4 2014, 3:25 PM

While page_props would be workable, I would lean towards having a "prop=flow" query module that would also allow for returning other flow data related to the page. Unless there is no flow data you can usefully fetch by passing a page title?

e.g. api.php?format=jsonfm&action=query&titles=Foo|Talk:Foo&prop=flow might return something like this:

{

"query": {
    "pages": {
        "12345": {
            "pageid": 12345,
            "ns": 0,
            "title": "Foo"
        },
        "12346": {
            "pageid": 12346,
            "ns": 1,
            "title": "Talk:Foo",
            "flow": {
                   "enabled": true
            }
        }
    }
}

}

Change 111255 had a related patch set uploaded by Legoktm:
API: Add prop=flow to detect if Flow is enabled on a page

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

Change 111255 merged by jenkins-bot:
API: Add prop=flowinfo to detect if Flow is enabled on a page

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

Quiddity removed a subscriber: Maryana.Dec 19 2014, 1:40 AM