diff --git a/documentation/administrator-manual.md b/documentation/administrator-manual.md index 0006312f..943986f9 100644 --- a/documentation/administrator-manual.md +++ b/documentation/administrator-manual.md @@ -194,6 +194,17 @@ The software has an engine that automatically creates the cache for all the elem curl --noproxy localhost -i -X GET http://localhost:8080/re3gistry2restapi/cacheall ``` +### Swagger OpenAPI interactive UI + +To access the swagger openapi interactive interface you will have to change the parameters +found in the [docker-compose](https://github.com/ec-jrc/re3gistry/blob/develop/sources/Re3gistry2-build-helper/docker-compose.yml) file. The default value and ports for the UI are +localhost:8082. + +The frontend and backend interfaces both have a "Access API" hyperlink on the footer element. These links point to the default swagger URL, you might have to change it afterwards. + +You can manually add, edit and remove some of the options of the openapi interface by editing +the existing [openapi.json](https://github.com/ec-jrc/re3gistry/blob/develop/sources/Re3gistry2-build-helper/swagger/openapi.json) file. + ### Changing error messages You can change how the error messages are shown in your Re3gistry local instance. diff --git a/sources/Re3gistry2-build-helper/docker-compose.yml b/sources/Re3gistry2-build-helper/docker-compose.yml index 7f744b67..9f014ba8 100644 --- a/sources/Re3gistry2-build-helper/docker-compose.yml +++ b/sources/Re3gistry2-build-helper/docker-compose.yml @@ -23,7 +23,7 @@ services: # Test database to use it without installation # Be sure file sources-main/resources-configurations_files/system.installed # is removed from the war file. If not, installation will be not detected. - - ../../dist/customize-interface/example-profile-developer-docker/dump-docker-202205180929.sql:/docker-entrypoint-initdb.d/init_backup.sql + # - ../../dist/customize-interface/example-profile-developer-docker/dump-docker-202205180929.sql:/docker-entrypoint-initdb.d/init_backup.sql # login example db: name@example.com password expose: - "5432" diff --git a/sources/Re3gistry2-build-helper/pom.xml b/sources/Re3gistry2-build-helper/pom.xml index 8ef81403..b13def2c 100644 --- a/sources/Re3gistry2-build-helper/pom.xml +++ b/sources/Re3gistry2-build-helper/pom.xml @@ -51,10 +51,10 @@ developer-docker 5432 - host.docker.internal - registrydb - name - password + DB_ADDRESS + re3gistry2_dev + DB_USERNAME + DB_PASSWORD jdbc:postgresql://${persistence.db.address}:${persistence.db.port}/${persistence.db.name} SHIRO http://localhost/re3gistry2/ @@ -67,13 +67,13 @@ work/registrylogger.log OFF ecl - localhost - 2500 + example-smtp.eu + 25 false - false - name - password - admin@example.com + true + + + sender@example.eu false neutral ON @@ -145,4 +145,4 @@ - + \ No newline at end of file diff --git a/sources/Re3gistry2-build-helper/swagger/openapi.json b/sources/Re3gistry2-build-helper/swagger/openapi.json index 4a9330f6..1c54fddd 100644 --- a/sources/Re3gistry2-build-helper/swagger/openapi.json +++ b/sources/Re3gistry2-build-helper/swagger/openapi.json @@ -2,12 +2,12 @@ "openapi": "3.0.0", "info": { "title": "Re3gistry2 API", - "description": "Re3gistry2 API", + "description": "Welcome to the Re3gistry2 Swagger API interactive documentation. In this tool you will be able to try and interact with the different endpoints and API procedures of the application. For a deeper understanding on the behaviour of the API and how to use it you can consult the different documentation manuals. Any issues and questions can be reported in the Re3gistry2 GitHub repository.", "contact": { "name": "JRC Registry team", "url": "https://github.com/ec-jrc/re3gistry" }, - "version": "2.4.2" + "version": "2.5.0" }, "servers": [ { @@ -21,12 +21,13 @@ "/rest": { "description": "Register and item resources", "get": { - "description": "Fetch Register or Item", + "description": "Fetch a Register or Item", "parameters": [ { "in": "query", "name": "uri", "required": false, + "description": "Uniform Resource Identifier", "schema": { "type": "string" } @@ -35,6 +36,7 @@ "in": "query", "name": "uuid", "required": false, + "description": "Unique Item Identifier", "schema": { "type": "string" } @@ -43,6 +45,7 @@ "in": "query", "name": "lang", "required": false, + "description": "Language that content is returned in", "schema": { "type": "string", "example": "en" @@ -52,6 +55,7 @@ "in": "query", "name": "format", "required": false, + "description": "Format of the returned content", "schema": { "type": "string", "example": "jsonc" @@ -61,6 +65,7 @@ "in": "query", "name": "status", "required": false, + "description": "Acceptance status of the returned Items", "schema": { "type": "string", "example": "proposed" @@ -69,6 +74,7 @@ { "in": "query", "name": "itemclass", + "description": "Type of the returned item", "required": false, "schema": { "type": "string" diff --git a/sources/Re3gistry2/src/main/webapp/jsp/ajaxServices/browseLoader.jsp b/sources/Re3gistry2/src/main/webapp/jsp/ajaxServices/browseLoader.jsp index 61f05778..9e92874a 100644 --- a/sources/Re3gistry2/src/main/webapp/jsp/ajaxServices/browseLoader.jsp +++ b/sources/Re3gistry2/src/main/webapp/jsp/ajaxServices/browseLoader.jsp @@ -656,21 +656,28 @@ - +
- - + <% } else { %>
<%}%> diff --git a/sources/Re3gistry2/src/main/webapp/jsp/includes/footer.inc.jsp b/sources/Re3gistry2/src/main/webapp/jsp/includes/footer.inc.jsp index a0fe2234..92792004 100644 --- a/sources/Re3gistry2/src/main/webapp/jsp/includes/footer.inc.jsp +++ b/sources/Re3gistry2/src/main/webapp/jsp/includes/footer.inc.jsp @@ -53,7 +53,7 @@ ${properties.getProperty('application.default.name')} management diff --git a/sources/Re3gistry2/src/main/webapp/jsp/registryManagerDataExport.jsp b/sources/Re3gistry2/src/main/webapp/jsp/registryManagerDataExport.jsp index 66832437..117b9daa 100644 --- a/sources/Re3gistry2/src/main/webapp/jsp/registryManagerDataExport.jsp +++ b/sources/Re3gistry2/src/main/webapp/jsp/registryManagerDataExport.jsp @@ -75,6 +75,7 @@ <%@include file="includes/head.inc.jsp" %> + <%@include file="includes/header.inc.jsp"%> @@ -129,7 +130,7 @@

${localization.getString("label.solrdescription")}

<% if (SolrHandler.checkSolrCompleteIndexinglRunning()) { %> -

${localization.getString("label.solrrunning")}

+

${localization.getString("label.solrrunning")}

<% } else {%> ${localization.getString("label.solrstartindexing")}