You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@manifoldcf.apache.org by kw...@apache.org on 2012/06/15 01:46:48 UTC
svn commit: r1350427 - in /manifoldcf/trunk: CHANGES.txt
site/src/documentation/content/xdocs/en_US/programmatic-operation.xml
site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml
Author: kwright
Date: Thu Jun 14 23:46:47 2012
New Revision: 1350427
URL: http://svn.apache.org/viewvc?rev=1350427&view=rev
Log:
Fix for CONNECTORS-481. Correct return values in API documentation.
Modified:
manifoldcf/trunk/CHANGES.txt
manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml
manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml
Modified: manifoldcf/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/manifoldcf/trunk/CHANGES.txt?rev=1350427&r1=1350426&r2=1350427&view=diff
==============================================================================
--- manifoldcf/trunk/CHANGES.txt (original)
+++ manifoldcf/trunk/CHANGES.txt Thu Jun 14 23:46:47 2012
@@ -3,6 +3,9 @@ $Id$
======================= 0.6-dev =====================
+CONNECTORS-481: Documentation of API is wrong in a few spots.
+(Adrian Conlon, Karl Wright)
+
CONNECTORS-480: Documentum and FileNet connector run.sh scripts
broken.
(Joe Becknell, Karl Wright)
Modified: manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml
URL: http://svn.apache.org/viewvc/manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml?rev=1350427&r1=1350426&r2=1350427&view=diff
==============================================================================
--- manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml (original)
+++ manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml Thu Jun 14 23:46:47 2012
@@ -52,28 +52,28 @@
<tr><td>repositoryconnectors</td><td>GET</td><td>List all registered repository connectors</td><td>N/A</td><td>{"repositoryconnector":[<em><list_of_repository_connector_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>outputconnections</td><td>GET</td><td>List all output connections</td><td>N/A</td><td>{"outputconnection":[<em><list_of_output_connection_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>outputconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Get a specific output connection</td><td>N/A</td><td>{"outputconnection":<em><output_connection_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
- <tr><td>outputconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create an output connection</td><td>{"outputconnection":<em><output_connection_object></em>}</td><td>{"connection_name":<em><connection_name></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>outputconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create an output connection</td><td>{"outputconnection":<em><output_connection_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>outputconnections/<em><encoded_connection_name></em></td><td>DELETE</td><td>Delete an output connection</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>status/outputconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Check the status of an output connection</td><td>N/A</td><td>{"check_result":<em><message></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>info/outputconnections/<em><encoded_connection_name></em>/<em><connector_specific_resource></em></td><td>GET</td><td>Retrieve arbitrary connector-specific resource</td><td>N/A</td><td><em><response_data></em> <strong>OR</strong> {"error":<em><error_text></em>} <strong>OR</strong> {"service_interruption":<em><error_text></em>}</td></tr>
<tr><td>reset/outputconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Forget previous indexing state</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authorityconnections</td><td>GET</td><td>List all authority connections</td><td>N/A</td><td>{"authorityconnection":[<em><list_of_authority_connection_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authorityconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Get a specific authority connection</td><td>N/A</td><td>{"authorityconnection":<em><authority_connection_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
- <tr><td>authorityconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create an authority connection</td><td>{"authorityconnection":<em><authority_connection_object></em>}</td><td>{"connection_name":<em><connection_name></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>authorityconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create an authority connection</td><td>{"authorityconnection":<em><authority_connection_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authorityconnections/<em><encoded_connection_name></em></td><td>DELETE</td><td>Delete an authority connection</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>status/authorityconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Check the status of an authority connection</td><td>N/A</td><td>{"check_result":<em><message></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>repositoryconnections</td><td>GET</td><td>List all repository connections</td><td>N/A</td><td>{"repositoryconnection":[<em><list_of_repository_connection_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>repositoryconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Get a specific repository connection</td><td>N/A</td><td>{"repositoryconnection":<em><repository_connection_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
- <tr><td>repositoryconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create a repository connection</td><td>{"repositoryconnection":<em><repository_connection_object></em>}</td><td>{"connection_name":<em><connection_name></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>repositoryconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create a repository connection</td><td>{"repositoryconnection":<em><repository_connection_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>repositoryconnections/<em><encoded_connection_name></em></td><td>DELETE</td><td>Delete a repository connection</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>status/repositoryconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Check the status of a repository connection</td><td>N/A</td><td>{"check_result":<em><message></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>info/repositoryconnections/<em><encoded_connection_name></em>/<em><connector_specific_resource></em></td><td>GET</td><td>Retrieve arbitrary connector-specific resource</td><td>N/A</td><td><em><response_data></em> <strong>OR</strong> {"error":<em><error_text></em>} <strong>OR</strong> {"service_interruption":<em><error_text></em>}</td></tr>
<tr><td>jobs</td><td>GET</td><td>List all job definitions</td><td>N/A</td><td>{"job":[<em><list_of_job_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>jobs</td><td>POST</td><td>Create a job</td><td>{"job":<em><job_object></em>}</td><td>{"job_id":<em><job_identifier></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>jobs/<em><job_id></em></td><td>GET</td><td>Get a specific job definition</td><td>N/A</td><td>{"job":<em><job_object_></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
- <tr><td>jobs/<em><job_id></em></td><td>PUT</td><td>Save a job definition</td><td>{"job":<em><job_object></em>}</td><td>{"job_id":<em><job_identifier></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>jobs/<em><job_id></em></td><td>PUT</td><td>Save a job definition</td><td>{"job":<em><job_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>jobs/<em><job_id></em></td><td>DELETE</td><td>Delete a job definition</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
- <tr><td>jobstatuses</td><td>GET</td><td>List all jobs and their status</td><td>N/A</td><td>{"job":[<em><list_of_job_status_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>jobstatuses</td><td>GET</td><td>List all jobs and their status</td><td>N/A</td><td>{"jobstatus":[<em><list_of_job_status_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>jobstatuses/<em><job_id></em></td><td>GET</td><td>Get a specific job's status</td><td>N/A</td><td>{"jobstatus":<em><job_status_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>} </td></tr>
<tr><td>jobstatusesnocounts/<em><job_id></em></td><td>GET</td><td>Get a specific job's status, returning '0' for all counts</td><td>N/A</td><td>{"jobstatus":<em><job_status_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>} </td></tr>
<tr><td>start/<em><job_id></em></td><td>PUT</td><td>Start a specified job manually</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
Modified: manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml
URL: http://svn.apache.org/viewvc/manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml?rev=1350427&r1=1350426&r2=1350427&view=diff
==============================================================================
--- manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml (original)
+++ manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml Thu Jun 14 23:46:47 2012
@@ -52,28 +52,28 @@
<tr><td>repositoryconnectors</td><td>GET</td><td>List all registered repository connectors</td><td>N/A</td><td>{"repositoryconnector":[<em><list_of_repository_connector_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>outputconnections</td><td>GET</td><td>List all output connections</td><td>N/A</td><td>{"outputconnection":[<em><list_of_output_connection_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>outputconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Get a specific output connection</td><td>N/A</td><td>{"outputconnection":<em><output_connection_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
- <tr><td>outputconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create an output connection</td><td>{"outputconnection":<em><output_connection_object></em>}</td><td>{"connection_name":<em><connection_name></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>outputconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create an output connection</td><td>{"outputconnection":<em><output_connection_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>outputconnections/<em><encoded_connection_name></em></td><td>DELETE</td><td>Delete an output connection</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>status/outputconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Check the status of an output connection</td><td>N/A</td><td>{"check_result":<em><message></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>info/outputconnections/<em><encoded_connection_name></em>/<em><connector_specific_resource></em></td><td>GET</td><td>Retrieve arbitrary connector-specific resource</td><td>N/A</td><td><em><response_data></em> <strong>OR</strong> {"error":<em><error_text></em>} <strong>OR</strong> {"service_interruption":<em><error_text></em>}</td></tr>
<tr><td>reset/outputconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Forget previous indexing state</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authorityconnections</td><td>GET</td><td>List all authority connections</td><td>N/A</td><td>{"authorityconnection":[<em><list_of_authority_connection_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authorityconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Get a specific authority connection</td><td>N/A</td><td>{"authorityconnection":<em><authority_connection_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
- <tr><td>authorityconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create an authority connection</td><td>{"authorityconnection":<em><authority_connection_object></em>}</td><td>{"connection_name":<em><connection_name></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>authorityconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create an authority connection</td><td>{"authorityconnection":<em><authority_connection_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authorityconnections/<em><encoded_connection_name></em></td><td>DELETE</td><td>Delete an authority connection</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>status/authorityconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Check the status of an authority connection</td><td>N/A</td><td>{"check_result":<em><message></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>repositoryconnections</td><td>GET</td><td>List all repository connections</td><td>N/A</td><td>{"repositoryconnection":[<em><list_of_repository_connection_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>repositoryconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Get a specific repository connection</td><td>N/A</td><td>{"repositoryconnection":<em><repository_connection_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
- <tr><td>repositoryconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create a repository connection</td><td>{"repositoryconnection":<em><repository_connection_object></em>}</td><td>{"connection_name":<em><connection_name></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>repositoryconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create a repository connection</td><td>{"repositoryconnection":<em><repository_connection_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>repositoryconnections/<em><encoded_connection_name></em></td><td>DELETE</td><td>Delete a repository connection</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>status/repositoryconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Check the status of a repository connection</td><td>N/A</td><td>{"check_result":<em><message></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>info/repositoryconnections/<em><encoded_connection_name></em>/<em><connector_specific_resource></em></td><td>GET</td><td>Retrieve arbitrary connector-specific resource</td><td>N/A</td><td><em><response_data></em> <strong>OR</strong> {"error":<em><error_text></em>} <strong>OR</strong> {"service_interruption":<em><error_text></em>}</td></tr>
<tr><td>jobs</td><td>GET</td><td>List all job definitions</td><td>N/A</td><td>{"job":[<em><list_of_job_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>jobs</td><td>POST</td><td>Create a job</td><td>{"job":<em><job_object></em>}</td><td>{"job_id":<em><job_identifier></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>jobs/<em><job_id></em></td><td>GET</td><td>Get a specific job definition</td><td>N/A</td><td>{"job":<em><job_object_></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
- <tr><td>jobs/<em><job_id></em></td><td>PUT</td><td>Save a job definition</td><td>{"job":<em><job_object></em>}</td><td>{"job_id":<em><job_identifier></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>jobs/<em><job_id></em></td><td>PUT</td><td>Save a job definition</td><td>{"job":<em><job_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>jobs/<em><job_id></em></td><td>DELETE</td><td>Delete a job definition</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
- <tr><td>jobstatuses</td><td>GET</td><td>List all jobs and their status</td><td>N/A</td><td>{"job":[<em><list_of_job_status_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>jobstatuses</td><td>GET</td><td>List all jobs and their status</td><td>N/A</td><td>{"jobstatus":[<em><list_of_job_status_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>jobstatuses/<em><job_id></em></td><td>GET</td><td>Get a specific job's status</td><td>N/A</td><td>{"jobstatus":<em><job_status_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>} </td></tr>
<tr><td>jobstatusesnocounts/<em><job_id></em></td><td>GET</td><td>Get a specific job's status, returning '0' for all counts</td><td>N/A</td><td>{"jobstatus":<em><job_status_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>} </td></tr>
<tr><td>start/<em><job_id></em></td><td>PUT</td><td>Start a specified job manually</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>