Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Query for Supported Queries #7

Open
dshanske opened this issue Dec 5, 2018 · 10 comments
Open

Query for Supported Queries #7

dshanske opened this issue Dec 5, 2018 · 10 comments

Comments

@dshanske
Copy link
Member

@dshanske dshanske commented Dec 5, 2018

Separating this from #1.

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

@dshanske
Copy link
Member Author

@dshanske dshanske commented Dec 5, 2018

Micropub for WordPress actually does do this now.

@EdwardHinkle
Copy link

@EdwardHinkle EdwardHinkle commented Dec 5, 2018

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 ?

@dshanske
Copy link
Member Author

@dshanske dshanske commented Dec 5, 2018

I think I am using q

@dshanske
Copy link
Member Author

@dshanske dshanske commented Dec 5, 2018

Basically to match the query

@EdwardHinkle
Copy link

@EdwardHinkle EdwardHinkle commented Dec 5, 2018

That makes sense. Does that rest of it match?

@EdwardHinkle
Copy link

@EdwardHinkle EdwardHinkle commented Dec 5, 2018

Essentially strings that match what gets entered into ?q=

@dshanske
Copy link
Member Author

@dshanske dshanske commented Dec 5, 2018

That is exactly it.

@swentel
Copy link

@swentel swentel commented Mar 1, 2019

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)

@jamietanna
Copy link

@jamietanna jamietanna commented Jul 11, 2020

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

@manton
Copy link

@manton manton commented Jul 15, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants