Skip to content

Analyse impact of new guidelines on partial success responses #389

@jlurien

Description

@jlurien

Problem description
Commonalities has updated section 3 of CAMARA-API-Design-Guide.md, with new guidelines fo the format of success responses when the result is negative, partial, or unknown

Device Location APIs already had cases when the result is unknown or partial, and they return 422 errors in such situations.

Possible evolution

Analyse the guidelines and decide whether we should update any of the current APIs responses

Alternative solution

Keep the current behaviour

Additional context

Take into consideration the Versioning and Migration Guidance:

  • New APIs and new MAJOR versions SHOULD follow this guidance.
  • Existing stable APIs MAY adopt it in a future MAJOR version where behavior or response semantics would otherwise change.
  • Where possible, APIs MAY introduce contextCode and contextMessage as additive, backward-compatible changes.

Also Business-Level Outcome 2xx vs 4xx scenarios guidance

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