Skip to content

Analyse impact of new guidelines on partial success responses #389

Closed

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

Activity

  1. bigludo7 commented on Jun 16, 2026

    @bigludo7
    Collaborator

    From Orange our preference is to keep existing pattern leveraging 422 and not switch to contextCode and contextMessage use.
    We think that status code is more straightforward for the developer as for the operator to understand & log API result.

  2. jlurien commented on Jul 14, 2026

    @jlurien
    CollaboratorAuthor

    Telefónica's position is also to continue with the current design and keep the 422 errors defined.

  3. jlurien commented on Jul 27, 2026

    @jlurien
    CollaboratorAuthor

    No further preferences submitted before the deadline to create RC snapshot, so we keep the current design

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Sync26In scope for Sync26 Meta-releaseenhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions