v7 ideas

[DerManoMann]

Bit early, just a place to collect ideas...

• add strong typing and null defaults to all properties and limit use of Generator::UNDEFINED to string/mixed properties only
• use symfony/console for CLI Migrate bin/openapi to Symfony Console #1977
• Split logging and error handling (CLI return value), also No output on CLI #1636
• replace static $_xxx properties on annotations with methods to allow extending?

[miken32]

I just spent the week learning more than I care to about the OpenAPI spec to document an API. One thing that would have helped make this package easier to use is more use of enums. E.g. a type parameter can only be string, number, array, object, etc. Those should be enumerated rather than just strings.

Another suggestion would be finding shortcuts that can move away from the annotations just being 1:1 mappings to OpenAPI entries. For example: properties: ['foo' => 'string'] for simple declarations, rather than properties: [new OA\Property(property: 'foo', type: 'string')]. Or schema: 'date-string' in place of schema: new OA\Schema(type: 'string', format: 'date').

[DerManoMann]

Enums are definitely a good idea although migration is definitely an issue. As a v7 item that might be doable.

Shortcuts are also good. I've been thinking about the coupling on/off also, in particular since supporting different spec versions with a single set of attributes becomes really awkward when property types change, etc...

So, all good things, thanks @miken32