Finish rename to MassBank-export-api

meier-rene · meier-rene · commit 8e8e6eb6d23f · 2025-05-07T11:06:04.000+02:00
diff --git a/.github/workflows/create-docker.yml b/.github/workflows/create-docker.yml
@@ -37,7 +37,7 @@ jobs:
         id: meta
         uses: docker/metadata-action@v5
         with:
-          images: quay.io/massbank/massbank3-export-service
+          images: quay.io/massbank/massbank-export-api
           tags: |
             # tag event
             type=ref,event=tag
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
 FROM eclipse-temurin:21
-ARG JAR_FILE=target/massbank3-export-service-*.jar
+ARG JAR_FILE=target/massbank-export-api-*.jar
 COPY ${JAR_FILE} app.jar
 ENTRYPOINT ["java","-jar","/app.jar"]
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# MassBank3-export-service
+# MassBank-export-api
 A REST interface to export MassBank records to other formats.
 
 This server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project and uses 
@@ -17,7 +17,7 @@ release. This directory needs to be configured in the environment variable
 `MB_DATA_DIRECTORY`.
 ```bash
 git clone https://github.com/MassBank/MassBank-data.git
-export MB_DATA_DIRECTORY="./MassBank-datagi"
+export MB_DATA_DIRECTORY="./MassBank-data"
 ```
 To configure CORS you can set the environment variable `CORS_ALLOWED_ORIGINS`.
 ```bash
@@ -41,14 +41,14 @@ in the ingress-nginx-controller ConfigMap.
 Build the service with Maven:
 ```mvn package```
 Run the service:
-```java -jar target/massbank3-export-service-*.jar```
+```java -jar target/massbank-export-api-*.jar```
 
 ## Run with Docker
 To run the server in a Docker container,  execute the following commands:
 
 ```bash
 # Build the image
-docker build -t massbank3-export-service .
+docker build -t massbank-export-api .
 
 # Clone the MassBank data repository
 git clone https://github.com/MassBank/MassBank-data.git
@@ -57,11 +57,11 @@ git clone https://github.com/MassBank/MassBank-data.git
 docker run -p 8080:8080 \
 -v $(pwd)/MassBank-data:/MassBank-data \
 -e MB_DATA_DIRECTORY='/MassBank-data' \
-massbank3-export-service
+massbank-export-api
 ```
 
 Prebuilt Docker images are available from 
-[quay.io/massbank/massbank3-export-service](https://quay.io/repository/massbank/massbank3-export-service).
+[quay.io/massbank/massbank-export-api](https://quay.io/repository/massbank/massbank-export-api).
 The fastest way to get things running is:
 ```bash
 # Clone the MassBank data repository
@@ -71,7 +71,7 @@ git clone https://github.com/MassBank/MassBank-data.git
 docker run -p 8080:8080 \
 -v $(pwd)/MassBank-data:/MassBank-data \
 -e MB_DATA_DIRECTORY='/MassBank-data' \
