Merge branch 'master' into feature/query-params-search-api-#259

CHANGELOG.md

@@ -2,6 +2,24 @@
 
 <!--next-version-placeholder-->
 
+## v3.0.1 (2021-11-24)
+### Fix
+* Allow blank extensions and slash extension to be valid ([`70ddb7a`](https://github.com/ral-facilities/datagateway-api/commit/70ddb7a4fd89ba10b06cd71c3ab2a98648cfb773))
+
+## v3.0.0 (2021-11-23)
+### Feature
+* Configure end part of endpoint urls to contain api extension #283 ([`5bdd72e`](https://github.com/ral-facilities/datagateway-api/commit/5bdd72ea911323cdf0fc7d9ec6fb419b8dd6006c))
+
+### Breaking
+* modify endpoint urls to use relevant api extension  ([`5bdd72e`](https://github.com/ral-facilities/datagateway-api/commit/5bdd72ea911323cdf0fc7d9ec6fb419b8dd6006c))
+
+## v2.0.0 (2021-11-22)
+### Breaking
+* Adding breaking change to correct the version bump which didn't happen when merging #285  ([`44c48e8`](https://github.com/ral-facilities/datagateway-api/commit/44c48e8b772147bfcf395d1430e067730d66df44))
+
+### Documentation
+* Adjust versioning documentation ([`44c48e8`](https://github.com/ral-facilities/datagateway-api/commit/44c48e8b772147bfcf395d1430e067730d66df44))
+
 ## v1.1.0 (2021-11-19)
 ### Feature
 * Add unimplemented endpoint definitions for search API #257 ([`d0e52d9`](https://github.com/ral-facilities/datagateway-api/commit/d0e52d96dd3b94ce54dcc9b81969e777a196922a))

README.md

@@ -314,10 +314,7 @@ fix: fix bug found with count endpoints #issue-number
 feat: add endpoints for search API #issue-number
 
 # Commit which introduces a breaking change for users
-BREAKING CHANGE: change format of `config.json`, the previous version is no longer supported #issue-number
-
-# You can also use `BREAKING CHANGE:` in the additional information if the commit also adds a new feature, like so:
-feat: my new feature #issue-number
+<commit-type>: change format of `config.json`, the previous version is no longer supported #issue-number
 
 BREAKING CHANGE: this feature means X functionality has been removed
 ```

datagateway_api/config.json.example

@@ -1,18 +1,28 @@
 {
-  "backend": "db",
-  "client_cache_size": 5,
-  "client_pool_init_size": 2,
-  "client_pool_max_size": 5,
-  "db_url": "mysql+pymysql://icatdbuser:icatdbuserpw@localhost:3306/icatdb",
-  "flask_reloader": false,
-  "icat_url": "https://localhost:8181",
-  "icat_check_cert": false,
-  "log_level": "WARN",
-  "log_location": "/home/runner/work/datagateway-api/datagateway-api/logs.log",
-  "debug_mode": false,
-  "generate_swagger": false,
-  "host": "127.0.0.1",
-  "port": "5000",
-  "test_user_credentials": {"username": "root", "password": "pw"},
-  "test_mechanism": "simple"
+    "datagateway_api": {
+        "extension": "/datagateway-api",
+        "backend": "db",
+        "client_cache_size": 5,
+        "client_pool_init_size": 2,
+        "client_pool_max_size": 5,
+        "db_url": "mysql+pymysql://icatdbuser:icatdbuserpw@localhost:3306/icatdb",
+        "icat_url": "https://localhost:8181",
+        "icat_check_cert": false
+    },
+    "search_api": {
+        "extension": "/search-api",
+        "icat_url": "https://localhost:8181",
+        "icat_check_cert": false,
+        "client_pool_init_size": 2,
+        "client_pool_max_size": 5
+    },
+    "flask_reloader": false,
+    "log_level": "WARN",
+    "log_location": "/home/runner/work/datagateway-api/datagateway-api/logs.log",
+    "debug_mode": false,
+    "generate_swagger": false,
+    "host": "127.0.0.1",
+    "port": "5000",
+    "test_user_credentials": {"username": "root", "password": "pw"},
+    "test_mechanism": "simple"
 }