You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
swagger: '2.0'[...]post:
tags:
- _(deprecated) Triggers and Actions - V0 (use Triggers and Actions - V1 insteadsummary: Create an ActionPolicydescription: 'The field `id` must not be provided, it will be automatically generated by the service as an UUID.<br><br>Usage of this API will be reported in your access log under ''routing'' category.<br><br>Restricted to API keys with at least one of the following roles : DATA_PROCESSING_W.'operationId: createUsingPOST_1consumes:
- application/jsonproduces:
- application/jsonparameters:
- in: bodyname: actionPolicydescription: ActionPolicy to addrequired: trueschema:
$ref: '#/definitions/ActionPolicyV0'x-examples:
default: |- { "name": "name-aea80c1d-5777-4e20-822c-5e6871f428e5", "enabled": true, "triggers": { "eventRuleIds": ["64e97cd3-9f49-43d9-84cf-7c4a806e3189"] }, "actions": { "emails": [{ "to": ["[email protected]"], "cc": ["[email protected]"], "cci": ["[email protected]"], "subjectTemplate": "State change for {{stateKey}}", "contentTemplate": "{{stateKey}} change from state {{previousState}} to state {{newState}} at {{timestamp}}" }], "sms": [{ "destinationPhoneNumbers": ["+33601234567"], "contentTemplate": "{{stateKey}} new state {{newState}} at {{timestamp}}" }] } }responses:
'200':
description: ActionPolicy createdschema:
$ref: '#/definitions/ActionPolicyV0'security:
- X-API-KEY:
- globaldeprecated: true[...]
Is your feature request related to a problem?
We have recently moved from swagger-ui 2.X.X to swagger-ui 3.X.X
In swagger-ui 2.x.x, "x-examples" are interpreted :
In swagger-ui 3.x.x, "x-examples" are ignored :
Describe the solution you'd like
The same behaviour as swagger-ui 2.X.X would be perfect
Describe alternatives you've considered
We know that "x-examples" is a vendor extension, and not a part of the swagger V2 specification. In fact, nothing seems to exist for body request examples.
The migration to OpenAPI v3 will be a good answer, but requires much more work on our side (annotation migration, springfox to springdoc migration, etc.).
Thankyou for any response
The text was updated successfully, but these errors were encountered:
Clem69B
changed the title
Support for "x-examples" for "body" type parameters (like sagger-ui v2.x.x)
Support of "x-examples" for "body" type parameters (like sagger-ui v2.x.x)
Mar 24, 2021
Content & configuration
Swagger/OpenAPI definition:
Is your feature request related to a problem?
We have recently moved from swagger-ui 2.X.X to swagger-ui 3.X.X

In swagger-ui 2.x.x, "x-examples" are interpreted :
In swagger-ui 3.x.x, "x-examples" are ignored :

Describe the solution you'd like
The same behaviour as swagger-ui 2.X.X would be perfect
Describe alternatives you've considered
We know that "x-examples" is a vendor extension, and not a part of the swagger V2 specification. In fact, nothing seems to exist for body request examples.
The migration to OpenAPI v3 will be a good answer, but requires much more work on our side (annotation migration, springfox to springdoc migration, etc.).
Thankyou for any response
The text was updated successfully, but these errors were encountered: