Skip to content

Query for Supported Queries #7

Open

Description

@dshanske

Separating this from #1.

Proposing that the config query contain a property called q that shows what commands the endpoint will respond to.

Activity

  1. dshanske commented on Dec 5, 2018

    @dshanske
    MemberAuthor

    Micropub for WordPress actually does do this now.

  2. EdwardHinkle commented on Dec 5, 2018

    @EdwardHinkle

    I think this is a great idea and plan to add support for this in both my abode software and Indigenous for iOS.

    I'm not sure about the property name, q (although matching the query parameter) seems a little vague. Maybe we call it queries?

    Because that I think this is great. I would expect that the value would be an array of strings and each of the strings would be query to the ?q= values that are supported?

    For example my site would return

    {
    "other": "stuff",
    "queries": [
        "source",
        "syndicate-to",
        "category",
        "contact"
    ]
    }

    Does that look right and is that how you are doing it, @dshanske ?

  3. dshanske commented on Dec 5, 2018

    @dshanske
    MemberAuthor

    I think I am using q

  4. dshanske commented on Dec 5, 2018

    @dshanske
    MemberAuthor

    Basically to match the query

  5. EdwardHinkle commented on Dec 5, 2018

    @EdwardHinkle

    That makes sense. Does that rest of it match?

  6. EdwardHinkle commented on Dec 5, 2018

    @EdwardHinkle

    Essentially strings that match what gets entered into ?q=

  7. dshanske commented on Dec 5, 2018

    @dshanske
    MemberAuthor

    That is exactly it.

  8. swentel commented on Mar 1, 2019

    @swentel

    Drupal supports this too now, see swentel/indieweb#373

    In a way, returning 'config' in the 'q' array seems a bit redundant no ?

    Also, I think you an add 'geo' now too (unless that's added differently)

  9. jamietanna commented on Jul 11, 2020

    @jamietanna

    This is supported in my Micropub server and can be seen in https://www-api.jvt.me/micropub?q=config

  10. manton commented on Jul 15, 2020

    @manton

    I think it would be useful to document the behavior if there is no q list in the response. Specifically: if a server does not return which queries it supports, a client should still call e.g. q=source or q=category or any other query it wants to try. If the client gets an error or empty JSON when trying a query, it knows that query is not supported anyway.

  11. paulrobertlloyd commented on Dec 3, 2022

    @paulrobertlloyd

    This query is supported by Indiekit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions