Merge branch 'master' into dependabot/maven/org.yaml-snakeyaml-1.32

.github/workflows/build.yaml

@@ -12,16 +12,16 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        java: [ '8', '11', '13', '15' ]
+        java: ["11", "17", "21"]
     name: Java ${{ matrix.Java }}
     steps:
       - uses: actions/checkout@v3
       - name: Setup java
         uses: actions/setup-java@v3
         with:
-          distribution: 'adopt'
+          distribution: "adopt"
           java-version: ${{ matrix.java }}
       - name: Build with Maven
-        run: mvn -B package --file pom.xml     
+        run: mvn -B package --file pom.xml
       - name: Test with Maven
-        run: mvn -B test --file pom.xml
+        run: mvn -B test --file pom.xml

.gitignore

@@ -41,6 +41,9 @@ example.yaml
 # .idea/*.iml
 # .idea/modules
 
+# Generated files
+.vscode/settings.json
+
 # CMake
 cmake-build-*/
 

CITATION.cff

@@ -0,0 +1,25 @@
+title: "OBA: Ontology-Based APIs"
+license: Apache-2.0
+authors:
+  - family-names: Osorio
+    given-names: Maximiliano
+    orcid: "https://orcid.org/0000-0002-3611-6510"
+  - family-names: Garijo
+    given-names: Daniel
+    orcid: "https://orcid.org/0000-0003-0454-7145"
+cff-version: 1.2.0
+message: "If you use this software, please cite both the article from preferred-citation and the software itself."
+preferred-citation:
+  authors:
+    - family-names: Osorio
+      given-names: Maximiliano
+    - family-names: Garijo
+      given-names: Daniel
+  title: "OBA: An Ontology-Based Framework for Creating REST APIs for Knowledge Graphs"
+  type: article
+  year: 2021
+  doi: 10.1007/978-3-030-62466-8_4
+identifiers:
+  - description: "Collection of archived snapshots for OBA"
+    type: doi
+    value: 10.5281/zenodo.6639554

README.md

@@ -1,8 +1,8 @@
-# Ontology-Based APIs (OBA) [![Test](https://github.com/KnowledgeCaptureAndDiscovery/OBA/actions/workflows/build.yaml/badge.svg)](https://github.com/KnowledgeCaptureAndDiscovery/OBA/actions/workflows/build.yaml)
+# Ontology-Based APIs (OBA) [![Test](https://github.com/KnowledgeCaptureAndDiscovery/OBA/actions/workflows/build.yaml/badge.svg)](https://github.com/KnowledgeCaptureAndDiscovery/OBA/actions/workflows/build.yaml) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6639554.svg)](https://doi.org/10.5281/zenodo.6639554)
 
 OBA reads ontologies (OWL) and generates an OpenAPI Specification (OAS). Using this definition, OBA creates a REST API server automatically.
 
-![Diagram](docs/figures/oba.svg) 
+![Diagram](docs/figures/oba.svg)
 
 ## Quickstart
 
@@ -11,6 +11,11 @@ There are two option to run OBA:
 1. Download the binary.
 2. Build the binary from the repository.
 
+### Pre-requisites
+
+Due to recent versions of the OpenAPI generator being built with Java 11, you will need Java 11 or higher to run OBA v3.7.0. The current recommended distribution of Java 11+ JDKs (and "JREs") is at [Adoptium's releases page](https://adoptium.net/temurin/releases/?version=11).
+
+Java versions higher than 11 are also available to use. Java 11 is simply the minimum version.
 
 ### Downloading binary
 
@@ -35,3 +40,20 @@ $ java -jar oba-*-jar-with-dependencies.jar -c config.yaml
 Congratulations! You have generated an Open Api Specification.
 
 For instructions on using OBA to create your API server, go to the [documentation](https://oba.readthedocs.io/en/latest/)
+
+## Citation
+
+Please cite our work as follows:
+
+```
+@inproceedings{garijo2020OBA,
+	title        = {{OBA}: An Ontology-Based Framework for Creating REST APIs for Knowledge Graphs},
+	author       = {Garijo, Daniel and Osorio, Maximiliano},
+	booktitle={International Semantic Web Conference},
+	pages={48--64},
+	year={2020},
+    doi={https://doi.org/10.1007/978-3-030-62466-8_4},
+	organization = {Springer, Cham},
+    isbn={978-3-030-62466-8}
+}
+```