Problem description
There are a number of issues with the current API documentation:
- The "Quick Start" section refers to the schema names (CreateCallForwardingSignal, UnconditionalCallForwardingSignal and CallForwardingSignal) but the API consumer should not need to refer to the individual schema. Instead, document the key parameters that the API consumer has to provide, and the key parameters they can expect in response.
- The API documents a possible error response code of
404 NOT_FOUND with no obvious conditions that would result in such an error code from an implementation. Either document how it can be triggered, or delete it from the API definition.
- For the POST /call-forwardings response, it is implied but not documented that "inactive" is mutually exclusive with the other possible response values.
- A blank line following any SGML style comment will improve rendering in the Swagger-UI
Expected action
Review and update documentation
Additional context
None
Problem description
There are a number of issues with the current API documentation:
404 NOT_FOUNDwith no obvious conditions that would result in such an error code from an implementation. Either document how it can be triggered, or delete it from the API definition.Expected action
Review and update documentation
Additional context
None