[
https://issues.apache.org/jira/browse/NUTCH-1800?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Lewis John McGibbney updated NUTCH-1800:
----------------------------------------
Attachment: NUTCH-1800.patch
Patch for trunk. Currently uses my own license key (which is OK) we will switch
this out for a more stable license key once the guy Yves gets back to us from
Miredot.
In order to see the REST API documentation, you need to
* download ant-maven-tasks from Maven Central and put it into $NUTCH_HOME/ivy/
* execute
{code}
ant -lib ivy restdocs
{code}
The reason that this is a bit messy is simply because Miredot only has builds
for Maven and Gradle. This patch works around that by utilizing Maven Ant Tasks.
Excellent work to everyone who has been developing and augmenting the REST
API... there are a bunch of improvements suggested by Miredot which will make
our REST API documentation braw!
> Documentation for Nutch 1.X and 2.X REST APIs
> ---------------------------------------------
>
> Key: NUTCH-1800
> URL: https://issues.apache.org/jira/browse/NUTCH-1800
> Project: Nutch
> Issue Type: Bug
> Components: documentation, REST_api
> Reporter: Lewis John McGibbney
> Assignee: Lewis John McGibbney
> Fix For: 1.11, 2.3.1
>
> Attachments: NUTCH-1800.patch
>
>
> This issue should build on NUTCH-1769 with full Java documentation for all
> classes in the following packages
> org.apache.nutch.api.*
> I am assigning this one to [~fjodor.vershinin] as he is doing an excellent
> job on the REST API. His UML graphic in [0] and commantary shows that he has
> a goo dunderstanding of the REST API and its functionality.
> Thank you [~fjodor.vershinin] great work.
> [0] https://wiki.apache.org/nutch/NutchRESTAPI#UML_Graphic
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
