Skip to content

Latest commit

 

History

History
145 lines (145 loc) · 67.4 KB

Parameters. Schema.md

File metadata and controls

145 lines (145 loc) · 67.4 KB
Path Change id Comment ER Link
1 title. add-schema-title annotation add-schema-title
2 title. update-schema-title annotation update-schema-title
3 title. remove-schema-title annotation remove-schema-title
4 type. update-schema-type breaking update-schema-type
5 type. update-schema-type-from-specific-type-to-any-type non-breaking update-schema-type-from-specific-type-to-any-type
6 type. update-schema-type-from-any-type-to-specific-type [not supported] breaking update-schema-type-from-any-type-to-specific-type
7 type. update-schema-type-from-specific-type-to-nothing [not supported] breaking update-schema-type-from-specific-type-to-nothing
8 type. update-schema-type-from-nothing-to-specific-type [not supported] non-breaking update-schema-type-from-nothing-to-specific-type
9 type. update-schema-type-to-an-equivalent-value no changes (effectively nothing was changed) update-schema-type-to-an-equivalent-value
10 nullable. mark-schema-value-as-nullable non-breaking mark-schema-value-as-nullable
11 nullable. mark-schema-value-as-non-nullable breaking mark-schema-value-as-non-nullable
12 enum add-enum breaking add-enum
13 enum remove-enum non-breaking remove-enum
14 enum. add-enum-value non-breaking add-enum-value
15 enum. update-enum-value 1 breaking (for removed enum) and 1 non-breaking (for added enum) ? update-enum-value
16 enum. remove-enum-value breaking remove-enum-value
17 format. add-format-for-string-property for string type breaking add-format-for-string-property
18 format. update-format-for-string-property for string type breaking update-format-for-string-property
19 format. remove-format-for-string-property for string type non-breaking remove-format-for-string-property
20 minLength. add-min-length-for-string-property for string type breaking add-min-length-for-string-property
21 minLength. increase-min-length-for-string-property for string type breaking increase-min-length-for-string-property
22 minLength. decrease-min-length-for-string-property for string type non-breaking decrease-min-length-for-string-property
23 minLength. remove-min-length-for-string-property for string type non-breaking remove-min-length-for-string-property
24 maxLength. add-max-length-for-string-property for string type breaking add-max-length-for-string-property
25 maxLength. increase-max-length-for-string-property for string type non-breaking increase-max-length-for-string-property
26 maxLength. decrease-max-length-for-string-property for string type breaking decrease-max-length-for-string-property
27 maxLength. remove-max-length-for-string-property for string type non-breaking remove-max-length-for-string-property
28 pattern. add-pattern-for-string-property for string type breaking add-pattern-for-string-property
29 pattern. update-pattern-for-string-property for string type breaking update-pattern-for-string-property
30 pattern. remove-pattern-for-string-property for string type non-breaking remove-pattern-for-string-property
31 format. add-format-for-number-property for number type breaking add-format-for-number-property
32 format. update-format-for-number-property for number type breaking update-format-for-number-property
33 format. remove-format-for-number-property for number type non-breaking remove-format-for-number-property
34 minimum. add-minimum-for-number-property for number type breaking add-minimum-for-number-property
35 minimum. increase-minimum-for-number-property for number type breaking increase-minimum-for-number-property
36 minimum. decrease-minimum-for-number-property for number type non-breaking decrease-minimum-for-number-property
37 minimum. remove-minimum-for-number-property for number type non-breaking remove-minimum-for-number-property
38 exclusiveMinimum. mark-minimum-value-as-exclusive-for-number-property for number type breaking + non-breaking mark-minimum-value-as-exclusive-for-number-property
39 minimum. mark-minimum-value-as-inclusive-for-number-property for number type non-breaking mark-minimum-value-as-inclusive-for-number-property
40 maximum. add-maximum-for-number-property for number type breaking add-maximum-for-number-property
41 maximum. increase-maximum-for-number-property for number type non-breaking increase-maximum-for-number-property
42 maximum. decrease-maximum-for-number-property for number type breaking decrease-maximum-for-number-property
43 maximum. remove-maximum-for-number-property for number type non-breaking remove-maximum-for-number-property
44 exclusiveMaximum. mark-maximum-value-as-exclusive-for-number-property for number type breaking + non-breaking mark-maximum-value-as-exclusive-for-number-property
45 exclusiveMaximum. mark-maximum-value-as-inclusive-for-number-property for number type non-breaking mark-maximum-value-as-inclusive-for-number-property
46 multiplyOf. add-multiple-of-for-number-property for number type breaking add-multiple-of-for-number-property
47 multiplyOf. update-multiple-of-for-number-property for number type breaking update-multiple-of-for-number-property
48 multiplyOf. remove-multiple-of-for-number-property for number type non-breaking remove-multiple-of-for-number-property
49 minItems. add-min-items-with-default-value-for-array-property for array type [not supported] add-min-items-with-default-value-for-array-property
50 minItems. remove-min-items-with-default-value-for-array-property for array type [not supported] remove-min-items-with-default-value-for-array-property
51 minItems. add-min-items-for-array-property for array type breaking add-min-items-for-array-property
52 minItems. increase-min-items-for-array-property for array type breaking increase-min-items-for-array-property
53 minItems. decrease-min-items-for-array-property for array type non-breaking decrease-min-items-for-array-property
54 minItems. remove-min-items-for-array-property for array type non-breaking remove-min-items-for-array-property
55 maxItems. add-max-items-for-array-property for array type breaking add-max-items-for-array-property
56 maxItems. increase-max-items-for-array-property for array type non-breaking increase-max-items-for-array-property
57 maxItems. decrease-max-items-for-array-property for array type breaking decrease-max-items-for-array-property
58 maxItems. remove-max-items-for-array-property for array type non-breaking remove-max-items-for-array-property
59 uniqueItems. add-unique-items-with-default-value-for-array-property for array type [not supported] add-unique-items-with-default-value-for-array-property
60 uniqueItems. remove-unique-items-with-default-value-for-array-property for array type [not supported] remove-unique-items-with-default-value-for-array-property
61 uniqueItems. prohibit-non-unique-items-for-array-property for array type breaking prohibit-non-unique-items-for-array-property
62 uniqueItems. allow-non-unique-items-for-array-property for array type non-breaking allow-non-unique-items-for-array-property
63 properties. add-new-property for object type, this case is in compliance with additional properties non-breaking add-new-property
64 properties. add-new-property for object type, this case is in non- compliance with additional properties [not supported] breaking add-new-property
65 properties. remove-property for object type, this case is in compliance with additional properties breaking (breaking of functionality) remove-property
66 properties. remove-property for object type, this case is in non-compliance with additional properties [NOT SUPPORTED] breaking (breaking of functionality) remove-property
67 required. add-required-property for object type breaking add-required-property
68 required. add-required-property-with-default for object type non-breaking add-required-property-with-default
69 required. update-required-property for object type 2 changes: breaking for adding required property for prop2 non-breaking for removing required property for prop1 update-required-property
70 required. remove-required-property for object type non-breaking remove-required-property
71 readOnly. mark-object-property-as-read-only for object type breaking mark-object-property-as-read-only
72 readOnly. mark-object-property-as-not-read-only for object type non-breaking mark-object-property-as-not-read-only
73 writeOnly. mark-object-property-as-write-only writeOnly properties may be sent only in requests non-breaking mark-object-property-as-write-only
74 writeOnly. mark-object-property-as-not-write-only non-breaking mark-object-property-as-not-write-only
75 minProperties. add-min-properties-with-default-value-for-object-property for object type [not supported] add-min-properties-with-default-value-for-object-property
76 minProperties. remove-min-properties-with-default-value-for-object-property for object type [not supported] remove-min-properties-with-default-value-for-object-property
77 minProperties. add-min-properties-for-object-property for object type breaking add-min-properties-for-object-property
78 minProperties. increase-min-properties-for-object-property for object type breaking increase-min-properties-for-object-property
79 minProperties. decrease-min-properties-for-object-property for object type non-breaking decrease-min-properties-for-object-property
80 minProperties. remove-min-properties-for-object-property for object type non-breaking remove-min-properties-for-object-property
81 maxProperties. add-max-properties-for-object-property for object type breaking add-max-properties-for-object-property
82 maxProperties. increase-max-properties-for-object-property for object type non-breaking increase-max-properties-for-object-property
83 maxProperties. decrease-max-properties-for-object-property for object type breaking decrease-max-properties-for-object-property
84 maxProperties. remove-max-properties-for-object-property for object type non-breaking remove-max-properties-for-object-property
85 additionalProperties. update-definition-of-free-form-object for object type non-breaking ? update-definition-of-free-form-object
86 additionalProperties.type. add-non-boolean-additional-properties i.e. define dictionary with value of specific type breaking add-non-boolean-additional-properties
87 additionalProperties.type. update-type-of-additional-properties breaking update-type-of-additional-properties
88 additionalProperties.type. remove-additional-properties breaking remove-additional-properties
89 additionalProperties. update-additional-props-from-false-to-true [not supported] non-breaking update-additional-props-from-false-to-true
90 additionalProperties. update-additional-props-from-true-to-false [not supported] breaking update-additional-props-from-true-to-false
91 additionalProperties. update-additional-props-from-false-to-any [not supported] non-breaking update-additional-props-from-false-to-any
92 additionalProperties. update-additional-props-from-any-to-false [not supported] breaking update-additional-props-from-any-to-false
93 additionalProperties. remove-additional-props-with-false-value [not supported] non-breaking remove-additional-props-with-false-value
94 additionalProperties. add-additional-props-with-false-value [not supported] breaking add-additional-props-with-false-value
95 additionalProperties. update-additional-props-from-false-to-some-type [not supported] non-breaking update-additional-props-from-false-to-some-type
96 additionalProperties.type. update-additional-props-from-some-type-to-false [not supported] breaking update-additional-props-from-some-type-to-false
97 oneOf add-one-of N non-breaking add-one-of
98 oneOf. [*] add-one-of-option non-breaking add-one-of-option
99 oneOf. [*] remove-one-of-option breaking remove-one-of-option
100 oneOf remove-one-of remove oneOf + one of the object inside oneOf N breaking remove-one-of
101 anyOf update-combiner-key-from-anyof-to-oneof change only combiner key [not supported] breaking update-combiner-key-from-anyof-to-oneof
102 oneOf update-combiner-key-from-oneof-to-anyof change only combiner key [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] [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] [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[] [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[] [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] [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] cases was added in scope of APIHUB-10061 [not supported] breaking update-from-empty-oneof-to-anyof-with-content
109 anyOf add-any-of non-breaking add-any-of
110 anyOf. [*] add-any-of-option non-breaking add-any-of-option
111 anyOf. [*] remove-any-of-option breaking remove-any-of-option
112 anyOf. [*] remove-any-of remove anyOf + one of the object inside anyOf breaking remove-any-of
113 .discriminator.[*] add-discriminator [NOT SUPPORTED] non-breaking ? add-discriminator
114 remove-discriminator [NOT SUPPORTED] non-breaking ? remove-discriminator
115 update-discriminator [NOT SUPPORTED] non-breaking ? update-discriminator
116 discriminator. propertyName update-discriminator-propertyName The propertyName in the discriminator is updated to point to a different property in the schema. breaking update-discriminator-propertyName
117 discriminator. mapping add-discriminator-mapping The mapping is added to the discriminator to explicitly link property values to schemas. non-breaking add-discriminator-mapping
118 remove-discriminator-mapping The mapping is removed from the discriminator, reverting to default behavior breaking remove-discriminator-mapping
119 update-discriminator-mapping The mapping is updated to point to different schemas. breaking update-discriminator-mapping
120 add-discriminator-mapping-element A new element is added to the mapping in the discriminator. non-breaking add-discriminator-mapping-element
121 remove-discriminator-mapping-element One element is removed from the mapping in the discriminator. breaking remove-discriminator-mapping-element
122 update-discriminator-mapping-element One element in the mapping is updated in the discriminator. breaking update-discriminator-mapping-element
123 allOf add-all-of add-all-of
124 allOf. [*] add-all-of-option non-breaking add-all-of-option
125 allOf. [*] remove-all-of-option breaking (breaking of functionality) remove-all-of-option
126 allOf. [*] remove-all-of remove allOf + one of the object inside allOf breaking (breaking of functionality) 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 [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) [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) [not supported] breaking ? remove-xml-name-replacement-for-schema
130 add-xml-name-replacement-for-property (default xml name the same as prop name) [not supported] breaking ? add-xml-name-replacement-for-property
131 update-xml-name-replacement-for-property [not supported] breaking ? update-xml-name-replacement-for-property
132 remove-xml-name-replacement-for-property [not supported] breaking ? remove-xml-name-replacement-for-property
133 add-attribute-with-default-value-for-xml [not supported] add-attribute-with-default-value-for-xml
134 remove-attribute-with-default-value-for-xml [not supported] remove-attribute-with-default-value-for-xml
135 mark-property-as-xml-attribute [not supported] breaking mark-property-as-xml-attribute
136 mark-property-as-xml-element [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) [not supported] 2 breaking ? add-xml-prefix-and-namespace-for-schema
138 update-xml-prefix-for-schema [not supported] breaking ? update-xml-prefix-for-schema
139 remove-xml-prefix-and-namespace-for-schema [not supported] 2 breaking ? remove-xml-prefix-and-namespace-for-schema
140 add-xml-wrapped-with-default-value-for-array-property [not supported] add-xml-wrapped-with-default-value-for-array-property
141 remove-xml-wrapped-with-default-value-for-array-property [not supported] remove-xml-wrapped-with-default-value-for-array-property
142 add-xml-wrapped-for-array-property [not supported] breaking ? add-xml-wrapped-for-array-property
143 remove-xml-wrapped-for-array-property [not supported] breaking ? remove-xml-wrapped-for-array-property