Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update population-density-data.yaml #64

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update population-density-data.yaml #64

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4385d9e
Update population-density-data.yaml
jgarciahospital Dec 23, 2024
d162380
Update population-density-data.yaml
jgarciahospital Dec 23, 2024
ee3c74b
Update population-density-data.yaml
jgarciahospital Jan 7, 2025
bf4daec
Update code/API_definitions/population-density-data.yaml
jgarciahospital Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 110 additions & 9 deletions code/API_definitions/population-density-data.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,14 +188,14 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/PopulationDensityResponse'
$ref: '#/components/schemas/PopulationDensityAsyncResponse'
examples:
PopulationDensitySupportedAreaResponseExample:
$ref: '#/components/examples/PopulationDensitySupportedAreaResponseExample'
PopulationDensityAreaNotSupportedResponseExample:
$ref: '#/components/examples/PopulationDensityAreaNotSupportedResponseExample'
PopulationDensityPartOfAreaNotSupportedResponseExample:
$ref: '#/components/examples/PopulationDensityPartOfAreaNotSupportedResponseExample'
PopulationDensitySupportedAreaAsyncResponseExample:
$ref: '#/components/examples/PopulationDensitySupportedAreaAsyncResponseExample'
PopulationDensityAreaNotSupportedAsyncResponseExample:
$ref: '#/components/examples/PopulationDensityAreaNotSupportedAsyncResponseExample'
PopulationDensityPartOfAreaNotSupportedAsyncResponseExample:
$ref: '#/components/examples/PopulationDensityPartOfAreaNotSupportedAsyncResponseExample'
responses:
'204':
description: Successful notification
Expand Down Expand Up @@ -240,6 +240,10 @@ paths:
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
$ref: '#/components/schemas/AcceptedAsyncResponse'
'400':
$ref: '#/components/responses/RetrieveLocationBadRequest400'
'401':
Expand Down Expand Up @@ -494,6 +498,25 @@ components:
required:
- timedPopulationDensityData
- status
AcceptedAsyncResponse:
type: object
properties:
operationId:
$ref: '#/components/schemas/OperationId'
required:
- operationId
PopulationDensityAsyncResponse:
allOf:
- $ref: '#/components/schemas/PopulationDensityResponse'
- type: object
properties:
operationId:
$ref: '#/components/schemas/OperationId'
required:
- operationId
OperationId:
type: string
description: The unique identifier of the asynchronous operation that is returned when the operation is initiated.
ResponseStatus:
type: string
description: >-
Expand Down Expand Up @@ -540,8 +563,8 @@ components:
CellPopulationDensityData:
type: object
description: >-
Population density data of a cell in a concrete time range. In case of
insufficient data, to guarantee an anonymized prediction due to the
Population density data of a cell in a concrete time range. In case of
insufficient data, to guarantee an anonymized prediction due to the
k-anonymity within a specific cell and time range, no population density
data is returned and the property `dataType` value is "LOW_DENSITY". In
case of a cell not supported `dataType` value is "NO_DATA"
Expand Down Expand Up @@ -860,3 +883,81 @@ components:
value:
status: AREA_NOT_SUPPORTED
timedPopulationDensityData: []
PopulationDensitySupportedAreaAsyncResponseExample:
value:
status: SUPPORTED_AREA
timedPopulationDensityData:
- startTime: '2024-01-03T10:00:00Z'
endTime: '2024-01-03T11:00:00Z'
cellPopulationDensityData:
- geohash: ezdqemf
dataType: DENSITY_ESTIMATION
maxPplDensity: 150
minPplDensity: 30
pplDensity: 60
- geohash: ezdqemg
dataType: DENSITY_ESTIMATION
maxPplDensity: 100
minPplDensity: 40
pplDensity: 90
- geohash: ezdqemu
dataType: LOW_DENSITY
- startTime: '2024-01-03T11:00:00Z'
endTime: '2024-01-03T12:00:00Z'
cellPopulationDensityData:
- geohash: ezdqemf
dataType: DENSITY_ESTIMATION
maxPplDensity: 100
minPplDensity: 30
pplDensity: 70
- geohash: ezdqemg
dataType: DENSITY_ESTIMATION
maxPplDensity: 200
minPplDensity: 40
pplDensity: 100
- geohash: ezdqemu
dataType: DENSITY_ESTIMATION
maxPplDensity: 200
minPplDensity: 40
pplDensity: 100
operationId: 2322f362-eaab-4cf3-86d2-efcbdf3a7cb4
PopulationDensityPartOfAreaNotSupportedAsyncResponseExample:
value:
status: PART_OF_AREA_NOT_SUPPORTED
timedPopulationDensityData:
- startTime: '2024-01-03T10:00:00Z'
endTime: '2024-01-03T11:00:00Z'
cellPopulationDensityData:
- geohash: ezdqemf
dataType: DENSITY_ESTIMATION
maxPplDensity: 150
minPplDensity: 30
pplDensity: 60
- geohash: ezdqemg
dataType: DENSITY_ESTIMATION
maxPplDensity: 100
minPplDensity: 40
pplDensity: 90
- geohash: ezdqemu
dataType: NO_DATA
- startTime: '2024-01-03T11:00:00Z'
endTime: '2024-01-03T12:00:00Z'
cellPopulationDensityData:
- geohash: ezdqemf
dataType: DENSITY_ESTIMATION
maxPplDensity: 100
minPplDensity: 30
pplDensity: 70
- geohash: ezdqemg
dataType: DENSITY_ESTIMATION
maxPplDensity: 200
minPplDensity: 40
pplDensity: 100
- geohash: ezdqemu
dataType: NO_DATA
operationId: 2322f362-eaab-4cf3-86d2-efcbdf3a7cb4
PopulationDensityAreaNotSupportedAsyncResponseExample:
value:
status: AREA_NOT_SUPPORTED
timedPopulationDensityData: []
operationId: 2322f362-eaab-4cf3-86d2-efcbdf3a7cb4
Loading