Skip to content

Commit

Permalink
feat: Extend API documentation info description
Browse files Browse the repository at this point in the history
add ors core version and hint on how to render docs for older core versions
  • Loading branch information
TheGreatRefrigerator committed Apr 17, 2023
1 parent c65dd7a commit 486d852
Showing 1 changed file with 3 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@
import java.util.ArrayList;
import java.util.List;

import static org.heigit.ors.util.AppInfo.VERSION;

@Configuration
public class OpenApiConfiguration {

Expand Down Expand Up @@ -82,7 +84,7 @@ private List<Server> generateServers(ServletContext servletContext) {
private Info apiInfo() {
return new Info()
.title(SERVICE_NAME)
.description("This is the openrouteservice API documentation")
.description("This is the openrouteservice API V2 documentation for ORS Core-Version " + VERSION + ". Documentations for [older Core-Versions](https://github.com/GIScience/openrouteservice-docs/releases) can be rendered with the [Swagger-Editor](https://editor-next.swagger.io/).")
.version("2")
.contact(apiContact())
.license(apiLicence());
Expand Down

0 comments on commit 486d852

Please sign in to comment.