Merge pull request #33 from camaraproject/jgarciahospital-patch-1

Create 0.1.0 branch

Author: jgarciahospital

CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog PopulationDensityData
+
+## Table of Contents
+
+- [v0.1.0](#v010)
+
+**Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.**
+
+# v0.1.0
+
+**This is the first alpha version of the Population Density Data API.** 
+
+- API [definition](https://github.com/camaraproject/PopulationDensityData/tree/release-v0.1.0/code/API_definitions)
+- API [documentation](https://github.com/camaraproject/PopulationDensityData/tree/release-v0.1.0/documentation/API_documentation)
+
+## Please note:
+
+- This is an **initial version**.
+- There are bug fixes to be expected and incompatible changes in upcoming versions. 
+
+## What's changed
+
+* New API `Population Density Data`, v0.1.0, with a single operation for retrieving population density information in the specified area:
+    - Given a specific area as a polygon shape, a precision level and a time interval in which the service provider wants to obtain the population density, the API will return the data set of time ranges and equal sized cells containing the estimated population densitity of each time slot and cell.

README.md

@@ -30,11 +30,11 @@ Repository to describe, develop, document and test the Population Density Data A
 ## Status and released versions
 
 * Note: Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
-* **This API is under Work In Progress, no Alpha or stable releases are available by this time** 
-- WIP API definition **with inline documentation**:
-  - OpenAPI [YAML spec file](https://github.com/camaraproject/PopulationDensityData/blob/main/code/API_definitions/population-density-data.yaml)
-  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/main/code/API_definitions/population-density-data.yaml&nocors)
-  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/main/code/API_definitions/population-density-data.yaml)
+* Release 0.1.0 of the API family is available within the [release-v0.1.0](https://github.com/camaraproject/PopulationDensityData/tree/release-v0.1.0) branch.
+- 0.1.0 Population Density Data API definition **with inline documentation**:
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/PopulationDensityData/blob/release-v0.1.0/code/API_definitions/population-density-data.yaml)
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/release-v0.1.0/code/API_definitions/population-density-data.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/release-v0.1.0/code/API_definitions/population-density-data.yaml)
 
 ## Contributorship and mailing list
 * To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit <https://lists.camaraproject.org/g/sp-pdd>.

code/API_definitions/population-density-data.yaml

@@ -116,12 +116,12 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: 0.1.0-rc2
+  version: 0.1.0
 externalDocs:
   description: Product documentation at Camara.
   url: https://github.com/camaraproject/
 servers:
-  - url: '{apiRoot}/population-density-data/v0'
+  - url: '{apiRoot}/population-density-data/v0.1'
     variables:
       apiRoot:
         default: http://localhost:9091