-quay.io/massbank/massbank3-export-service:latest
+quay.io/massbank/massbank-export-api:latest
 ```
 
-For a description of the service browse to the [Swagger UI](http://localhost:8080/swagger-ui/index.html).
+For a description of the api browse to the [Swagger UI](http://localhost:8080/swagger-ui/index.html).
diff --git a/pom.xml b/pom.xml
@@ -9,10 +9,10 @@
         <relativePath/> <!-- lookup parent from repository -->
     </parent>
     <groupId>de.ipb-halle</groupId>
-    <artifactId>massbank3-export-service</artifactId>
+    <artifactId>massbank-export-api</artifactId>
     <version>v1.7-SNAPSHOT</version>
-    <name>massbank3-export-service</name>
-    <description>Microservice for the export of different file formats for MassBank 3</description>
+    <name>massbank-export-api</name>
+    <description>Microservice for the export of different file formats for MassBank</description>
 
     <properties>
         <java.version>21</java.version>
@@ -151,8 +151,8 @@
                         <configuration>
                             <inputSpec>${project.basedir}/src/main/resources/openapi.yaml</inputSpec>
                             <generatorName>spring</generatorName>
-                            <apiPackage>de.ipb-halle.massbank3-export-service.api</apiPackage>
-                            <modelPackage>de.ipb-halle.massbank3-export-service.model</modelPackage>
+                            <apiPackage>de.ipb-halle.massbank-export-api.api</apiPackage>
+                            <modelPackage>de.ipb-halle.massbank-export-api.model</modelPackage>
                             <configOptions>
                                 <useSpringBoot3>true</useSpringBoot3>
                                 <delegatePattern>true</delegatePattern>
diff --git a/src/main/java/de/ipb_halle/massbank_export_api/api/ConvertApiDelegateImpl.java b/src/main/java/de/ipb_halle/massbank_export_api/api/ConvertApiDelegateImpl.java
@@ -1,7 +1,7 @@
-package de.ipb_halle.massbank3_export_service.api;
+package de.ipb_halle.massbank_export_api.api;
 
 
-import de.ipb_halle.massbank3_export_service.model.Conversion;
+import de.ipb_halle.massbank_export_api.model.Conversion;
 import massbank.export.RecordToNIST_MSP;
 import massbank.export.RecordToRIKEN_MSP;
 import massbank.Record;
@@ -14,7 +14,7 @@
 import java.util.Objects;
 import java.util.stream.Collectors;
 
-import static de.ipb_halle.massbank3_export_service.api.DataReader.*;
+import static de.ipb_halle.massbank_export_api.api.DataReader.*;
 
 
 @Service
diff --git a/src/main/java/de/ipb_halle/massbank_export_api/api/DataReader.java b/src/main/java/de/ipb_halle/massbank_export_api/api/DataReader.java
@@ -1,4 +1,4 @@
-package de.ipb_halle.massbank3_export_service.api;
+package de.ipb_halle.massbank_export_api.api;
 
 import massbank.Record;
 import massbank.RecordParser;
diff --git a/src/main/java/de/ipb_halle/massbank_export_api/api/MetadataApiDelegateImpl.java b/src/main/java/de/ipb_halle/massbank_export_api/api/MetadataApiDelegateImpl.java
@@ -1,4 +1,4 @@
-package de.ipb_halle.massbank3_export_service.api;
+package de.ipb_halle.massbank_export_api.api;
 
 
 import com.google.gson.Gson;
@@ -11,7 +11,7 @@
 
 import java.util.List;
 
-import static de.ipb_halle.massbank3_export_service.api.DataReader.*;
+import static de.ipb_halle.massbank_export_api.api.DataReader.*;
 
 
 @Service
diff --git a/src/main/java/de/ipb_halle/massbank_export_api/api/VersionApiDelegateImpl.java b/src/main/java/de/ipb_halle/massbank_export_api/api/VersionApiDelegateImpl.java
@@ -1,4 +1,4 @@
-package de.ipb_halle.massbank3_export_service.api;
+package de.ipb_halle.massbank_export_api.api;
 
 
 import com.google.gson.Gson;
@@ -19,7 +19,7 @@ public class VersionApiDelegateImpl implements VersionApiDelegate {
     @Override
     public ResponseEntity<String> versionGet() {
         Gson gson = new Gson();
-        String versionInfo = String.format("export service %s, %s", artifactVersion, timestamp);
+        String versionInfo = String.format("export api %s, %s", artifactVersion, timestamp);
         return new ResponseEntity<>(gson.toJson(versionInfo), HttpStatus.OK);
     }
 
diff --git a/src/main/java/de/ipb_halle/massbank_export_api/api/WebConfig.java b/src/main/java/de/ipb_halle/massbank_export_api/api/WebConfig.java
@@ -1,4 +1,4 @@
-package de.ipb_halle.massbank3_export_service.api;
+package de.ipb_halle.massbank_export_api.api;
 
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
@@ -1,4 +1,4 @@
-spring.application.name=massbank3-export-service
+spring.application.name=massbank-export-api
 server.port = 8080
 logging.level.massbank.RecordParserDefinition=ERROR
 artifact.version=@project.version@
diff --git a/src/main/resources/openapi.yaml b/src/main/resources/openapi.yaml
@@ -18,7 +18,7 @@ paths:
             application/json:
               schema:
                 type: string
-                example: export service 0.1
+                example: export api 0.1
   /convert:
     post:
       summary: Create a conversion task.
diff --git a/src/test/java/ExportApiControllerTest.java b/src/test/java/ExportApiControllerTest.java
@@ -10,7 +10,7 @@
 
 @SpringBootTest(classes = org.openapitools.OpenApiGeneratorApplication.class)
 @AutoConfigureMockMvc
-public class ExportServiceControllerTest {
+public class ExportApiControllerTest {
 
     @Autowired
     private MockMvc mockMvc;
@@ -20,7 +20,7 @@ public void testGetVersion() throws Exception {
         mockMvc.perform(get("/version"))
             .andExpect(status().isOk())
             .andExpect(content().contentType("application/json"))
-            .andExpect(jsonPath("$").value(startsWith("export service ")));
+            .andExpect(jsonPath("$").value(startsWith("export api ")));
     }
 
     @Test
diff --git a/src/test/resources/application.properties b/src/test/resources/application.properties
@@ -1,4 +1,4 @@
-spring.application.name=massbank3-export-service
+spring.application.name=massbank-export-api
 server.port = 8080
 logging.level.massbank.RecordParserDefinition=ERROR
 artifact.version=@project.version@

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package de.ipb_halle.massbank3_export_service.api;`
	`1`	`+package de.ipb_halle.massbank_export_api.api;`
`2`	`2`
`3`	`3`	`import massbank.Record;`
`4`	`4`	`import massbank.RecordParser;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-spring.application.name=massbank3-export-service`
	`1`	`+spring.application.name=massbank-export-api`
`2`	`2`	`server.port = 8080`
`3`	`3`	`logging.level.massbank.RecordParserDefinition=ERROR`
`4`	`4`	`artifact.version=@project.version@`