Skip to content

Fix Population Density Data API description #142

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

Closed
Anushkakulkarni1 wants to merge 2 commits into from
+3 −3
Closed

Fix Population Density Data API description #142

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
438b4f0
Fix Population Density Data API description
Anushkakulkarni1 Aug 11, 2026
8245e97
Fix remaining API documentation typos
Anushkakulkarni1 Aug 11, 2026
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
6 changes: 3 additions & 3 deletions code/API_definitions/population-density-data.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
openapi: 3.0.3

Check notice on line 1 in code/API_definitions/population-density-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

externalDocs.description must match the DG template 

[P-039] externalDocs.description in code/API_definitions/population-density-data.yaml is 'Product documentation at CAMARA.' — expected 'Product documentation at CAMARA' | Suggestion: Set externalDocs.description to exactly "Product documentation at CAMARA".

Check warning on line 1 in code/API_definitions/population-density-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

CloudEvent type format is wrong 

[P-015] No event type enum values found in code/API_definitions/population-density-data.yaml — subscription APIs should define EventType schemas | Suggestion: Define a named event type schema (e.g. ApiEventType) that constrains the CloudEvent `type` value via allOf, rather than inlining the enum directly in CloudEvent.properties.type.enum. See the implicit-events API template in Commonalities artifacts/api-templates/ (tracked in camaraproject/Commonalities#608).
info:
title: Population Density Data
description: |
Expand Down Expand Up @@ -102,7 +102,7 @@
The standard behaviour of the API is synchronous, although for large
area requests the API may behave asynchronously. An API invoker can enforce
asynchronous behaviour by providing a callback URL (`sink`)
is in the request, in this case the API sends a callback
in the request. In this case, the API sends a callback
to the callback URL provided with the result of the request. If `sink` is
included, it is RECOMMENDED for the client to provide as well the `sinkCredential`
property to protect the notification endpoint. In the current version,`sinkCredential.credentialType`
Expand Down Expand Up @@ -142,8 +142,8 @@
In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
<!-- CAMARA:MANDATORY:authorization-and-authentication:END -->

Population Density Data API ensures the usage of anonymized information and do not treat personal data neither as input nor output.
Therefore, the access to Population Density Data API is defined as Client Credentials - 2-legged. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the latest detailed specification of this authentication/authorization flow.
Population Density Data API ensures the usage of anonymized information and does not treat personal data as either input or output.
Therefore, the access to Population Density Data API is defined as Client Credentials - 2-legged. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the latest detailed specification of this authentication/authorization flow.

<!-- CAMARA:MANDATORY:additional-error-responses:BEGIN -->
# Additional CAMARA error responses
Expand Down Expand Up @@ -177,7 +177,7 @@
variables:
apiRoot:
default: http://localhost:9091
description: API root

Check notice on line 180 in code/API_definitions/population-density-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

apiRoot description should match standard text 

[S-023] apiRoot description does not match the standard CAMARA text.
tags:
- name: Population Density Data
description: Operations to retrieve population density information.
Expand Down Expand Up @@ -233,7 +233,7 @@
- $ref: "../common/CAMARA_common.yaml#/components/parameters/x-correlator"
requestBody:
description: Population density data result.
content:

Check warning on line 236 in code/API_definitions/population-density-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Notification must use application/cloudevents+json 

[S-035] Notification callback content type must include 'application/cloudevents+json', found: application/json
application/json:
schema:
$ref: '#/components/schemas/PopulationDensityAsyncResponse'
Expand Down Expand Up @@ -430,7 +430,7 @@
maxItems: 168
status:
$ref: '#/components/schemas/ResponseStatus'
statusInfo:

Check notice on line 433 in code/API_definitions/population-density-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 512
description: Information about the status, mandatory when property `status` is `OPERATION_NOT_COMPLETED` for adding extra information about the error.
Expand All @@ -456,7 +456,7 @@
$ref: '#/components/schemas/OperationId'
required:
- operationId
OperationId:

Check notice on line 459 in code/API_definitions/population-density-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 256
description: The unique identifier of the asynchronous operation that is returned when the operation is initiated.
Expand All @@ -475,7 +475,7 @@
- PART_OF_AREA_NOT_SUPPORTED
- AREA_NOT_SUPPORTED
- OPERATION_NOT_COMPLETED
TimedPopulationDensityData:

Check warning on line 478 in code/API_definitions/population-density-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description 

[S-011] Property description is missing or empty: "TimedPopulationDensityData.description" property must be truthy

Check warning on line 478 in code/API_definitions/population-density-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Array items must have a description 

[S-031] Array items must have a description
type: object
properties:
startTime:
Expand Down Expand Up @@ -519,7 +519,7 @@
properties:
geohash:
$ref: '#/components/schemas/Geohash'
dataType:

Check warning on line 522 in code/API_definitions/population-density-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description 

[S-011] Property description is missing or empty: "dataType.description" property must be truthy
type: string
enum:
- NO_DATA
Expand All @@ -534,13 +534,13 @@
NO_DATA: '#/components/schemas/NoData'
LOW_DENSITY: '#/components/schemas/LowDensity'
DENSITY_ESTIMATION: '#/components/schemas/DensityEstimation'
NoData:

Check warning on line 537 in code/API_definitions/population-density-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description 

[S-011] Property description is missing or empty: "NoData.description" property must be truthy
allOf:
- $ref: '#/components/schemas/CellPopulationDensityData'
LowDensity:

Check warning on line 540 in code/API_definitions/population-density-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description 

[S-011] Property description is missing or empty: "LowDensity.description" property must be truthy
allOf:
- $ref: '#/components/schemas/CellPopulationDensityData'
DensityEstimation:

Check warning on line 543 in code/API_definitions/population-density-data.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description 

[S-011] Property description is missing or empty: "DensityEstimation.description" property must be truthy
allOf:
- $ref: '#/components/schemas/CellPopulationDensityData'
- type: object
Expand Down