Skip to content

Clarify Status and StatusInfo usage next to error behaviour #86

Closed

Description

@tanjadegroot

Problem description
the API defines status and statusInfo properties inside the response data in addition to error codes. They look a lot like error status codes which can be confusing.
If the term "status" tries to characterize / express some info about the reponse data (the result), maybe a renaming "ResponseStatus" to "ResponseQualityInfo" or "DataQualityInfo" could clarify.

Possible evolution
Clarify the usage of status and statusInfo properties.

Alternative approach
Update the description field from "Represents the state of the response ..." to "Provides additional information about the quality of the included response data ...".

Additional context
A similar remark could be made on the Population Density Data API which uses the same construct.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions