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

Queries should return JSON #8

Open
jmacdotorg opened this issue May 16, 2020 · 2 comments
Open

Queries should return JSON #8

jmacdotorg opened this issue May 16, 2020 · 2 comments

Comments

@jmacdotorg
Copy link
Owner

The query subcommand should be able to output JSON.

This JSON should be compatible with webmention.io's JSON output, such that a piece of software able to parse and display things from webmention.io should be able to treat output from Brisote in the same way.

The output can contain additional fields particular to Brisote.

I think that this should be the default behavior of query, relegating human-readable, plain-text output to the use of an -h flag or the like.

@jmacdotorg jmacdotorg added this to the First public release milestone May 16, 2020
@jmacdotorg
Copy link
Owner Author

Note fields that are in the webmention.io JSON not present in Whim's storage. (This is based on a read of webmention.io's homepage and README, and more could be gleaned from experimental usage, digging through the code, and and asking Aaron about it.)

  • wm-id: An integer that I take to be this webmention's primary key in webmention.io's internal database? Notable because currently Whim's database doesn't have any keys at all in it! I just created issue Add keys to Whim's database #21 to address this.

  • published: The API suggests that this is extracted from the source doc if defined by certain microformats, and falls back to the time received otherwise.

  • updated: "The updated date of the page, as seen by webmention.io (not the date the post reports in its microformats data)."

  • wm-private: Mysterious.

  • mention-of: In examples, used instead of "target". Does this field change if e.g. this is a like instead of a plain mention?

@jmacdotorg jmacdotorg removed this from the First public release milestone May 25, 2020
@jmacdotorg
Copy link
Owner Author

I am removing this from the first public release milestone.

It's a feature worth adding, but with the whim display feature's earlier arrival, I realize that I don't care very much about this. So I don't wanna consider it a blocker.

yanick added a commit to yanick/whim that referenced this issue Jul 17, 2020
This is a first, half-hapharded stab at
it, but maybe it can be useful to start
on jmacdotorg#8
yanick added a commit to yanick/whim that referenced this issue Jul 17, 2020
This is a first, half-hapharded stab at
it, but maybe it can be useful to start
on jmacdotorg#8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant