Skip to content

Commit

Permalink
docs: add note about command construction and checking
Browse files Browse the repository at this point in the history
  • Loading branch information
nigelm committed Mar 12, 2022
1 parent 16c2e75 commit 56cb717
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/internals.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,18 @@ Additionally in the example the surrounding `ServicePackAuthorization`
element may have either `unauthorized=True` or `authorized_quantity` set
to a `UnboundedPositiveInt`.

Additionally in version `2.0.1` onwards, schema `sequence` sets, within schema
`choice` elements are similarly handled - all the contained attributes are
made optional.

I can think of some ways to make the currently `xfail` flagged tests in
`test_faulty_command.py` be handled correctly - at the cost of adding more
complexity to the information stored about each command type and making the
`__init__` function more complex. However I am not fully convinced that this
library should be performing that level of input checking - although the
library will accept illegal combinations, the Broadworks server will quickly
tell you that you are wrong!.

The tables returned in many command responses have no type information in the
schema as to how to treat them - the column information is also passed within
the response itself. This means that often there are boolean or numeric
Expand Down

0 comments on commit 56cb717

Please sign in to comment.