[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2015-02-10 Thread Hudson (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14315512#comment-14315512
 ] 

Hudson commented on TIKA-1269:
--

SUCCESS: Integrated in tika-trunk-jdk1.7 #483 (See 
[https://builds.apache.org/job/tika-trunk-jdk1.7/483/])
TIKA-1269. Add link to tika.apache.org Miredot documentation on the tika-server 
index. (tpalsulich: 
http://svn.apache.org/viewvc/tika/trunk/?view=revrev=1658864)
* /tika/trunk/tika-server/src/main/java/org/apache/tika/server/TikaWelcome.java
TIKA-1269. Add Miredot documentation for tika-server. (tpalsulich: 
http://svn.apache.org/viewvc/tika/trunk/?view=revrev=1658847)
* /tika/trunk/tika-server/pom.xml


 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.8

 Attachments: TIKA-1269-miredot.patch, enable-enunciate.patch


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2015-02-10 Thread Lewis John McGibbney (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14315542#comment-14315542
 ] 

Lewis John McGibbney commented on TIKA-1269:


ACK

 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.8

 Attachments: TIKA-1269-miredot.patch, enable-enunciate.patch


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2015-02-10 Thread Lewis John McGibbney (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14315348#comment-14315348
 ] 

Lewis John McGibbney commented on TIKA-1269:


Hi [~tpalsulich] good job, can you please post the link here to where this is 
deployed e.g. link to the nightly build workspace
Thank you so much Tyler good job on this one

 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.8

 Attachments: TIKA-1269-miredot.patch, enable-enunciate.patch


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2015-02-10 Thread Lewis John McGibbney (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14315521#comment-14315521
 ] 

Lewis John McGibbney commented on TIKA-1269:


[~tpalsulich] the nightly link to the Miredot documentation can be linked to 
directly from Jenkins
https://builds.apache.org/job/tika-trunk-jdk1.7/ws/trunk/tika-server/target/miredot/index.html


 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.8

 Attachments: TIKA-1269-miredot.patch, enable-enunciate.patch


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2015-02-10 Thread Tyler Palsulich (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14315538#comment-14315538
 ] 

Tyler Palsulich commented on TIKA-1269:
---

Thanks. But, I think that requires login...

 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.8

 Attachments: TIKA-1269-miredot.patch, enable-enunciate.patch


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2015-02-10 Thread Lewis John McGibbney (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14315269#comment-14315269
 ] 

Lewis John McGibbney commented on TIKA-1269:


+1 [~tpalsulich] please commit this. We can add the Maven target to the JDK 1.7 
build and link to it from the main tika.apache.org website for now. We can then 
bake it into the ongoing Web App work elsewhere.

 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.8

 Attachments: TIKA-1269-miredot.patch, enable-enunciate.patch


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2015-02-10 Thread Tyler Palsulich (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14315305#comment-14315305
 ] 

Tyler Palsulich commented on TIKA-1269:
---

Committed patch from [~lewismc] in r1658847. Adding documentation to site now 
(for Tika 1.8).

 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.8

 Attachments: TIKA-1269-miredot.patch, enable-enunciate.patch


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2014-07-24 Thread Nick Burch (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14073164#comment-14073164
 ] 

Nick Burch commented on TIKA-1269:
--

It's a bit hard to be sure on Miredot when most (all?) of the endpoints lack 
the documentation to make them look nice... Any chance someone (Lewis?) could 
add those javadocs and annotations etc to just one endpoint, so we can see 
Miredot in all it's glory before we decide?

 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.7

 Attachments: TIKA-1269-miredot.patch, enable-enunciate.patch


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.2#6252)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2014-07-24 Thread Lewis John McGibbney (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14073562#comment-14073562
 ] 

Lewis John McGibbney commented on TIKA-1269:


Yep I am on it right now. Patch coming up [~gagravarr]

 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.7

 Attachments: TIKA-1269-miredot.patch, enable-enunciate.patch


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.2#6252)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2014-07-23 Thread Nick Burch (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14072311#comment-14072311
 ] 

Nick Burch commented on TIKA-1269:
--

I guess we'll need a bit of Maven / Ant-in-Maven magic to bundle the generated 
html up into the Tika Server jar, so it can be hosted from within the Server?

 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.7

 Attachments: TIKA-1269-miredot.patch, enable-enunciate.patch


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.2#6252)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2014-07-23 Thread Lewis John McGibbney (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14072368#comment-14072368
 ] 

Lewis John McGibbney commented on TIKA-1269:


Hi [~gagravarr] yeah I have a couple of thoughts here 
 * use the maven-assembly-plugin to generate the following release artifacts, 
server without packaged dependencies, server with packaged depdencies and 
embedded server (similar to what we currently have) which is invoked via bash 
script and which runs via org.mortbay.jetty:jetty-runner.
 * also put work into the .war file which we can run as a web app within any 
servlet container... as we also do with Any23.
For the artifacts which ship with the generated artifacts, we would simply 
define the generated Miredot documentation as resources within the XML 
descriptors for the plugin Maven configuration.
As for the WAR documentation, we would define them as WebResources which would 
then be picked up by the maven-war-plugin when we generate the WAR artifact.

I therefore propose (if you guys are happy with using Miredot for the 
documentation) that we commit the current patch on this issue, then address the 
Javadoc as well as JAX-RS Annotations in a separate issue, before writing the 
assembly descriptors and web application WAR file all in separate issues.

wdyt?

 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.7

 Attachments: TIKA-1269-miredot.patch, enable-enunciate.patch


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.2#6252)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2014-06-05 Thread Hudson (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14019434#comment-14019434
 ] 

