-
Notifications
You must be signed in to change notification settings - Fork 2
RequestBody. Schema
Felipe Tanabe edited this page Jan 29, 2026
·
5 revisions
| Path | Change id | Comment | Example | ER | Approved | Link | |
|---|---|---|---|---|---|---|---|
| 1 | title. value | add-schema-title | before after | annotation | add-schema-title | ||
| 2 | title. value | update-schema-title | before after | annotation | update-schema-title | ||
| 3 | title. value | remove-schema-title | before after | annotation | remove-schema-title | ||
| 4 | type. value | update-schema-type | before after | breaking | update-schema-type | ||
| 5 | type. value | update-schema-type-from-specific-type-to-any-type | before after | non-breaking | update-schema-type-from-specific-type-to-any-type | ||
| 6 | type. value | update-schema-type-from-any-type-to-specific-type | before after | [not supported] breaking | update-schema-type-from-any-type-to-specific-type | ||
| 7 | type. value | update-schema-type-from-specific-type-to-nothing | before after | [not supported] breaking | update-schema-type-from-specific-type-to-nothing | ||
| 8 | type. value | update-schema-type-from-nothing-to-specific-type | before after | [not supported] non-breaking | update-schema-type-from-nothing-to-specific-type | ||
| 9 | type. value | update-schema-type-to-an-equivalent-value | before after | no changes (effectively nothing was changed) | update-schema-type-to-an-equivalent-value | ||
| 10 | nullable. value | mark-schema-value-as-nullable | before after | non-breaking | mark-schema-value-as-nullable | ||
| 11 | nullable. value | mark-schema-value-as-non-nullable | before after | breaking | mark-schema-value-as-non-nullable | ||
| 12 | enum | add-enum | before after | breaking | add-enum | ||
| 13 | enum | remove-enum | before after | non-breaking | remove-enum | ||
| 14 | enum. value | add-enum-value | before after | non-breaking | add-enum-value | ||
| 15 | enum. value | update-enum-value | before after | 1 breaking (for removed enum) and 1 non-breaking (for added enum) ? | update-enum-value | ||
| 16 | enum. value | remove-enum-value | before after | breaking | remove-enum-value | ||
| 17 | format. value | add-format-for-string-property | for string type | before after | breaking | add-format-for-string-property | |
| 18 | format. value | update-format-for-string-property | for string type | before after | breaking | update-format-for-string-property | |
| 19 | format. value | remove-format-for-string-property | for string type | before after | non-breaking | remove-format-for-string-property | |
| 20 | minLength. value | add-min-length-for-string-property | for string type | before after | breaking | add-min-length-for-string-property | |
| 21 | minLength. value | increase-min-length-for-string-property | for string type | before after | breaking | increase-min-length-for-string-property | |
| 22 | minLength. value | decrease-min-length-for-string-property | for string type | before after | non-breaking | decrease-min-length-for-string-property | |
| 23 | minLength. value | remove-min-length-for-string-property | for string type | before after | non-breaking | remove-min-length-for-string-property | |
| 24 | maxLength. value | add-max-length-for-string-property | for string type | before after | breaking | add-max-length-for-string-property | |
| 25 | maxLength. value | increase-max-length-for-string-property | for string type | before after | non-breaking | increase-max-length-for-string-property | |
| 26 | maxLength. value | decrease-max-length-for-string-property | for string type | before after | breaking | decrease-max-length-for-string-property | |
| 27 | maxLength. value | remove-max-length-for-string-property | for string type | before after | non-breaking | remove-max-length-for-string-property | |
| 28 | pattern. value | add-pattern-for-string-property | for string type | before after | breaking | add-pattern-for-string-property | |
| 29 | pattern. value | update-pattern-for-string-property | for string type | before after | breaking | update-pattern-for-string-property | |
| 30 | pattern. value | remove-pattern-for-string-property | for string type | before after | non-breaking | remove-pattern-for-string-property | |
| 31 | format. value | add-format-for-number-property | for number type | before after | breaking | add-format-for-number-property | |
| 32 | format. value | update-format-for-number-property | for number type | before after | breaking | update-format-for-number-property | |
| 33 | format. value | remove-format-for-number-property | for number type | before after | non-breaking | remove-format-for-number-property | |
| 34 | minimum. value | add-minimum-for-number-property | for number type | before after | breaking | add-minimum-for-number-property | |
| 35 | minimum. value | increase-minimum-for-number-property | for number type | before after | breaking | increase-minimum-for-number-property | |
| 36 | minimum. value | decrease-minimum-for-number-property | for number type | before after | non-breaking | decrease-minimum-for-number-property | |
| 37 | minimum. value | remove-minimum-for-number-property | for number type | before after | non-breaking | remove-minimum-for-number-property | |
| 38 | exclusiveMinimum. value | mark-minimum-value-as-exclusive-for-number-property | for number type | before after | breaking + non-breaking | mark-minimum-value-as-exclusive-for-number-property | |
| 39 | exclusiveMinimum. value | mark-minimum-value-as-inclusive-for-number-property | for number type | before after | non-breaking + breaking | mark-minimum-value-as-inclusive-for-number-property | |
| 40 | maximum. value | add-maximum-for-number-property | for number type | before after | breaking | add-maximum-for-number-property | |
| 41 | exclusiveMinimum. value | increase-maximum-for-number-property | for number type | before after | non-breaking | increase-maximum-for-number-property | |
| 42 | exclusiveMinimum. value | decrease-maximum-for-number-property | for number type | before after | breaking | decrease-maximum-for-number-property | |
| 43 | exclusiveMinimum. value | remove-maximum-for-number-property | for number type | before after | non-breaking | remove-maximum-for-number-property | |
| 44 | exclusiveMaximum. value | mark-maximum-value-as-exclusive-for-number-property | for number type | before after | non-breaking + breaking | mark-maximum-value-as-exclusive-for-number-property | |
| 45 | exclusiveMaximum. value | mark-maximum-value-as-inclusive-for-number-property | for number type | before after | 2 non-breaking | mark-maximum-value-as-inclusive-for-number-property | |
| 46 | multiplyOf. value | add-multiple-of-for-number-property | for number type | before after | breaking | add-multiple-of-for-number-property | |
| 47 | exclusiveMaximum. value | update-multiple-of-for-number-property | for number type | before after | breaking | update-multiple-of-for-number-property | |
| 48 | exclusiveMaximum. value | remove-multiple-of-for-number-property | for number type | before after | non-breaking | remove-multiple-of-for-number-property | |
| 49 | minItems. value | add-minItems-with-default-value-for-array-property | for array type | before after | [not supported] | add-minItems-with-default-value-for-array-property | |
| 50 | minItems. value | remove-minItems-with-default-value-for-array-property | for array type | before after | [not supported] | remove-minItems-with-default-value-for-array-property | |
| 51 | minItems. value | add-min-items-for-array-property | for array type | before after | breaking | add-min-items-for-array-property | |
| 52 | minItems. value | increase-min-items-for-array-property | for array type | before after | breaking | increase-min-items-for-array-property | |
| 53 | minItems. value | decrease-min-items-for-array-property | for array type | before after | non-breaking | decrease-min-items-for-array-property | |
| 54 | minItems. value | remove-min-items-for-array-property | for array type | before after | non-breaking | remove-min-items-for-array-property | |
| 55 | maxItems. value | add-max-items-for-array-property | for array type | before after | breaking | add-max-items-for-array-property | |
| 56 | maxItems. value | increase-max-items-for-array-property | for array type | before after | non-breaking | increase-max-items-for-array-property | |
| 57 | maxItems. value | decrease-max-items-for-array-property | for array type | before after | non-breaking | decrease-max-items-for-array-property | |
| 58 | maxItems. value | remove-max-items-for-array-property | for array type | before after | non-breaking | remove-max-items-for-array-property | |
| 59 | uniqueItems. value | add-uniqueItems-with-default-value-for-array-property | for array type | before after | [not supported] | add-uniqueItems-with-default-value-for-array-property | |
| 60 | uniqueItems. value | remove-uniqueItems-with-default-value-for-array-property | for array type | before after | [not supported] | remove-uniqueItems-with-default-value-for-array-property | |
| 61 | uniqueItems. value | prohibit-non-unique-items-for-array-property | for array type | before after | breaking | prohibit-non-unique-items-for-array-property | |
| 62 | uniqueItems. value | allow-non-unique-items-for-array-property | for array type | before after | non-breaking | allow-non-unique-items-for-array-property | |
| 63 | properties. value | add-new-property-compliance | (compliance with additional properties ) | before after | non-breaking | add-new-property-compliance | |
| 64 | properties. value | add-new-property | (non-compliance with additional properties ) | before after | [NOT SUPPORTED] breaking | add-new-property | |
| 65 | properties. value | remove-property- compliance | (compliance with additional properties ) | [before](https://github.com/Netcracker/qubership-apihub-compatibility-suites/blob/develop/bin/comparison-base-suite/openapi/request-body-schema/remove-property- compliance/before.yaml) [after](https://github.com/Netcracker/qubership-apihub-compatibility-suites/blob/develop/bin/comparison-base-suite/openapi/request-body-schema/remove-property- compliance/after.yaml) | breaking (breaking in functionality) | remove-property-compliance | |
| 66 | properties. value | remove-property | (non-compliance with additional properties ) | before after | [NOT SUPPORTED] breaking (breaking in functionality) | remove-property | |
| 67 | required. value | add-required-property | before after | breaking | add-required-property | ||
| 68 | required. value | add-required-property-with-default | before after | non-breaking (a very controversial case, the decision should be made by the arch. committee) | add-required-property-with-default | ||
| 69 | required. value | update-required-property | before after | 2 changes: breaking for adding required property for prop2 non-breaking for removing required property for prop1 | update-required-property | ||
| 70 | required. value | remove-required-property | before after | non-breaking | remove-required-property | ||
| 71 | readOnly. value | mark-object-property-as-read-only | for object type | before after | breaking | mark-object-property-as-read-only | |
| 72 | readOnly. value | mark-object-property-as-not-read-only | before after | non-breaking | mark-object-property-as-not-read-only | ||
| 73 | writeOnly. value | mark-object-property-as-write-only | writeOnly properties may be sent in requests but not in responses | before after | non-breaking | mark-object-property-as-write-only | |
| 74 | writeOnly. value | 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 | [not supported] | add-minProperties-with-default-value-for-object-property | ||
| 76 | minProperties. value | remove-minProperties-with-default-value-for-object-property | before after | [not supported] | remove-minProperties-with-default-value-for-object-property | ||
| 77 | minProperties. value | add-min-properties-for-object-property | before after | breaking | add-min-properties-for-object-property | ||
| 78 | minProperties. value | increase-min-properties-for-object-property | before after | breaking | increase-min-properties-for-object-property | ||
| 79 | minProperties. value | decrease-min-properties-for-object-property | before after | non-breaking | decrease-min-properties-for-object-property | ||
| 80 | minProperties. value | remove-min-properties-for-object-property | before after | non-breaking | remove-min-properties-for-object-property | ||
| 81 | maxProperties. value | add-max-properties-for-object-property | before after | breaking | add-max-properties-for-object-property | ||
| 82 | maxProperties. value | increase-max-properties-for-object-property | before after | non-breaking | increase-max-properties-for-object-property | ||
| 83 | maxProperties. value | decrease-max-properties-for-object-property | before after | breaking | decrease-max-properties-for-object-property | ||
| 84 | maxProperties. value | remove-max-properties-for-object-property | before after | non-breaking | remove-max-properties-for-object-property | ||
| 85 | additionalProperties. value | update-definition-of-free-form-object | before after | no changes (effectively nothing was changed) | update-definition-of-free-form-object | ||
| 86 | additionalProperties.type. value | add-non-boolean-additional-properties | with non-boolean value (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 | before after | breaking | update-type-of-additional-properties | ||
| 88 | additionalProperties.type. value | remove-additional-properties | before after | breaking | remove-additional-properties | ||
| 89 | additionalProperties. value | update-additional-props-from-false-to-true | before after | [not supported] non-breaking | update-additional-props-from-false-to-true | ||
| 90 | additionalProperties. value | update-additional-props-from-true-to-false | before after | [not supported] breaking | update-additional-props-from-true-to-false | ||
| 91 | additionalProperties. value | update-additional-props-from-false-to-any | case was added in scope of APIHUB-10315 | before after | [not supported] non-breaking | update-additional-props-from-false-to-any | |
| 92 | additionalProperties. value | update-additional-props-from-any-to-false | before after | [not supported] breaking | update-additional-props-from-any-to-false | ||
| 93 | additionalProperties. value | remove-additional-props-with-false-value | before after | [not supported] non-breaking | remove-additional-props-with-false-value | ||
| 94 | additionalProperties. value | add-additional-props-with-false-value | before after | [not supported] breaking | add-additional-props-with-false-value | ||
| 95 | additionalProperties. value | update-additional-props-from-false-to-some-type | before after | [not supported] non-breaking | update-additional-props-from-false-to-some-type | ||
| 96 | additionalProperties. value | update-additional-props-from-some-type-to-false | before after | [not supported] breaking | update-additional-props-from-some-type-to-false | ||
| 97 | oneOf | add-one-of | before after | N non-breaking | add-one-of | ||
| 98 | oneOf. [*] | add-one-of-option | before after | non-breaking | add-one-of-option | ||
| 99 | oneOf. [*] | remove-one-of-option | before after | breaking | remove-one-of-option | ||
| 100 | oneOf | remove-one-of | remove oneOf + one of the object inside oneOf | before after | N breaking | remove-one-of | |
| 101 | anyOf | update-combiner-key-from-anyof-to-oneof | change only combiner key | before after | [not supported] breaking | update-combiner-key-from-anyof-to-oneof | |
| 102 | oneOf | update-combiner-key-from-oneof-to-anyof | change only combiner key | before after | [not supported] breaking | update-combiner-key-from-oneof-to-anyof | |
| 103 | oneOf | update-combiner-key-from-oneof-to-anyof-and-update-content | oneOf[1, 2] -> anyOf[3, 4, 5] | before after | [not supported] breaking | update-combiner-key-from-oneof-to-anyof-and-update-content | |
| 104 | anyOf | update-combiner-key-from-anyof-to-oneof-and-update-content | anyOf [1, 2] -> oneOf [3, 4, 5] | before after | [not supported] breaking | update-combiner-key-from-anyof-to-oneof-and-update-content | |
| 105 | oneOf | update-combiner-key-from-oneof-to-empty-anyof | oneOf [1, 2] -> anyOf[] | before after | [not supported] non-breaking | update-combiner-key-from-oneof-to-empty-anyof | |
| 106 | anyOf | update-combiner-key-from-anyof-to-empty-oneof | anyOf [1, 2] -> oneOf[] | before after | [not supported] non-breaking | update-combiner-key-from-anyof-to-empty-oneof | |
| 107 | anyOf | update-from-empty-anyof-to-oneof-with-content | anyOf[] -> oneOf [1, 2] | before after | [not supported] breaking | update-from-empty-anyof-to-oneof-with-content | |
| 108 | oneOf | update-from-empty-oneof-to-anyof-with-content | oneOf[] -> anyOf [1, 2] | before after | [not supported] breaking | update-from-empty-oneof-to-anyof-with-content | |
| 109 | anyOf.[*] | add-any-of | before after | non-breaking | add-any-of | ||
| 110 | add-any-of-option | before after | non-breaking | add-any-of-option | |||
| 111 | remove-any-of-option | before after | breaking | remove-any-of-option | |||
| 112 | remove-any-of | remove anyOf + one of the object inside anyOf | before after | breaking | remove-any-of | ||
| 113 | discriminator.[*] | add-discriminator | before after | [NOT SUPPORTED] non-breaking ? | add-discriminator | ||
| 114 | remove-discriminator | before after | [NOT SUPPORTED] non-breaking ? | remove-discriminator | |||
| 115 | update-discriminator | before after | [NOT SUPPORTED] non-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 after | 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 after | non-breaking | add-discriminator-mapping | |
| 118 | remove-discriminator-mapping | The mapping is removed from the discriminator, reverting to default behavior. | before after | breaking | remove-discriminator-mapping | ||
| 119 | update-discriminator-mapping | The mapping is updated to point to different schemas. | before after | breaking | update-discriminator-mapping | ||
| 120 | add-discriminator-mapping-element | A new element is added to the mapping in the discriminator. | before after | non-breaking | add-discriminator-mapping-element | ||
| 121 | remove-discriminator-mapping-element | One element is removed from the mapping in the discriminator. | before after | breaking | remove-discriminator-mapping-element | ||
| 122 | update-discriminator-mapping-element | One element in the mapping is updated in the discriminator. | before after | breaking | update-discriminator-mapping-element | ||
| 123 | allOf.[*] | before after | non-breaking | ||||
| 124 | add-all-of-option | before after | non-breaking | add-all-of-option | |||
| 125 | remove-all-of-option | (both "compliance with additional properties" and " non-compliance with additional properties") | before after | breaking (breaking of functionality for removing prop3) | remove-all-of-option | ||
| 126 | remove-all-of | (both "compliance with additional properties" and " non-compliance with additional properties") remove allOf + one of the object inside allOf | before after | breaking (breaking of functionality for removing prop2) | 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 | [NOT SUPPORTED] 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 | [NOT SUPPORTED] 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 | [NOT SUPPORTED] breaking ? | remove-xml-name-replacement-for-schema | ||
| 130 | add-xml-name-replacement-for-property | (default xml name the same as prop name) | before after | [NOT SUPPORTED] breaking ? | add-xml-name-replacement-for-property | ||
| 131 | update-xml-name-replacement-for-property | before after | [NOT SUPPORTED] breaking ? | update-xml-name-replacement-for-property | |||
| 132 | remove-xml-name-replacement-for-property | before after | [NOT SUPPORTED] breaking ? | remove-xml-name-replacement-for-property | |||
| 133 | add-attribute-with-default-value-for-xml | before after | [not supported] | add-attribute-with-default-value-for-xml | |||
| 134 | remove-attribute-with-default-value-for-xml | before after | [not supported] | remove-attribute-with-default-value-for-xml | |||
| 135 | mark-property-as-xml-attribute | before after | [NOT SUPPORTED] breaking | mark-property-as-xml-attribute | |||
| 136 | mark-property-as-xml-element | before after | [NOT SUPPORTED] 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 | [NOT SUPPORTED] 2 breaking ? | add-xml-prefix-and-namespace-for-schema | ||
| 138 | update-xml-prefix-for-schema | before after | [NOT SUPPORTED] breaking ? | update-xml-prefix-for-schema | |||
| 139 | remove-xml-prefix-and-namespace-for-schema | before after | [NOT SUPPORTED] 2 breaking ? | remove-xml-prefix-and-namespace-for-schema | |||
| 140 | add-xml-wrapped-with-default-value-for-array-property | before after | [not supported] | add-xml-wrapped-with-default-value-for-array-property | |||
| 141 | remove-xml-wrapped-with-default-value-for-array-property | before after | [not sepported] | remove-xml-wrapped-with-default-value-for-array-property | |||
| 142 | add-xml-wrapped-for-array-property | before after | [NOT SUPPORTED] breaking ? | add-xml-wrapped-for-array-property | |||
| 143 | remove-xml-wrapped-for-array-property | before after | [NOT SUPPORTED] breaking ? | remove-xml-wrapped-for-array-property |