team-telnyx / telnyx-mock

telnyx-mock is a mock HTTP server that responds like the real Telnyx API. It can be used to make test suites integrating with Telnyx faster and less brittle.
MIT License
15 stars 5 forks source link

Breaking change in OpenAPI Spec #28

Open jdzero opened 2 years ago

jdzero commented 2 years ago

In a commit from October, "minItems" is leveraged in the OpenAPI spec:

https://github.com/team-telnyx/openapi/commit/78a5880807890dff9b4fe0f6a49f5ceda03681c6#diff-eb42f9b1394184cdc66c6edf3cdba135114b3279ee6ea981fe7b5eb7fd6e50b4R12717

This part of spec is not supported by the mock server. From this commit onward, the mock server will report the following when it loads because it always grabs latest from repo:

telnyx_1         | telnyx-mock 0.8.14
telnyx_1         | Downloading API spec file from: https://raw.githubusercontent.com/team-telnyx/openapi/master/openapi/spec3.json
telnyx_1         | error decoding spec: unsupported field in JSON schema: 'minItems'

Short-term solution is to back-pin mock server by providing a -spec flag to the (container) command to commit prior to minItems, e.g. using compose:

command: -spec https://raw.githubusercontent.com/team-telnyx/openapi/b5e85e48450312e2af5aba4363fca1bcdf5d4d7e/openapi/spec3.json