Skip to content

The registrationId field in the regSessionResponse schema required. #81

Open
@teikuran

Description

@teikuran

Problem description
In WebRTC Registration Service API, the registrationId field in the regSessionResponse schema for 200 (OK) response is not currently marked as required. However, this field is essential in the operations after successful registration e.g., de-registration using DELETE method.

regSessionResponse:
  type: object
  properties:
    regInfo:
      $ref: '#/components/schemas/RegistrationInformation'
    registrationId:
      type: string
      description: The registration session ID is returned when registering a device with the network . Clients must utilize this ID to as a parameter in the call-handling and subscription APIs.

Furthermore, the regSessionResponse is the only schema where the client is expected to obtain the registrationId.

Expected behavior

When the POST /sessions endpoint returns a 200 OK response, the payload shall always include the registrationId.

Alternative solution

The registrationId field in the regSessionResponse schema should be explicitly declared as required.

regSessionResponse:
  type: object
  required:
    - registrationId
  properties:
    regInfo:
      $ref: '#/components/schemas/RegistrationInformation'
    registrationId:
      type: string
      description: The registration session ID is returned when registering a device with the network . Clients must utilize this ID to as a parameter in the call-handling and subscription APIs.

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