Fix documentation of additionalProperties field when used with array parameters

[magni-]

This currently produces invalid Swagger:

params do
  optional :array_param, type: Array, documentation: { additional_properties: true } do
    requires :nested_param
  end
end

I took the liberty of renaming additionalProperties to additional_properties (and deprecating the former) to have consistent casing.

[LeFnord]

Thanks for it @magni-

but please, can you add a note to the UPGRADE.md and add documentation of it to the README.md

[magni-]

@LeFnord While working on adding documentation for this, I realized this will need more changes: OAS 2.0 does not support additionalProperties: true. Is there a helper in the specs to ensure the generated JSON is valid OAS 2.0? I couldn't find one.

edit: Or maybe it's fine? Testing at https://apitools.dev/swagger-parser/online/, the following is supposedly valid

{
  "info": {
    "title": "title",
    "version": "1"
  },
  "swagger": "2.0",
  "paths": {
    "/foos": {
      "post": {
        "parameters": [
          {
            "in": "body",
            "name": "foo",
            "schema": {
              "$ref": "#/definitions/Foo"
            },
            "required": true
          }
        ],
        "responses": {
          "201": {
            "description": "desc"
          }
        },
        "operationId": "post-foos"
      }
    }
  },
  "definitions": {
    "Foo": {
      "type": "object",
      "additionalProperties": true
    }
  }
}

[magni-]

I've added documentation to the README and instructions regarding the deprecation to UPGRADING. I assumed the next version would be 1.4.1 because these are just fixes and the deprecation isn't a breaking change (yet).

I also updated the logic so that it behaves more like the rest of grape/grape-swagger: you can now pass in classes such as String, Integer, etc, or entity classes, and it will set the appropriate additionalProperties hash for you. If you pass in anything else, it'll get passed through as-is, (this is the current behavior).

[LeFnord]

wow, great work, thank you @magni- … will release it in the next days

[magni-]

I just noticed 1.4.1 is already out, UPGRADING should mention 1.4.2 instead 🤦🏼

Thanks for getting those fixes out @LeFnord ! Could you also release a new version of grape-entity while you're at it? 🙏🏼

[LeFnord]

done