search

martylamb / bookmartian

4 stars 1 forks source link

add query reference to docs #40

Closed jmutchek closed 7 years ago

jmutchek commented 8 years ago

The legal query actions and some examples should be provided on the site itself:

[tagged:]TAG by:least-recently-created by:least-recently-modified by:least-recently-visited by:least-visited by:most-recently-created by:most-recently-modified by:most-recently-visited by:most-visited by:title by:url created-after:DATE-EXPR created-since:DATE-EXPR created[-on]:DATE-EXPR is:secure is:tagged is:untagged limit:N modified-after:DATE-EXPR modified-since:DATE-EXPR modified[-on]:DATE-EXPR site:SITE visited-after:DATE-EXPR visited-since:DATE-EXPR visited[-on]:DATE-EXPR visits-over:N visits-under:N visits:N

martylamb commented 8 years ago

Perhaps interactive generated api documentation via http://swagger.io/ is the way to go. I haven't used it before but there's a way to define an api in an editor and have it generate what we want.

jmutchek commented 7 years ago

Ideally this might be generated from the docs/api.md file as that would be easier to maintain... some sort of maven plugin? For now, the page is updated manually.