Updated CHANGELOG

ezrasingh · Aug 8, 2024 · 3e26310 · 3e26310
1 parent 745b604
commit 3e26310
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 2 deletions.
diff --git a/geoprox-server/CHANGELOG.md b/geoprox-server/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added missing OpenAPI `Path` parameter descriptions
 - Improved error handling and responses
 - Implemented Batch API for insertion, removal and query
+- Added `api::doc::openapi_spec_json()` for accesing the OpenAPI specification programmatically
 
 ## 0.3.1
 

diff --git a/geoprox-server/src/api.rs b/geoprox-server/src/api.rs
@@ -110,7 +110,7 @@ pub mod docs {
             .merge(SwaggerUi::new("/swagger-ui").url("/api-spec/openapi.json", ApiDoc::openapi()))
     }
 
-    pub fn openapi_spec(pretty_print: bool) -> Result<String, serde_json::Error> {
+    pub fn openapi_spec_json(pretty_print: bool) -> Result<String, serde_json::Error> {
         if pretty_print {
             ApiDoc::openapi().to_pretty_json()
         } else {

diff --git a/geoprox/CHANGELOG.md b/geoprox/CHANGELOG.md
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+- Added supoort for generating OpenAPI spec from CLI ([#3](https://github.com/ezrasingh/geoprox/issues/3))
+
 ## 0.3.1
 
 - Bumped `geoprox-core` to [v0.3.1](https://crates.io/crates/geoprox-core/0.3.1).

diff --git a/geoprox/src/main.rs b/geoprox/src/main.rs
@@ -47,7 +47,7 @@ fn main() {
             stdout,
             pretty,
         }) => {
-            let spec_json = geoprox_server::api::docs::openapi_spec(*pretty).unwrap();
+            let spec_json = geoprox_server::api::docs::openapi_spec_json(*pretty).unwrap();
             if *stdout {
                 // ? print the spec JSON to stdout, if `stdout` is `true` or `Some(true)`,
                 println!("{}", spec_json);