Apply release r2.2 review findings from #83

[albertoramosmonagas]

What type of PR is this?

Add one of the following kinds:

• cleanup
• documentation

What this PR does / why we need it:

• API inline documentation can be tightened up #84: Restructures the info.description field with shorter point-based information and additional terminology definitions, aligning with the Population Density Data API format.
• API redefines CAMARA common datatypes without renaming #85: Renames local schema definitions (Area → GeoArea, AreaType → GeoAreaType, Polygon → GeoPolygon) to avoid clashing with CAMARA common datatypes.
• Clarify Status and StatusInfo usage next to error behaviour #86: Renames ResponseStatus to DataQualityInfo and clarifies status/statusInfo descriptions to distinguish data quality information from error responses.

Special notes for the review:

• Remove "IoT deployment planning" use case that was not in the original spec nor requested by the issue
• Specify polygon constraint as "minimum of 3 and maximum of 15 points" matching the schema and PDD,
• Remove duplicate GC/MC/NC/ND list and "Callback URL and token" definition across sections,
• Replace non-ASCII characters (×, —, –) with ASCII equivalents,
• Rename DataQualityInfo to ResponseQualityInfo, as the response may carry values that are not data per se, such as OPERATION_NOT_COMPLETED,
• Clarify "not an HTTP error indicator" instead of "not an error indicator", since OPERATION_NOT_COMPLETED is indeed an error, just not an HTTP one

Which issue(s) this PR fixes:

Fixes #84, #85, #86 (from #83 release issue)

Changelog input

 release-note
Restructure API inline documentation (#84), rename local schemas to avoid CAMARA common clashes (#85), and rename ResponseStatus to DataQualityInfo to clarify data quality vs error semantics (#86)

[camara-validation]

CAMARA Validation — PASS (with warnings)

0 errors, 2 warnings, 1 hints | Profile: standard

View full results

[albertoramosmonagas]

Ready for review @eric-murray