Skip to content
Snippets Groups Projects
Commit d839b9cc authored by srosse's avatar srosse
Browse files

OO-2718: reenable REST API documentation

parent daa860ef
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
pom.xml
+ 89
− 48
View file @ d839b9cc
......@@ -98,8 +98,8 @@
<build>
<plugins>
<plugin>
<groupId>com.sun.tools.jxc.maven2</groupId>
<artifactId>maven-jaxb-schemagen-plugin</artifactId>
<groupId>org.codehaus.mojo</groupId>
<artifactId>jaxb2-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
......@@ -1171,6 +1171,8 @@
<exclude>**/*.pdf</exclude>
<exclude>**/*.graffle</exclude>
<exclude>**/doc-files/**</exclude>
<exclude>**/propertyHandlers.jpg</exclude>
<exclude>**/package.html</exclude>
</excludes>
</resource>
<resource>
......@@ -1255,7 +1257,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.18.1</version>
<version>2.19.1</version>
<configuration>
<encoding>UTF-8</encoding>
<skipTests>${skipTests}</skipTests>
......@@ -1274,7 +1276,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<version>2.18.1</version>
<version>2.19.1</version>
<configuration>
<encoding>UTF-8</encoding>
<skipITs>${skipSeleniumTests}</skipITs>
......@@ -1322,7 +1324,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.3</version>
<version>3.6.1</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
......@@ -1333,7 +1335,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<version>2.6</version>
<version>3.0.0</version>
<configuration>
<attachClasses>true</attachClasses>
<directory>src/main/java</directory>
......@@ -1348,7 +1350,7 @@
<Implementation-Build>${buildNumber}</Implementation-Build>
</manifestEntries>
</archive>
<excludes>**/*.pxm, **/*.psd, **/*.scss, **/*.sh, static/bootstrap/**, **/*.README</excludes>
<warSourceExcludes>**/*.pxm, **/*.psd, **/*.scss, **/*.sh, static/bootstrap/**, **/*.README</warSourceExcludes>
<webResources>
<resource>
<directory>src/main/webapp</directory>
......@@ -1432,43 +1434,46 @@
<!-- start rest api documentation: broken: mvn javadoc:javadoc -->
<plugin>
<groupId>com.sun.tools.jxc.maven2</groupId>
<artifactId>maven-jaxb-schemagen-plugin</artifactId>
<version>1.2</version>
<groupId>org.codehaus.mojo</groupId>
<artifactId>jaxb2-maven-plugin</artifactId>
<version>2.3.1</version>
<executions>
<execution>
<phase>generate-resources</phase>
<goals>
<goal>generate</goal>
<execution>
<id>schemagen</id>
<goals>
<goal>schemagen</goal>
</goals>
</execution>
</executions>
<configuration>
<srcdir>${basedir}/src/</srcdir>
<includes>
<include>org/olat/restapi/**/*VO.java</include>
<include>org/olat/user/restapi/**/*VO.java</include>
<include>org/olat/modules/fo/restapi/*VO.java</include>
<include>org/olat/catalog/restapi/*VO.java</include>
</includes>
<excludes></excludes>
<destdir>${project.build.outputDirectory}</destdir>
<sources>
<source>src/main/java/org/olat/core/commons/services/notifications/restapi/vo/</source>
<source>src/main/java/org/olat/commons/calendar/restapi/</source>
<source>src/main/java/org/olat/modules/fo/restapi/</source>
<source>src/main/java/org/olat/modules/gotomeeting/restapi/</source>
<source>src/main/java/org/olat/modules/vitero/restapi/</source>
<source>src/main/java/org/olat/modules/wiki/restapi/vo/</source>
<source>src/main/java/org/olat/restapi/system/vo/</source>
<source>src/main/java/org/olat/restapi/support/vo/</source>
<source>src/main/java/org/olat/registration/restapi/</source>
<source>src/main/java/org/olat/user/restapi/</source>
</sources>
<schemaSourceExcludeFilters>
<myExcludes implementation="org.codehaus.mojo.jaxb2.shared.filters.pattern.PatternFileFilter">
<patterns>
<pattern>jaxb\.index</pattern>
<pattern>.*WebService.java</pattern>
<pattern>.*Factory.java</pattern>
<pattern>.*Examples.java</pattern>
<pattern>.*DateParam.java</pattern>
<pattern>.*StatusVO.java</pattern>
<pattern>.*GoToErrorVO.java</pattern>
</patterns>
</myExcludes>
</schemaSourceExcludeFilters>
<outputDirectory>${project.build.outputDirectory}</outputDirectory>
<verbose>true</verbose>
</configuration>
<dependencies>
<dependency>
<groupId>xerces</groupId>
<artifactId>xercesImpl</artifactId>
<version>2.9.1</version>
</dependency>
<dependency>
<groupId>com.sun</groupId>
<artifactId>tools</artifactId>
<version>1.7</version>
<scope>system</scope>
<systemPath>${java.home}/../lib/tools.jar</systemPath>
</dependency>
</dependencies>
</plugin>
<!-- Javadoc -->
......@@ -1490,11 +1495,23 @@
<verbose>false</verbose>
<show>public</show>
<subpackages>
org.olat.restapi,org.olat.modules.fo.restapi,
org.olat.core.commons.services.notifications.restapi,org.olat.user.restapi,org.olat.course.nodes,
org.olat.restapi.system
</subpackages>
org.olat.core.commons.services.notifications.restapi,
org.olat.commons.calendar.restapi,
org.olat.course.nodes.bc,
org.olat.course.nodes.bc,
org.olat.course.nodes.co,
org.olat.course.nodes.en,
org.olat.course.certificate.restapi,
org.olat.course.db.restapi,
org.olat.modules.fo.restapi,
org.olat.modules.gotomeeting.restapi,
org.olat.modules.openmeetings.restapi,
org.olat.modules.vitero.restapi,
org.olat.modules.wiki.restapi,
org.olat.registration.restapi,
org.olat.restapi,
org.olat.user.restapi
</subpackages>
<doclet>com.sun.jersey.wadl.resourcedoc.ResourceDoclet</doclet>
<docletArtifacts>
<docletArtifact>
......@@ -1512,7 +1529,7 @@
<docletArtifact>
<groupId>xerces</groupId>
<artifactId>xercesImpl</artifactId>
<version>2.9.1</version>
<version>2.11.0</version>
</docletArtifact>
</docletArtifacts>
<additionalparam>-output
......@@ -1539,7 +1556,23 @@
<formatWadlFile>true</formatWadlFile>
<baseUri>http://www.example.com</baseUri>
<packagesResourceConfig>
<param>org.olat.restapi;org.olat.core.commons.services.notifications.restapi;org.olat.modules.fo.restapi;org.olat.user.restapi;org.olat.course.nodes</param>
<param>
org.olat.core.commons.services.notifications.restapi;
org.olat.commons.calendar.restapi;
org.olat.course.nodes.bc;
org.olat.course.nodes.co;
org.olat.course.nodes.en;
org.olat.course.certificate.restapi;
org.olat.course.db.restapi;
org.olat.modules.fo.restapi;
org.olat.modules.gotomeeting.restapi;
org.olat.modules.openmeetings.restapi;
org.olat.modules.vitero.restapi;
org.olat.modules.wiki.restapi;
org.olat.registration.restapi;
org.olat.restapi;
org.olat.user.restapi;
</param>
</packagesResourceConfig>
<wadlGenerators>
<wadlGeneratorDescription>
......@@ -1571,11 +1604,19 @@
</wadlGeneratorDescription>
</wadlGenerators>
</configuration>
<dependencies>
<dependency>
<groupId>xerces</groupId>
<artifactId>xercesImpl</artifactId>
<version>2.11.0</version>
</dependency>
</dependencies>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>xml-maven-plugin</artifactId>
<version>1.0.1</version>
<executions>
<execution>
<id>xslt: ${project.build.outputDirectory}/application.html</id>
......@@ -1606,8 +1647,8 @@
<dependencies>
<dependency>
<groupId>net.sf.saxon</groupId>
<artifactId>saxon</artifactId>
<version>8.7</version>
<artifactId>saxon9</artifactId>
<version>9.1.0.8</version>
</dependency>
</dependencies>
</plugin>
......@@ -2520,7 +2561,7 @@
</reporting>
<ciManagement>
<system>Hudson</system>
<url>http://jenkins.frentix.com</url>
<system>Jenkins</system>
<url>https://jenkins.frentix.com</url>
</ciManagement>
</project>
src/main/java/org/olat/course/db/restapi/CourseDbWebService.java
+ 27
− 26
View file @ d839b9cc
......@@ -53,19 +53,19 @@ import org.olat.restapi.support.vo.KeyValuePair;
* Access the custom dbs of a course
*
* <P>
* Initial Date: 7 apr. 2010 <br>
* Initial Date: *7 apr. 2010 <br>
* @author srosse, stephane.rosse@frentix.com
*/
@Path("repo/courses/{courseId}/db/{category}")
public class CourseDbWebService {
private static final String VERSION = "1.0";
private static final String VERSION = "1.0";
/**
* Retrieves the version of the Course DB Web Service.
* @response.representation.200.mediaType text/plain
* @response.representation.200.doc The version of this specific Web Service
* @response.representation.200.example 1.0
* @response.representation.200.mediaType text/plain
* @response.representation.200.doc The version of this specific Web Service
* @response.representation.200.example 1.0
* @return
*/
@GET
......@@ -78,9 +78,9 @@ public class CourseDbWebService {
/**
* Retrieve all values of the authenticated user
* @response.representation.200.qname {http://www.example.com}keyValuePair
* @response.representation.200.mediaType application/xml, application/json
* @response.representation.200.doc All the values in the course
* @response.representation.200.example {@link org.olat.restapi.support.vo.Examples#SAMPLE_KEYVALUEVOes}
* @response.representation.200.mediaType application/xml, application/json
* @response.representation.200.doc All the values in the course
* @response.representation.200.example {@link org.olat.restapi.support.vo.Examples#SAMPLE_KEYVALUEVOes}
* @param courseId The course resourceable's id
* @param category The name of the database
* @param request The HTTP request
......@@ -107,10 +107,10 @@ public class CourseDbWebService {
/**
* Put a new value for an authenticated user.
* @response.representation.qname {http://www.example.com}keyValuePair
* @response.representation.mediaType application/xml, application/json
* @response.representation.doc the key value pair is saved on the db
* @response.representation.example {@link org.olat.restapi.support.vo.Examples#SAMPLE_KEYVALUEVOes}
* @response.representation.200.doc the key value pair is saved on the db
* @response.representation.mediaType application/xml, application/json
* @response.representation.doc the key value pair is saved on the db
* @response.representation.example {@link org.olat.restapi.support.vo.Examples#SAMPLE_KEYVALUEVOes}
* @response.representation.200.doc the key value pair is saved on the db
* @param courseId The course resourceable's id
* @param category The name of the database
* @param pair The key value pair
......@@ -127,10 +127,10 @@ public class CourseDbWebService {
/**
* Update a value for an authenticated user.
* @response.representation.qname {http://www.example.com}keyValuePair
* @response.representation.mediaType application/xml, application/json
* @response.representation.doc the key value pair is saved on the db
* @response.representation.example {@link org.olat.restapi.support.vo.Examples#SAMPLE_KEYVALUEVOes}
* @response.representation.200.doc the key value pair is saved on the db
* @response.representation.mediaType application/xml, application/json
* @response.representation.doc the key value pair is saved on the db
* @response.representation.example {@link org.olat.restapi.support.vo.Examples#SAMPLE_KEYVALUEVOes}
* @response.representation.200.doc the key value pair is saved on the db
* @param courseId The course resourceable's id
* @param category The name of the database
* @param pair The key value pair
......@@ -147,9 +147,9 @@ public class CourseDbWebService {
/**
* Retrieve a value of an authenticated user.
* @response.representation.200.qname {http://www.example.com}keyValuePair
* @response.representation.200.mediaType application/xml, application/json
* @response.representation.200.doc The value in the course
* @response.representation.200.example {@link org.olat.restapi.support.vo.Examples#SAMPLE_KEYVALUEVO}
* @response.representation.200.mediaType application/xml, application/json
* @response.representation.200.doc The value in the course
* @response.representation.200.example {@link org.olat.restapi.support.vo.Examples#SAMPLE_KEYVALUEVO}
* @response.representation.404.doc The entry cannot be found
* @param courseId The course resourceable's id
* @param category The name of the database
......@@ -176,9 +176,9 @@ public class CourseDbWebService {
/**
* Retrieve a value of an authenticated user.
* @response.representation.200.qname {http://www.example.com}keyValuePair
* @response.representation.200.mediaType text/plain, text/html
* @response.representation.200.doc A value of the course
* @response.representation.200.example Green
* @response.representation.200.mediaType text/plain, text/html
* @response.representation.200.doc A value of the course
* @response.representation.200.example Green
* @response.representation.404.doc The entry cannot be found
* @param courseId The course resourceable's id
* @param category The name of the database
......@@ -205,7 +205,7 @@ public class CourseDbWebService {
/**
* Put a new value for an authenticated user.
* @response.representation.200.doc The value is saved in the course
* @response.representation.200.doc The value is saved in the course
* @param courseId The course resourceable's id
* @param category The name of the database
* @param name The name of the key value pair
......@@ -222,7 +222,7 @@ public class CourseDbWebService {
/**
* Update a value for an authenticated user.
* @response.representation.200.doc The value is saved in the course
* @response.representation.200.doc The value is saved in the course
* @param courseId The course resourceable's id
* @param category The name of the database
* @param name The name of the key value pair
......@@ -240,7 +240,7 @@ public class CourseDbWebService {
/**
* Delete a value for an authenticated user.
* @response.representation.200.doc the key value pair is remove from the db
* @response.representation.200.doc the key value pair is remove from the db
* @response.representation.401.doc The roles of the authenticated user are not sufficient
* @response.representation.404.doc The entry cannot be found
* @param courseId The course resourceable's id
......@@ -269,7 +269,8 @@ public class CourseDbWebService {
/**
* Fallbakc method for the browsers
* @response.representation.200.doc the key value pair is remove from the db
*
* @response.representation.200.doc the key value pair is remove from the db
* @response.representation.401.doc The roles of the authenticated user are not sufficient
* @response.representation.404.doc The entry cannot be found
* @param courseId The course resourceable's id
......
src/main/java/org/olat/modules/glossary/_static/register_sample.png deleted 100644 → 0
+ 0
− 0
View file @ daa860ef
src/main/java/org/olat/modules/glossary/_static/register_sample.png

9.58 KiB

src/main/java/org/olat/restapi/api/_content/application.html
+ 13417
− 14432
View file @ d839b9cc
source diff could not be displayed: it is too large. Options to address this: view the blob.
src/main/java/org/olat/restapi/repository/RepositoryEntryResource.java
+ 3
− 3
View file @ d839b9cc
......@@ -283,9 +283,9 @@ public class RepositoryEntryResource {
/**
* Returns the list of coaches of the repository entry.
* @response.representation.200.qname {http://www.example.com}userVO
* @response.representation.200.mediaType application/xml, application/json
* @response.representation.200.doc Coaches of the repository entry
* @response.representation.200.example {@link org.olat.user.restapi.Examples#SAMPLE_USERVOes}
* @response.representation.200.mediaType application/xml, application/json
* @response.representation.200.doc Coaches of the repository entry
* @response.representation.200.example {@link org.olat.user.restapi.Examples#SAMPLE_USERVOes}
* @response.representation.404.doc The repository entry cannot be found
* @param repoEntryKey The key of the repository entry
* @param request The HTTP Request
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment