[Release 197] manual service config api description #22
Conversation
|
|
||
| **enabled** Enable or disable the configuration. | ||
|
|
||
| Note: Either unmonitoredServiceName or existingServiceId should be specified in a configuration. |
There was a problem hiding this comment.
I think it would be nice if we could express this in the API. In swagger there is oneOf if I remember correctly, maybe there is something similar in OpenAPI.
There was a problem hiding this comment.
It looks to me that oneOf can only be applied to the request object schema, not to each parameter of the schema.
I found https://stackoverflow.com/questions/29708505/swagger-2-0-how-to-make-one-or-the-other-parameter-required and it points to this open issue OAI/OpenAPI-Specification#256 which could eventually address this use case
|
|
||
| **This is an experimental endpoint to workaround service mapping issues.** | ||
|
|
||
| ### Mandatory Parameters: |
There was a problem hiding this comment.
rule id is specified in the query parameter.
I just realise that maybe these "Mandatory Parameters" or "Optional Parameters" are intended to specify the query parameters, not the fields in the query payload objects... Although we used it for describing QB2 tagFilterExpression field as well
Add API description for manual service config API endpoints