Why `additionalProperties` is the way to represent Dictionary/Map in Swagger/OpenAPI 2.0
Chen, I think your answer is correct.
Some further background that might be helpful:
In JavaScript, which was the original context for JSON, an object is like a hash map of strings to values, where some values are data, others are functions. You can think of each name-value pair as a property. But JavaScript doesn't have classes, so the property names are not predefined, and each object can have its own independent set of properties.
JSON Schema uses the properties
keyword to validate name-value pairs that are known in advance; and uses additionalProperties
(or patternProperties
, not supported in OpenAPI 2.0) to validate properties that are not known.
For clarity:
- The property names, or "keys" in the map, must be strings. They cannot be numbers, or any other value.
- As you said, the property names should be unique. Unfortunately the JSON spec doesn't strictly require uniqueness, but uniqueness is recommended, and expected by most JSON implementations. More background here.
properties
andadditionalProperties
can be used alone or in combination. When additionalProperties is used alone, without properties, the object essentially functions as amap<string, T>
where T is the type described in the additionalProperties sub-schema. Maybe that helps to answer your original question.- When evaluating an object against a single schema, if a property name matches one of those specified in
properties
, its value only needs to be valid against the sub-schema provided for that property. TheadditionalProperties
sub-schema, if provided, will only be used to validate properties that are not included in theproperties
map. - There are some limitations of
additionalProperties
as implemented in Swagger's core Java libraries. I've documented these limitations here.
First thing, I found a better explanation for additionalProperties
:
For an object, if this is given, in addition to the properties defined in
properties
all other property names are allowed. Their values must each match the schema object given here. If this is not given, no other properties than those defined inproperties
are allowed.
So here is how I finally understood this:
Using properties
, we can define a known set of properties similar to Python's namedtuple, however if we wish to have something more like Python's dict, or any other hash/map where we can't specify how many keys there are nor what they are in advance, we should use additionalProperties
.
additionalProperties
will match any property name (that will act as the dict
's key, and the $ref
or type
will be the schema of the dict
's value, and since there should not be more than one properties with the same name for every given object, we will get the enforcement of unique keys.
Note that unlike Python's dict
that accepts any immutable value as a key, since the keys here are in essence property names, they must be strings. (Thanks Ted Epstein for that clarification). This limitation can be tracked down to pair := string : value
in the json specification.