Hudson commented on TIKA-1269:
--

SUCCESS: Integrated in tika-trunk-jdk1.6 #22 (See 
[https://builds.apache.org/job/tika-trunk-jdk1.6/22/])
TIKA-1269 Some endpoints may lack a produces annotation (nick: 
http://svn.apache.org/viewvc/tika/trunk/?view=revrev=1600793)
* /tika/trunk/tika-server/src/main/java/org/apache/tika/server/TikaWelcome.java


 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.7

 Attachments: enable-enunciate.patch


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.2#6252)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2014-04-14 Thread Lewis John McGibbney (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=13968215#comment-13968215
 ] 

Lewis John McGibbney commented on TIKA-1269:


An alternative to miredot.
http://enunciate.codehaus.org/
ASLv2.0 licensed


 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.6


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.2#6252)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2014-04-14 Thread Sergey Beryozkin (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=13968296#comment-13968296
 ] 

Sergey Beryozkin commented on TIKA-1269:


Hi Lewis, thanks for the comments,

First of all, here are few more links:

http://tools.ietf.org/html/draft-nottingham-json-home-02
and
http://www.restdoc.org/spec.html

Both support JSON to describe the services. IMHO it can be tricky to turn it to 
HTML.

If I were to choose, I'd go for either Enunciate or WADL. I don't have the 
experience with the former, I should've really had some, I know it requires a 
bit of customizations and people who have done it seem to be happy. The reason 
I like WADL is that, in addition to being the most complete language IMHO, it 
is also, being  XML, can be easily turned into HTML. For example, Apache 
Syncope uses this approach.

As a side note, my favourite style is:
https://dev.twitter.com/docs/api/1.1 

I think WADL can support it.
As far as CXF is concerned: it can auto-generate WADL or have a prepared WADL 
registered; the work on Java to WADL generation at the build time is in 
progress. The prepared WADL style might be preferred because Tika Server API is 
not rich in a sense that it has no grammars/schemas available, it is fairly 
simple at this stage and as such it can be difficult to create a descriptive 
document.

That said, I'm fine if the other approach gets chosen; I don't have experience 
with Enunciate but hopefully someone else does :-).
I'm also open to getting CXF itself further enhanced to support different 
approaches, and right now I'm leaning toward JSON home as I know it has some 
traction in the community... CXF also optionally supports Swagger but it 
requires few Scala dependencies...

Cheers, Sergey
 






 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.6

 Attachments: enable-enunciate.patch


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.2#6252)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2014-04-12 Thread Lewis John McGibbney (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=13967583#comment-13967583
 ] 

Lewis John McGibbney commented on TIKA-1269:


Hi [~sergey_beryozkin] I also found http://www.miredot.com/ as a possible 
solution. I've never used this before though and would be implementing from 
scratch.
It is free for OSS projects with a proven track record.

Can this be contained within CXF itself? If so then maybe it will be less 
hassle to just implement it with CXF instead.

 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.6


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.2#6252)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2014-04-12 Thread Lewis John McGibbney (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=13967584#comment-13967584
 ] 

Lewis John McGibbney commented on TIKA-1269:


I've just taken a look into the tika-server code. All of the JAXRS annotations 
are supported via miredot
http://www.miredot.com/docs/supportedframeworks/
Here is an example of the result
http://www.miredot.com/exampledocs/
I'm also over on dev@community in an effort to see if we have something within 
Apache which can achieve the same output. 

 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.6


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.2#6252)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2014-04-09 Thread Nick Burch (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=13964762#comment-13964762
 ] 

Nick Burch commented on TIKA-1269:
--

Some CXF people at ApacheCon have suggested that Enunciate may be able to help 
with this, but given how few endpoints we have + that we want to generate + 
host things on the fly, it might not be the best fix. (Enunciate seems, from 
initial investigations, to be more aimed at generating the docs at build time)

 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.6


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.2#6252)


[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

2014-04-09 Thread Sergey Beryozkin (JIRA)

[ 
https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=13964973#comment-13964973
 ] 

Sergey Beryozkin commented on TIKA-1269:


Submitting a _wadl query to Tika Server will produce a WADL document. CXF can 
also be configured to support .wadl extensions if needed. This can be 
reasonable for a start. WADL (XML document) can be transformed to HTML going 
forward, 

Cheers, Sergey

 Self-hosted documentation for the JAX-RS Server
 ---

 Key: TIKA-1269
 URL: https://issues.apache.org/jira/browse/TIKA-1269
 Project: Tika
  Issue Type: Improvement
  Components: server
Affects Versions: 1.5
Reporter: Nick Burch
 Fix For: 1.6


 Currently, if you fire up the JAX-RS Tika Server, and go to the root of the 
 server in a web browser, you get an empty page back. You have to know to head 
 over to https://wiki.apache.org/tika/TikaJAXRS find out what the available 
 URLs are
 We should self-host some simple documentation on the server at the root of 
 it, so that people can discover what it offers. Ideally, this should be 
 largely auto-generated based on the endpoints, so that we don't risk missing 
 things when we add new features
 This will also allow us to potentially offer a sample running version of the 
 server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.2#6252)