All REST Entry Points


(David Pilato) #1

Heya,

I'm working on a SPORE definition file [1] for Elasticsearch.
Is there any file, java class, whatever where I can find all entry points or do
I have to dig into documentation?

Thanks for any hint.

[1]https://github.com/SPORE/api-description

--
David Pilato
http://www.scrutmydocs.org/
http://dev.david.pilato.fr/
Twitter : @dadoonet / @elasticsearchfr / @scrutmydocs

--


(Ivan Brusic) #2

I don't think there is any canonical reference for all REST endpoints, but
their corresponding classes should all be in the
org.elasticsearch.rest.action package.

https://github.com/elasticsearch/elasticsearch/tree/master/src/main/java/org/elasticsearch/rest/action

RestActionModule has a list of all classes involved, but not the actual
endpoints. All endpoints are registered with the RestController, but all
the handlers are marked as private. I once tried to find the same
information, but didn't venture further.

Cheers,

Ivan

On Mon, Oct 15, 2012 at 12:20 PM, David Pilato david@pilato.fr wrote:

**
Heya,

I'm working on a SPORE definition file [1] for Elasticsearch.
Is there any file, java class, whatever where I can find all entry points
or do I have to dig into documentation?

Thanks for any hint.

[1]https://github.com/SPORE/api-description

--
David Pilato
http://www.scrutmydocs.org/
http://dev.david.pilato.fr/
Twitter : @dadoonet / @elasticsearchfr / @scrutmydocs

--

--


(Igor Motov) #3

When we faced the same problem in elasticsearch-jetty plugin, we ended up
solving it by searching elasticsearch source code for the string
"controller.registerHandler". This search should return you all registered
REST end points. You can find a script that is doing it
here https://github.com/sonian/elasticsearch-jetty/blob/master/scripts/find-methods.sh It
will output results in this
format: https://github.com/sonian/elasticsearch-jetty/blob/master/scripts/methods.txt I
have to admit it's probably not the most elegant and precise method, but I
think it beats digging through documentation :slight_smile:

On Monday, October 15, 2012 3:34:26 PM UTC-4, Ivan Brusic wrote:

I don't think there is any canonical reference for all REST endpoints, but
their corresponding classes should all be in the
org.elasticsearch.rest.action package.

https://github.com/elasticsearch/elasticsearch/tree/master/src/main/java/org/elasticsearch/rest/action

RestActionModule has a list of all classes involved, but not the actual
endpoints. All endpoints are registered with the RestController, but all
the handlers are marked as private. I once tried to find the same
information, but didn't venture further.

Cheers,

Ivan

On Mon, Oct 15, 2012 at 12:20 PM, David Pilato <da...@pilato.fr<javascript:>

wrote:

**
Heya,

I'm working on a SPORE definition file [1] for Elasticsearch.
Is there any file, java class, whatever where I can find all entry
points or do I have to dig into documentation?

Thanks for any hint.

[1]https://github.com/SPORE/api-description

--
David Pilato
http://www.scrutmydocs.org/
http://dev.david.pilato.fr/
Twitter : @dadoonet / @elasticsearchfr / @scrutmydocs

--

--


(David Pilato) #4

Wonderful! Thanks!

--
David :wink:
Twitter : @dadoonet / @elasticsearchfr / @scrutmydocs

Le 15 oct. 2012 à 21:37, Igor Motov imotov@gmail.com a écrit :

When we faced the same problem in elasticsearch-jetty plugin, we ended up solving it by searching elasticsearch source code for the string "controller.registerHandler". This search should return you all registered REST end points. You can find a script that is doing it here https://github.com/sonian/elasticsearch-jetty/blob/master/scripts/find-methods.sh It will output results in this format: https://github.com/sonian/elasticsearch-jetty/blob/master/scripts/methods.txt I have to admit it's probably not the most elegant and precise method, but I think it beats digging through documentation :slight_smile:

On Monday, October 15, 2012 3:34:26 PM UTC-4, Ivan Brusic wrote:

I don't think there is any canonical reference for all REST endpoints, but their corresponding classes should all be in the org.elasticsearch.rest.action package.

https://github.com/elasticsearch/elasticsearch/tree/master/src/main/java/org/elasticsearch/rest/action

RestActionModule has a list of all classes involved, but not the actual endpoints. All endpoints are registered with the RestController, but all the handlers are marked as private. I once tried to find the same information, but didn't venture further.

Cheers,

Ivan

On Mon, Oct 15, 2012 at 12:20 PM, David Pilato da...@pilato.fr wrote:

Heya,

I'm working on a SPORE definition file [1] for Elasticsearch.
Is there any file, java class, whatever where I can find all entry points or do I have to dig into documentation?

Thanks for any hint.

[1]https://github.com/SPORE/api-description

--
David Pilato
http://www.scrutmydocs.org/
http://dev.david.pilato.fr/
Twitter : @dadoonet / @elasticsearchfr / @scrutmydocs

--

--


(system) #5