https://bugzilla.wikimedia.org/show_bug.cgi?id=46440

Matthew Flaschen <[email protected]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
            Summary|co-ment-like tool for       |Implement inline comment
                   |inline comments             |support using OKFN
                   |                            |annotator

--- Comment #43 from Matthew Flaschen <[email protected]> ---
I was wondering if someone from the OKFN team could answer a couple quick
questions.

I'm a little unclear about the relationship of 'read' and 'index', and how the
URLs work.

https://github.com/okfn/annotator/wiki/Storage#index says index returns "a list
of all annotation objects".  First, I'm wondering if that is supposed to be
limited to the current page's annotations.  Maybe that's up to us.

However, the plugin docs (https://github.com/okfn/annotator/wiki/Store-Plugin)
have no mention of index, nor do I see a way to override the URL.

https://github.com/okfn/annotator/wiki/Storage#read says it's a
straight-forward method that takes an ID and returns a single annotation.

But the plugin docs (Store-Plugin) say, "read: GETs all annotations. Called
when plugin loads or .loadAnnotations() is called. Server should return an
array of annotations serialised as JSON."

Looking at the Coffee code, it seems read is called to get a list, but never
explicitly called for a single annotation (although there is a commented out
line doing that).  However, since we're using the recommended 303 redirect,
it's implicitly used for creations.

The list part is confirmed by testing.  It loads
http://127.0.0.1:9090/w/api.php?action=annotator-read&id=:id, which is a bit
weird.  I think this is related to https://github.com/okfn/annotator/issues/186

It seems like this may be a moot point if we use loadFromSearch.  However, I
would expect there to be an 'index' url for consistency.

-- 
You are receiving this mail because:
You are on the CC list for the bug.
You are the assignee for the bug.
_______________________________________________
Wikibugs-l mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/wikibugs-l

Reply via email to