Project

General

Profile

« Previous | Next » 

Revision 665ed388

Added by Andreas Kohlbecker about 9 years ago

working on documentation and fixing include pattern for catalogue services

View differences:

cdmlib-remote-webapp/src/main/java/eu/etaxonomy/cdm/remote/config/CdmSpringMVCConfig.java
278 278
       logger.debug("swaggerSpringMvcPlugin");
279 279
       configureModelConverters();
280 280
       return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
281
          .apiInfo(apiInfo(WEB_PORTAL_SERVICES, "The Portal Service is a specialization to the "
281
          .apiInfo(apiInfo(WEB_PORTAL_SERVICES, "<p>The Portal Service is a specialization to the "
282 282
                  + "<a href=\"?group=Generic+REST+API\">Generic  REST API</a> as needed by CDM Dataportal "
283 283
                  + " that adds some fields like localized representations to the pure CDM entities. Another important difference "
284 284
                  + " is the initialization depth of the CDM entities. The Portal Service enpoints provide far bigger parts of the "
285
                  + " object graph."))
285
                  + " object graph.</p>"))
286 286
          .includePatterns("/portal/.*")
287 287
          .ignoredParameterTypes(allCdmTpyes())
288 288
          .swaggerGroup(WEB_PORTAL_SERVICES);
......
294 294
       return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
295 295
           .apiInfo(apiInfo(
296 296
                   CATALOGUE_SERVICES,
297
                   "These web services are optimized for using names taxonomic information and occurence data in workflow environments "
297
                   "<p>These web services are optimized for using names taxonomic information and occurence data in workflow environments "
298 298
                   + " but are suitabale for all applicatoins in which fast response times are crucial."
299
                   + " Additional detailed documentation of these services can also be found at:"
299
                   + " Additional detailed documentation of these services can also be found at:</p>"
300 300
                   + "<ul>"
301 301
                   + "<li><a href=\"http://cybertaxonomy.eu/cdmlib/rest-api-name-catalogue.html\">Name Catalogue REST API</a>"
302 302
                   + "<li><a href=\"http://cybertaxonomy.eu/cdmlib/rest-api-occurrence-catalogue.html\">Occurrence Catalogue REST API</a>"
303 303
                   + "<li><a href=\"doc/?group=Catalogue+Services\">Catalogue Services</a>"
304 304
                   + "</ul>"
305 305
                   ))
306
           .includePatterns("/name_catalogue/.*", "/occurrence_catalogue/.*")
306
           .includePatterns("/name_catalogue.*", "/occurrence_catalogue.*")
307 307
           .ignoredParameterTypes(allCdmTpyes())
308 308
           .swaggerGroup(CATALOGUE_SERVICES);
309 309
   }
......
315 315
       return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
316 316
          .apiInfo(apiInfo(
317 317
                  "OAI-PMH",
318
                  "<p>This is an automatcially created documentation on the OAI-PMH API which is atually dedicated to REST services."
318
                  "<p>This is an automatcially created documentation on the OAI-PMH service which is atually dedicated to REST services."
319 319
                  + " Since OAI-PMH is not a REST service in the original sense, you may want to refer to"
320 320
                  + " the more specific <a href=\"http://cybertaxonomy.eu/cdmlib/oai-pmh.html\">OAI-PMH documentation</a> or"
321 321
                  + " to the service endpoints them self, which also provide a good, comprehensive and selfexplanatory"

Also available in: Unified diff