Add support for maps based on additionalProperties field

[austinvalle]

Context

RFC: https://docs.google.com/document/d/15PJokoO7mkMYsc2Z7DN1copykQgH5Kt7nnzb-mcNcTo/edit#heading=h.4syvri1n60bk

References:

• https://json-schema.org/understanding-json-schema/reference/object.html#additional-properties
• https://spec.openapis.org/oas/v3.1.0#model-with-map-dictionary-properties
• https://swagger.io/docs/specification/data-models/dictionaries/

This PR adds support for:

• MapNestedAttribute
• MapAttribute
• MapType (only possible under a collection type, ListAttribute, SetAttribute, or MapAttribute)

I also added documentation to the design doc and added unit/integration tests to cover since this there aren't any use-cases in existing OAS tests.

Details

additionalProperties indicates that key names in a schema can be any string, with a value defined by the schema defined in additionalProperties.type.

Examples

This works for simple maps that have primitive element types (MapAttribute)

// Keys can be any string, value can be any string (map of strings)
{
  "type": "object",
  "additionalProperties": { 
    "type": "string" 
  }
}

This also works for more complex maps that have objects (MapNestedAttribute)

// Keys can be any string, value can be an object that matches the schema
{
  "type": "object",
  "additionalProperties": { 
    "type": "object",
    "properties": {
        // ... define object for value of map
    }
  }
}

Finally, it can also exist as a MapType in an array:

// Array with items, keys can be any string, value can be any string (map of strings)
{
  "type": "array",
  "items": {
    "type": "object"
    "additionalProperties": {
      "type": "string"
    }
  }
}

I wrote integration tests to cover this specific functionality as the existing OAS do not cover this use-case 👍🏻

Notes:

• It's worth noting that the usage of additionalProperties will override any existing properties that are set. In JSON schema, additionalProperties is "in addition" to the defined properties, however we cannot represent that in a TF Plugin Framework schema.
• This override will only happen if a schema is provided in additionalProperties, if additionalProperties: false is found (indicating that NO additional properties are allowed), it will treat the schema like an object.

[bflad]

This seems reasonable to me 🚀 We can always have our own configuration/annotations if the additionalProperties data model does not work in practice.

[bendbennett]

LGTM 🎸

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.