Skip to content

Corrections in info.description and response field semantics #33

Open

Description

@hdamker

Problem description

Smaller corrections in device-authenticity.yaml:

  • info.title is DeviceAuthenticity; other APIs use a plain-text title, e.g. Device Identifier.
  • x-camara-commonalities: 0.9 is not the full version string required by Design Guide section 5.3.7; Commonalities r4.4 is 0.9.0.
  • The tag IMEI Fraud Check still uses the name of the API proposal.
  • Relevant terms and definitions defines "Register Status" and "Device Status", while the response uses operationalStatus.
  • Heading structure: ## Error handling now follows # Request body strictness, and # Further info and support contains only the authorization template with its own # heading.
  • lastChecked is optional, but it is not defined when it is absent; its description refers to a "fraud check service".
  • reportedDate "may be present" for negative statuses, while the test definitions require it to be absent for allowed and unknown. The spec should state the rule.
  • The example IMEIs 490154203237519 to 490154203237525 have an invalid check digit (3GPP TS 23.003); only 490154203237518 and 490154203237526 are valid. It is also not stated whether an invalid check digit results in 400 INVALID_ARGUMENT.
  • RequestBody has no composition, but does not declare additionalProperties: false (Design Guide section 3.2.4).

Expected behavior

Correct the points above. Error responses are covered in #29, references to common definitions in #30.

Additional context

To be resolved before the next release after r1.1.

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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions