diff --git a/docs/system.md b/docs/system.md index 7ac89d44ca6299c683359c12a6cbc6ad3686e142..e423074df5e938354b04acb073a26dab3bb4d5aa 100644 --- a/docs/system.md +++ b/docs/system.md @@ -35,7 +35,7 @@ View the docker images for the documentation of the service. * Ports: 5000/tcp * Prometheus: `http://:5000/metrics` - * Swagger UI: `http://:5000/swagger-ui/index.html` [:fontawesome-solid-square-up-right: view online](/infrastructures/dbrepo/swagger/analyse) + * Swagger UI: `http://:5000/swagger-ui/index.html` <a href="/infrastructures/dbrepo/swagger/analyse" target="_blank">:fontawesome-solid-square-up-right: view online</a> It suggests data types for the FAIR Portal when creating a table from a *comma separated values* (CSV) file. It recommends enumerations for columns and returns e.g. a list of potential primary key candidates. The researcher is able @@ -147,7 +147,7 @@ regular declares and offers a management interface at port `15672`. * Info: `http://:9091/actuator/info` * Health: `http://:9091/actuator/health` * Prometheus: `http://:9091/actuator/prometheus` - * Swagger UI: `http://:9091/swagger-ui/index.html` [:fontawesome-solid-square-up-right: view online](/infrastructures/dbrepo/swagger/container) + * Swagger UI: `http://:9091/swagger-ui/index.html` <a href="/infrastructures/dbrepo/swagger/container" target="_blank">:fontawesome-solid-square-up-right: view online</a> It is responsible for Docker container lifecycle operations and updating the local copy of the Docker images. @@ -159,7 +159,7 @@ It is responsible for Docker container lifecycle operations and updating the loc * Info: `http://:9092/actuator/info` * Health: `http://:9092/actuator/health` * Prometheus: `http://:9092/actuator/prometheus` - * Swagger UI: `http://:9092/swagger-ui/index.html` [:fontawesome-solid-square-up-right: view online](/infrastructures/dbrepo/swagger/database) + * Swagger UI: `http://:9092/swagger-ui/index.html` <a href="/infrastructures/dbrepo/swagger/database" target="_blank">:fontawesome-solid-square-up-right: view online</a> It creates the databases inside a Docker container and the Query Store. Currently, we only support [MariaDB](https://mariadb.org/) images that allow table versioning with low programmatic effort. @@ -198,7 +198,7 @@ the [Spring Cloud Gateway](https://spring.io/projects/spring-cloud-gateway) to r * Info: `http://:9096/actuator/info` * Health: `http://:9096/actuator/health` * Prometheus: `http://:9096/actuator/prometheus` - * Swagger UI: `http://:9096/swagger-ui/index.html` [:fontawesome-solid-square-up-right: view online](/infrastructures/dbrepo/swagger/identifier) + * Swagger UI: `http://:9096/swagger-ui/index.html` <a href="/infrastructures/dbrepo/swagger/identifier" target="_blank">:fontawesome-solid-square-up-right: view online</a> This microservice is responsible for creating and resolving a *persistent identifier* (PID) attached to a query to obtain the metadata attached to it and allow re-execution of a query. We store both the query and hashes of the query @@ -229,7 +229,7 @@ The default credentials are `root:dbrepo` for the database `fda`. Connect to the * Info: `http://:9099/actuator/info` * Health: `http://:9099/actuator/health` * Prometheus: `http://:9099/actuator/prometheus` - * Swagger UI: `http://:9099/swagger-ui/index.html` [:fontawesome-solid-square-up-right: view online](/infrastructures/dbrepo/swagger/metadata) + * Swagger UI: `http://:9099/swagger-ui/index.html` <a href="/infrastructures/dbrepo/swagger/metadata" target="_blank">:fontawesome-solid-square-up-right: view online</a> This service provides an OAI-PMH endpoint for metadata crawler. @@ -249,7 +249,7 @@ The NGINX reverse proxy bundles the services and enables SSL/TLS communication f * Info: `http://:9093/actuator/info` * Health: `http://:9093/actuator/health` * Prometheus: `http://:9093/actuator/prometheus` - * Swagger UI: `http://:9093/swagger-ui/index.html` [:fontawesome-solid-square-up-right: view online](/infrastructures/dbrepo/swagger/query) + * Swagger UI: `http://:9093/swagger-ui/index.html` <a href="/infrastructures/dbrepo/swagger/query" target="_blank">:fontawesome-solid-square-up-right: view online</a> It provides an interface to insert data into the tables created by the Table Service. It also allows for view-only, paginated and versioned query execution to the raw data and consumes messages in the message queue from the Broker @@ -275,7 +275,7 @@ All requests need to be authenticated, by default the credentials `elastic:elast * Ports: 5010/tcp * Prometheus: `http://:5010/metrics` - * Swagger UI: `http://:5010/swagger-ui/index.html` [:fontawesome-solid-square-up-right: view online](/infrastructures/dbrepo/swagger/semantics) + * Swagger UI: `http://:5010/swagger-ui/index.html` <a href="/infrastructures/dbrepo/swagger/semantics" target="_blank">:fontawesome-solid-square-up-right: view online</a> It is designed to map terms in the domain of units of measurement to controlled vocabulary, modelled in the [ontology of units of measure](https://github.com/HajoRijgersberg/OM). This service validates researcher provided in @@ -290,7 +290,7 @@ Furthermore, there is a method for auto-completing text and listing a descriptio * Info: `http://:9094/actuator/info` * Health: `http://:9094/actuator/health` * Prometheus: `http://:9094/actuator/prometheus` - * Swagger UI: `http://:9094/swagger-ui/index.html` [:fontawesome-solid-square-up-right: view online](/infrastructures/dbrepo/swagger/table) + * Swagger UI: `http://:9094/swagger-ui/index.html` <a href="/infrastructures/dbrepo/swagger/table" target="_blank">:fontawesome-solid-square-up-right: view online</a> This microservice handles table operations inside a database that is managed by the Database Service. We use [Hibernate](https://hibernate.org/orm/) for schema and data ingest operations. @@ -318,6 +318,6 @@ It provides a *graphical user interface* (GUI) for a researcher to interact with * Info: `http://:9098/actuator/info` * Health: `http://:9098/actuator/health` * Prometheus: `http://:9098/actuator/prometheus` - * Swagger UI: `http://:9098/swagger-ui/index.html` [:fontawesome-solid-square-up-right: view online](/infrastructures/dbrepo/swagger/user) + * Swagger UI: `http://:9098/swagger-ui/index.html` <a href="/infrastructures/dbrepo/swagger/user" target="_blank">:fontawesome-solid-square-up-right: view online</a> This microservice handles user information.