Skip to content

Endpoint names are not compliant with Commonalities r4.3 #235

Description

@eric-murray

Problem description
The two endpoints use POST because they are transferring sensitive data, not because they are creating any resource.

The Commonalities Design Guide states:

When the POST method is used:

  • the resource in the path MUST be a verb (e.g. retrieve-location and not location) to differentiate from an actual resource creation

The current paths POST /unconditional-call-forwardings and POST /call-forwardings do not include the verb retrieve to indicate that the are retrieving information only and not creating any resource

Expected behaviour
The endpoint paths need to be renamed by prefixing them with retrieve-. In addition, as POST /unconditional-call-forwardings is retrieving a boolean status value, consider appending -status.

e.g.:
POST /retrieve-unconditional-call-forwardings-status
POST /retrieve-call-forwardings

Alternative solution
None

Additional context
None

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