Allow GET/HEAD requests for documents

[ericpugh]

Problem:
Applications using i14y might need to know the existence of a particular resource. For example, a document that was created, then deleted would have to guess whether or not a document exists for future requests. This leads to a lot of unhelpful errors.

Solution
Allow GET requests on a document, to test existence.

[joshuakfarrar]

Agreed. I ran into this when I was writing the WordPress plugin. The
question I had is, do we want to allow a client to request a document by ID
and actually receive it, potentially exposing i14y to them without
requiring them to use our service, or should the endpoint simply respond
with a status regarding the existence of the document, or some kind of
metadata?

On Thu, Mar 24, 2016 at 9:17 AM, Eric notifications@github.com wrote:

Problem:
Applications using i14y might need to know the existence of a particular
resource. For example, a document that was created, then deleted would have
to guess whether or not a document exists for future requests. This leads
to a lot of unhelpful errors.

Solution
Allow GET requests on a document, to test existence.

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub
#4

[ericpugh]

@sent1nel I'm not sure why you wouldn't want people to actually get the resource (maybe someone will build something that makes the service better,) but a couple of google searches and I realized that HEAD is probably what I'm looking for. (which would just return a 200 OK without the response body)
Here's a post about HEAD. Thoughts?

[dawnpm]

Hi @ericpugh, i14y is intended to index content for use within our service, which of course you're familiar with. Let's schedule some time on the phone to discuss your site and your needs - for instance are you going to be using direct commands in perpetuity? Will you be using Drupal or WordPress in the future? We totally agree that GET would be a good feature at some point; not sure when we'll be able to schedule it. Thanks.

[joshuakfarrar]

The issue with allowing GET requests is that we would, at that point, essentially be in the business of operating ElasticSearch as a Service, which isn't exactly what i14y was intended to be. That said, I think HEAD is a good feature; you aren't the first person to request it and we've needed it ourselves. We do, of course, offer the ability to search i14y separately from your configured, commercial engines via the v2 i14y search API (/api/v2/search/i14y?access_key={AFFILIATE_API_KEY}&query={YOUR_SEARCH_TERM}).

[ericpugh]

IMO, HEAD would be the way to go. I'm working on porting the Drupal module to version 8, and don't even really need GET (I also haven't used the v2, yet) but was just looking for a way to verify the existence of a document.
thanks.

[dawnpm]

@ericpugh if you're working on a D8 port, let's definitely talk!

[ericpugh]

@dawnpm, sounds good. should i just email you at support?

[dawnpm]

I'll ping you now, thanks!