ResponseBody. Schema
Schema
Section titled “Schema”For ResponseBody schemas, changes are classified according to Schema Changes with Scope Response.
See: Schema Changes - Scope Response
Example
Section titled “Example”To get specific examples for ResponseBody schemas, take the schema examples from the
Schema Changes section and insert them into the responses[*].content.application/json.schema
location of an OpenAPI specification.
Example OpenAPI structure:
paths: /pets: get: responses: '200': description: successful operation content: application/json: schema: # Insert schema from Schema Changes examples hereChanges
Section titled “Changes”| # | Path | Change id | Comment | Example | ER | Approved | Link |
|---|---|---|---|---|---|---|---|
| 1 | title. value | add-schema-title | before after | annotation | add-schema-title | ||
| 2 | update-schema-title | before after | annotation | update-schema-title | |||
| 3 | remove-schema-title | before after | annotation | remove-schema-title | |||
| 4 | type. value | update-schema-type | before after | breaking | update-schema-type | ||
| 5 | update-schema-type-from-specific-type-to-any-type | before after | breaking | update-schema-type-from-specific-type-to-any-type | |||
| 6 | update-schema-type-from-any-type-to-specific-type | before after | [not supported] non-breaking | update-schema-type-from-any-type-to-specific-type | |||
| 7 | update-schema-type-to-an-equivalent-value | before after | non-breaking no changes (effectively nothing was changed) | update-schema-type-to-an-equivalent-value | |||
| 8 | update-schema-type-from-string-type-to-nothing-type | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-schema-type-from-string-type-to-nothing-type/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-schema-type-from-string-type-to-nothing-type/after.yaml) |
[not supported] breaking | update-schema-type-from-string-type-to-nothing-type | |||
| 9 | update-schema-type-from-nothing-type-to-string-type | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-schema-type-from-nothing-type-to-string-type/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-schema-type-from-nothing-type-to-string-type/after.yaml) |
[not supported] non-breaking | update-schema-type-from-nothing-type-to-string-type | |||
| 10 | nullable. value | mark-schema-value-as-nullable | set nullable = true | before after | breaking | mark-schema-value-as-nullable | |
| 11 | explicitly set nullable = false | no changes | explicitly set nullable = false | ||||
| 12 | enum | add-enum | before after | non-breaking | add-enum | ||
| 13 | remove-enum | before after | breaking | remove-enum | |||
| 14 | enum. value | add-enum-value | More details… | before after | requires attention | add-enum-value | |
| 15 | update-enum-value | before after | 1 breaking (for added enum value) and 1 non-breaking (for deleted enum value) | update-enum-value | |||
| 16 | remove-enum-value | before after | non-breaking | remove-enum-value | |||
| 17 | (for string type) format. value | add-format-for-string-property | before after | non-breaking | add-format-for-string-property | ||
| 18 | update-format-for-string-property | before after | breaking ? | update-format-for-string-property | |||
| 19 | remove-format-for-string-property | from approver: “Changing the data format almost always brings impacts on the other side. In this case, the impact may not happen if the NC continues to give the string in ISO 8601 format, in another format the receiving side will not be able to convert the type according to this mask to the required format and will crash.” | before after | breaking | yes | remove-format-for-string-property | |
| 20 | (for string type) minLength. value | add-min-length-for-string-property | before after | non-breaking | add-min-length-for-string-property | ||
| 21 | increase-min-length-for-string-property | before after | non-breaking | increase-min-length-for-string-property | |||
| 22 | decrease-min-length-for-string-property | from approver “In this case, there may not be an impact, but in the case of strict validation, as in the processing code or request validation, an impact on the customer side is possible.” | before after | breaking | yes | decrease-min-length-for-string-property | |
| 23 | remove-min-length-for-string-property | In this case, there may not be an impact, but in the case of strict validation, as in the processing code or request validation, an impact on the customer side is possible. | before after | breaking | yes | remove-min-length-for-string-property | |
| 24 | (for string type) maxLength. value | add-max-length-for-string-property | before after | non-breaking | add-max-length-for-string-property | ||
| 25 | increase-max-length-for-string-property | from approver “In this case, there may not be an impact, but in the case of strict validation, as in the processing code or request validation, an impact on the customer side is possible.” | before after | breaking | yes | increase-max-length-for-string-property | |
| 26 | decrease-max-length-for-string-property | before after | non-breaking | decrease-max-length-for-string-property | |||
| 27 | remove-max-length-for-string-property | In this case, there may not be an impact, but in the case of strict validation, as in the processing code or request validation, an impact on the customer side is possible. | before after | breaking | yes | remove-max-length-for-string-property | |
| 28 | (for string type) pattern. value | add-pattern-for-string-property | before after | non-breaking | add-pattern-for-string-property | ||
| 29 | update-pattern-for-string-property | from approver “Change of format, impact on the customer’s side” | before after | breaking | yes | update-pattern-for-string-property | |
| 30 | remove-pattern-for-string-property | from approver “In this case, the impact may not happen if the NC continues to give the string by old pattern: ‘^[A-Za-z0-9_-]+$’, in another format the receiving side will not be able to convert the type according to this mask to the required format and will crash.” | before after | breaking | yes | remove-pattern-for-string-property | |
| 31 | (for number type) format. value | add-format-for-number-property | before after | non-breaking | add-format-for-number-property | ||
| 32 | update-format-for-number-property | before after | breaking ? | update-format-for-number-property | |||
| 33 | remove-format-for-number-property | before after | breaking | remove-format-for-number-property | |||
| 34 | (for number type) minimum. value | add-minimum-for-number-property | before after | non-breaking | add-minimum-for-number-property | ||
| 35 | increase-minimum-for-number-property | before after | non-breaking | increase-minimum-for-number-property | |||
| 36 | decrease-minimum-for-number-property | before after | breaking | decrease-minimum-for-number-property | |||
| 37 | remove-minimum-for-number-property | before after | breaking | remove-minimum-for-number-property | |||
| 38 | (for number type) exclusiveMinimum. value | mark-minimum-value-as-exclusive-for-number-property | before after | non-breaking | mark-minimum-value-as-exclusive-for-number-property | ||
| 39 | mark-minimum-value-as-inclusive-for-number-property | before after | breaking | mark-minimum-value-as-inclusive-for-number-property | |||
| 40 | (for number type) maximum. value | add-maximum-for-number-property | before after | non-breaking | add-maximum-for-number-property | ||
| 41 | increase-maximum-for-number-property | from approver: “In this case, there may not be an impact, but in the case of strict validation, as in the processing code or request validation, an impact on the customer side is possible.” | before after | breaking | yes | increase-maximum-for-number-property | |
| 42 | decrease-maximum-for-number-property | before after | non-breaking | decrease-maximum-for-number-property | |||
| 43 | remove-maximum-for-number-property | from approver “In this case, there may not be an impact, but in the case of strict validation, as in the processing code or request validation, an impact on the customer side is possible.” | before after | breaking | yes | remove-maximum-for-number-property | |
| 44 | (for number type) exclusiveMaximum. value | mark-maximum-value-as-exclusive-for-number-property | before after | non-breaking | mark-maximum-value-as-exclusive-for-number-property | ||
| 45 | mark-maximum-value-as-inclusive-for-number-property | before after | breaking | mark-maximum-value-as-inclusive-for-number-property | |||
| 46 | (for number type) multipleOf. value | add-multiple-of-for-number-property | before after | non-breaking | add-multiple-of-for-number-property | ||
| 47 | update-multiple-of-for-number-property | before after | breaking | update-multiple-of-for-number-property | |||
| 48 | remove-multiple-of-for-number-property | before after | breaking ? | remove-multiple-of-for-number-property | |||
| 49 | (for array type) minItems. value | add-minItems-with-default-value-for-array-property | before after | <no changes> [not supported] | add-minItems-with-default-value-for-array-property | ||
| 50 | remove-minItems-with-default-value-for-array-property | before after | <no changes> [not supported] | remove-minItems-with-default-value-for-array-property | |||
| 51 | add-min-items-for-array-property | before after | non-breaking | add-min-items-for-array-property | |||
| 52 | increase-min-items-for-array-property | before after | non-breaking | increase-min-items-for-array-property | |||
| 53 | decrease-min-items-for-array-property | from approver: “In this case, there may not be an impact, but in the case of strict validation, as in the processing code or request validation, an impact on the customer side is possible. “ | before after | breaking | yes | decrease-min-items-for-array-property | |
| 54 | remove-min-items-for-array-property | from approver: “The customer might not expect an empty list, which means the necessary validation might be missing and some part of the flow might fail on the customer’s side.” | before after | breaking | yes | remove-min-items-for-array-property | |
| 55 | (for array type) maxItems. value | add-max-items-for-array-property | before after | non-breaking | add-max-items-for-array-property | ||
| 56 | increase-max-items-for-array-property | from approver: “In this case, there may not be an impact, but in the case of strict validation, as in the processing code or request validation, an impact on the customer side is possible. “ | before after | breaking | yes | increase-max-items-for-array-property | |
| 57 | decrease-max-items-for-array-property | before after | non-breaking | decrease-max-items-for-array-property | |||
| 58 | remove-max-items-for-array-property | from approver: “If the system is not designed for a large list size, and each one is processed and calls a lot of logic, especially old ones, it can impact the customer’s server with a heavy request.” | before after | breaking | yes | remove-max-items-for-array-property | |
| 59 | (for array type) uniqueItems. value | add-uniqueItems-with-default-value-for-array-property | before after | <no changes> [not supported] | add-uniqueItems-with-default-value-for-array-property | ||
| 60 | remove-uniqueItems-with-default-value-for-array-property | before after | <no changes> [not supported] | remove-uniqueItems-with-default-value-for-array-property | |||
| 61 | prohibit-non-unique-items-for-array-property | before after | non-breaking | prohibit-non-unique-items-for-array-property | |||
| 62 | allow-non-unique-items-for-array-property | from approver: “On the customer side, it is necessary to implement additional functionality for processing identical values.” | before after | breaking | yes | allow-non-unique-items-for-array-property | |
| 63 | (for object type) properties. value | add-new-property-compliance | compliance with additional properties | before after | non-breaking | yes | add-new-property-compliance |
| 64 | add-new-property | (non-compliance with additional properties ) | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-new-property/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-new-property/after.yaml) |
[NOT SUPPORTED] breaking | add-new-property | ||
| 65 | remove-property-compliance | (compliance with additional properties ) | before after | non-breaking | yes | remove-property-compliance | |
| 66 | remove-property | (non-compliance with additional properties ) | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-property/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-property/after.yaml) |
[NOT SUPPORTED] non-breaking | remove-property | ||
| 67 | (for object type) required.value | add-required-property | before after | non-breaking | add-required-property | ||
| 68 | add-required-property-with-default | before after | non-breaking | add-required-property-with-default | |||
| 69 | update-required-property | before after | 2 changes: breaking for removing required property for prop1 non-breaking for adding required property for prop2 | update-required-property | |||
| 70 | remove-required-property | before after | breaking | remove-required-property | |||
| 71 | (for object type) readOnly. value readOnly properties are included in responses but not in requests | mark-object-property-as-read-only | before after | non-breaking | mark-object-property-as-read-only | ||
| 72 | mark-object-property-as-not-read-only | before after | non-breaking | mark-object-property-as-not-read-only | |||
| 73 | (for object type) writeOnly. value writeOnly properties may be sent in requests but not in responses | mark-object-property-as-write-only | before after | non-breaking | mark-object-property-as-write-only | ||
| 74 | mark-object-property-as-not-write-only | before after | non-breaking | mark-object-property-as-not-write-only | |||
| 75 | (for object type) minProperties. value | add-minProperties-with-default-value-for-object-property | before after | <no changes> [not supported] | add-minProperties-with-default-value-for-object-property | ||
| 76 | remove-minProperties-with-default-value-for-object-property | before after | <no changes> [not supported] | remove-minProperties-with-default-value-for-object-property | |||
| 77 | add-min-properties-for-object-property | before after | non-breaking | add-min-properties-for-object-property | |||
| 78 | increase-min-properties-for-object-property | before after | non-breaking | increase-min-properties-for-object-property | |||
| 79 | decrease-min-properties-for-object-property | from approver: “If there were only 2 properties in an object, then the customer built the logic that both properties were always present in this object, the absence of one of them would cause errors on the customer’s side.” | before after | breaking | yes | decrease-min-properties-for-object-property | |
| 80 | remove-min-properties-for-object-property | from approver “The customer might not expect an empty object, which means the necessary validation might be missing and some part of the flow might fail on the customer’s side.” | before after | breaking | yes | remove-min-properties-for-object-property | |
| 81 | (for object type) maxProperties. value | add-max-properties-for-object-property | before after | non-breaking | add-max-properties-for-object-property | ||
| 82 | increase-max-properties-for-object-property | before after | breaking | increase-max-properties-for-object-property | |||
| 83 | decrease-max-properties-for-object-property | before after | non-breaking | decrease-max-properties-for-object-property | |||
| 84 | remove-max-properties-for-object-property | before after | breaking | remove-max-properties-for-object-property | |||
| 85 | (for object type) additionalProperties.value | update-definition-of-free-form-object | before after | non-breaking no changes (effectively nothing was changed) | update-definition-of-free-form-object | ||
| 86 | additionalProperties.type.value | add-non-boolean-additional-properties | (i.e. define dictionary with value of specific type) | before after | breaking | add-non-boolean-additional-properties | |
| 87 | additionalProperties.type. value | update-type-of-additional-properties | from approver “Depending on the type of data processing the customer uses, it is better to be on the safe side.” | before after | breaking | yes | update-type-of-additional-properties |
| 88 | additionalProperties.type. value | remove-additional-properties | from approver: “Without additionalProperties the system will not allow adding any properties and this will affect the data validation. NC often uses additionalProperties on objects to avoid affecting development when new ones are added.” | before after | breaking | yes | remove-additional-properties |
| 89 | additionalProperties. value | update-additional-props-from-false-to-true | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-additional-props-from-false-to-true/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-additional-props-from-false-to-true/after.yaml) |
[Not Supported] | update-additional-props-from-false-to-true | ||
| 90 | additionalProperties. value | update-additional-props-from-true-to-false | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-additional-props-from-true-to-false/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-additional-props-from-true-to-false/after.yaml) |
[Not Supported] | update-additional-props-from-true-to-false | ||
| 91 | additionalProperties. value | update-additional-props-from-false-to-any | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-additional-props-from-false-to-any/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-additional-props-from-false-to-any/after.yaml) |
[Not Supported] | update-additional-props-from-false-to-any | ||
| 92 | additionalProperties. value | update-additional-props-from-any-to-false | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-additional-props-from-any-to-false/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-additional-props-from-any-to-false/after.yaml) |
[Not Supported] | update-additional-props-from-any-to-false | ||
| 93 | additionalProperties. value | remove-additional-props-with-false-value | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-additional-props-with-false-value/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-additional-props-with-false-value/after.yaml) |
[Not Supported] | remove-additional-props-with-false-value | ||
| 94 | additionalProperties. value | add-additional-props-with-false-value | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-additional-props-with-false-value/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-additional-props-with-false-value/after.yaml) |
[Not Supported] | add-additional-props-with-false-value | ||
| 95 | additionalProperties. value | update-additional-props-from-false-to-some-type | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-additional-props-from-false-to-some-type/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-additional-props-from-false-to-some-type/after.yaml) |
[Not Supported] | update-additional-props-from-false-to-some-type | ||
| 96 | additionalProperties. value | update-additional-props-from-some-type-to-false | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-additional-props-from-some-type-to-false/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-additional-props-from-some-type-to-false/after.yaml) |
[Not Supported] | update-additional-props-from-some-type-to-false | ||
| 97 | oneOf. [*] | add-one-of | before after | breaking | add-one-of | ||
| 98 | add-one-of-option | before after | breaking | add-one-of-option | |||
| 99 | remove-one-of-option | before after | non-breaking | remove-one-of-option | |||
| 100 | remove-one-of | remove oneOf + one of the object inside oneOf | before after | N non-breaking | remove-one-of | ||
| 101 | update-combiner-key-from-anyof-to-oneof | (changed only combiner key) cases was added in scope of APIHUB-10061 | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-combiner-key-from-anyof-to-oneof/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-combiner-key-from-anyof-to-oneof/after.yaml) |
breaking | update-combiner-key-from-anyof-to-oneof | ||
| 102 | update-combiner-key-from-oneof-to-anyof | (changed only combiner key) cases was added in scope of APIHUB-10061 | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-combiner-key-from-oneof-to-anyof/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-combiner-key-from-oneof-to-anyof/after.yaml) |
breaking | update-combiner-key-from-oneof-to-anyof | ||
| 103 | update-combiner-key-from-oneof-to-anyof-and-update-content | oneOf [1, 2] -> anyOf [3, 4, 5] (changed either combiner key AND content) cases was added in scope of APIHUB-10061 | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-combiner-key-from-oneof-to-anyof-and-update-content/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-combiner-key-from-oneof-to-anyof-and-update-content/after.yaml) |
breaking | update-combiner-key-from-oneof-to-anyof-and-update-content | ||
| 104 | update-combiner-key-from-anyof-to-oneof-and-update-content | anyOf [1, 2] -> oneOf [3, 4, 5] (changed either combiner key AND content) cases was added in scope of APIHUB-10061 | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-combiner-key-from-anyof-to-oneof-and-update-content/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-combiner-key-from-anyof-to-oneof-and-update-content/after.yaml) |
breaking | update-combiner-key-from-anyof-to-oneof-and-update-content | ||
| 105 | update-combiner-key-from-oneof-to-empty-anyof | oneOf [1, 2] -> anyOf[] (changed combiner to another empty combiner) cases was added in scope of APIHUB-10061 | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-combiner-key-from-oneof-to-empty-anyof/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-combiner-key-from-oneof-to-empty-anyof/after.yaml) |
breaking | update-combiner-key-from-oneof-to-empty-anyof | ||
| 106 | update-combiner-key-from-anyof-to-empty-oneof | anyOf [1, 2] -> oneOf[] (changed combiner to another empty combiner) cases was added in scope of APIHUB-10061 | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-combiner-key-from-anyof-to-empty-oneof/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-combiner-key-from-anyof-to-empty-oneof/after.yaml) |
breaking | update-combiner-key-from-anyof-to-empty-oneof | ||
| 107 | update-from-empty-anyof-to-oneof-with-content | anyOf[] -> oneOf [1, 2] cases was added in scope of APIHUB-10061 | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-from-empty-anyof-to-oneof-with-content/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-from-empty-anyof-to-oneof-with-content/after.yaml) |
breaking | update-from-empty-anyof-to-oneof-with-content | ||
| 108 | update-from-empty-oneof-to-anyof-with-content | oneOf[] -> anyOf [1, 2] cases was added in scope of APIHUB-10061 | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-from-empty-oneof-to-anyof-with-content/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-from-empty-oneof-to-anyof-with-content/after.yaml) |
breaking | update-from-empty-oneof-to-anyof-with-content | ||
| 109 | anyOf.[*] | add-any-of | before after | breaking | add-any-of | ||
| 110 | add-any-of-option | before after | breaking | add-any-of-option | |||
| 111 | remove-any-of-option | before after | non-breaking | remove-any-of-option | |||
| 112 | remove-any-of | remove anyOf + one of the object inside anyOf | before after | non-breaking | remove-any-of | ||
| 113 | .discriminator.[*] | add-discriminator | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-discriminator/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-discriminator/after.yaml) |
[NOT SUPPORTED] breaking ? | add-discriminator | ||
| 114 | remove-discriminator | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-discriminator/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-discriminator/after.yaml) |
[NOT SUPPORTED] breaking ? | remove-discriminator | |||
| 115 | update-discriminator | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-discriminator/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-discriminator/after.yaml) |
[NOT SUPPORTED] breaking ? | update-discriminator | |||
| 116 | schema.discriminator .propertyName | update-discriminator-propertyName | The propertyName in the discriminator is updated to point to a different property in the schema. | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-discriminator-propertyName/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-discriminator-propertyName/after.yaml) |
breaking | update-discriminator-propertyName | |
| 117 | schema.discriminator .mapping | add-discriminator-mapping | The mapping is added to the discriminator to explicitly link property values to schemas. | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-discriminator-mapping/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-discriminator-mapping/after.yaml) |
non-breaking | add-discriminator-mapping | |
| 118 | remove-discriminator-mapping | The mapping is removed from the discriminator, reverting to default behavior. | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-discriminator-mapping/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-discriminator-mapping/after.yaml) |
breaking | remove-discriminator-mapping | ||
| 119 | update-discriminator-mapping | The mapping is updated to point to different schemas. | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-discriminator-mapping/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-discriminator-mapping/after.yaml) |
breaking | update-discriminator-mapping | ||
| 120 | add-discriminator-mapping-element | A new element is added to the mapping in the discriminator. | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-discriminator-mapping-element/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-discriminator-mapping-element/after.yaml) |
non-breaking? | add-discriminator-mapping-element | ||
| 121 | remove-discriminator-mapping-element | One element is removed from the mapping in the discriminator. | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-discriminator-mapping-element/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-discriminator-mapping-element/after.yaml) |
breaking | remove-discriminator-mapping-element | ||
| 122 | update-discriminator-mapping-element | One element in the mapping is updated in the discriminator. | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-discriminator-mapping-element/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-discriminator-mapping-element/after.yaml) |
breaking | update-discriminator-mapping-element | ||
| 123 | allOf.[*] | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/after.yaml) |
non-breaking | ||||
| 124 | add-all-of-option | compliance with additional properties | before after | non-breaking | add-all-of-option | ||
| 125 | remove-all-of-option | before after | non-breaking | remove-all-of-option | |||
| 126 | remove-all-of | remove allOf + one of the object inside allOf | before after | non-breaking | remove-all-of | ||
| 127 | add-xml-name-replacement-for-schema | add xml name replacement for schema components.schema is necessary to define xml element name (is it possible to specify xml element name inline?) default xml name the same as schema name | before after | breaking ? | add-xml-name-replacement-for-schema | ||
| 128 | update-xml-name-replacement-for-schema | (components.schema is necessary to define xml element name) | before after | breaking ? | update-xml-name-replacement-for-schema | ||
| 129 | remove-xml-name-replacement-for-schema | (components.schema is necessary to define xml element name) | before after | breaking ? | remove-xml-name-replacement-for-schema | ||
| 130 | add-xml-name-replacement-for-property | (default xml name the same as prop name) | before after | breaking ? | add-xml-name-replacement-for-property | ||
| 131 | update-xml-name-replacement-for-property | before after | breaking ? | update-xml-name-replacement-for-property | |||
| 132 | remove-xml-name-replacement-for-property | before after | breaking ? | remove-xml-name-replacement-for-property | |||
| 133 | add-attribute-with-default-value-for-xml | before after | <no changes> [not supported] | add-attribute-with-default-value-for-xml | |||
| 134 | remove-attribute-with-default-value-for-xml | before after | <no changes> [not supported] | remove-attribute-with-default-value-for-xml | |||
| 135 | mark-property-as-xml-attribute | before after | breaking ? | mark-property-as-xml-attribute | |||
| 136 | mark-property-as-xml-element | before after | breaking ? | mark-property-as-xml-element | |||
| 137 | add-xml-prefix-and-namespace-for-schema | (prefix and namespace in once case as both must be specified) | before after | breaking ? | add-xml-prefix-and-namespace-for-schema | ||
| 138 | update-xml-prefix-for-schema | before after | breaking ? | update-xml-prefix-for-schema | |||
| 139 | remove-xml-prefix-and-namespace-for-schema | before after | breaking ? | remove-xml-prefix-and-namespace-for-schema | |||
| 140 | add-xml-wrapped-with-default-value-for-array-property | before after | <no changes> [not supported] | add-xml-wrapped-with-default-value-for-array-property | |||
| 141 | remove-xml-wrapped-with-default-value-for-array-property | before after | <no changes> [not supported] | remove-xml-wrapped-with-default-value-for-array-property | |||
| 142 | add-xml-wrapped-for-array-property | before after | breaking [not supported] | add-xml-wrapped-for-array-property | |||
| 143 | remove-xml-wrapped-for-array-property | before after | breaking [not supported] | remove-xml-wrapped-for-array-property | |||
| 144 | .links | add-link | OAS links, ER shall define subsequent actions based on the response -each link must reference a valid target operation | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-link/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-link/after.yaml) |
non-breaking | add-link | |
| 145 | remove-link | OAS links, ER shall define subsequent actions based on the response -each link must reference a valid target operation | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-link/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-link/after.yaml) |
breaking | remove-link | ||
| 146 | update-link | OAS links, ER shall define subsequent actions based on the response -each link must reference a valid target operation | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-link/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-link/after.yaml) |
breaking | update-link | ||
| 147 | .links.[*] .operationRef | update-operationRef | OAS links, ER shall define subsequent actions based on the response body -operationRef is updated to point to another operation | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-operationRef/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-operationRef/after.yaml) |
breaking | update-operationRef | |
| 148 | .links.[*] .operationId | update-operationId | OAS links, ER shall define subsequent actions based on the response body -operationId is updated to point to a different operation | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-operationId/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-operationId/after.yaml) |
breaking | update-operationId | |
| 149 | .links.[*] .parameters | add-parameters | OAS links, ER shall define subsequent actions based on the response body -parameters adds a map of parameters to pass | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-parameters/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-parameters/after.yaml) |
non-breaking | add-parameters | |
| 150 | remove-parameters | OAS links, ER shall define subsequent actions based on the response body -parameters is removed | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-parameters/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-parameters/after.yaml) |
breaking | remove-parameters | ||
| 151 | update-parameters | OAS links, ER shall define subsequent actions based on the response body -parameters is updated to pass different values | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-parameters/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-parameters/after.yaml) |
breaking | update-parameters | ||
| 152 | .links.[*] . requestBody | add-requestBody | OAS links, ER shall define subsequent actions based on the response body -requestBody adds body content to pass | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-requestBody/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-requestBody/after.yaml) |
non-breaking | add-requestBody | |
| 153 | remove-requestBody | OAS links, ER shall define subsequent actions based on the response body -requestBody is removed | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-requestBody/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-requestBody/after.yaml) |
breaking | remove-requestBody | ||
| 154 | update-requestBody | OAS links, ER shall define subsequent actions based on the response body -requestBody is updated to pass new values | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-requestBody/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-requestBody/after.yaml) |
breaking | update-requestBody | ||
| 155 | .links.[*] . description | add-description | OAS links, ER shall define subsequent actions based on the response body -description adds context to the link | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-description/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-description/after.yaml) |
annotation | add-description | |
| 156 | remove-description | OAS links, ER shall define subsequent actions based on the response body -description is removed | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-description/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-description/after.yaml) |
annotation | remove-description | ||
| 157 | update-description | OAS links, ER shall define subsequent actions based on the response body -description is updated | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-description/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-description/after.yaml) |
annotation | update-description | ||
| 158 | .links.[*] . server | add-server | OAS links, ER shall define subsequent actions based on the response body -server adds a server object | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-server/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/add-server/after.yaml) |
non-breaking | add-server | |
| 159 | remove-server | OAS links, ER shall define subsequent actions based on the response body -server is removed | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-server/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/remove-server/after.yaml) |
breaking | remove-server | ||
| 160 | update-server | OAS links, ER shall define subsequent actions based on the response body -server is updated to point to a different server | before (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-server/before.yaml) after (../../../../frontend/compatibility-suites/bin/comparison-base-suite/openapi/response-body-schema/update-server/after.yaml) |
breaking | update-server |