v4

[erunion]

Added

• OpenAPI compilation support. Create an OAI 3.0 generator #16
• A new @api-vendortag annotation, replacing @api-capability. @api-vendorTag #148
• @api-maxversion. Same as @api-minversion, but the opposite. @api-maxversion #161
• Added additional relevant data to request parameters in JSON-generated changelogs. Nested parameters in JSON changelogs are missing supplementary data attributes #107
• Support for subtypes to @api-param. Parameters don't support subtypes #159
• A new @api-queryparam annotation for documenting parameters that are to be used in query strings. @api-param now represents body payloads. Denoting the payload format for an API parameter #109
• New configurations: authentication, info and servers OpenAPI fixes #173

Changed

• The generate command is now called compile. Create an OAI 3.0 generator #16
• Renamed @api-throws to @api-error. Rename @api-throws to @api-error #141
• @api-error annotations now have a new MSON syntax. Moving @api-error over to a MSON-like syntax. #155
• @api-uri is now @api-path. Simplified pathing #162
• @api-urisegment is now @api-pathparam. Simplified pathing #162
• The scopes config is now nested within authentication. OpenAPI fixes #173
• The generators config is now called compilers. Create an OAI 3.0 generator #16

Fixed

• Now throwing an exception when enum annotations (annotations with member values) are written as string. Representation data that's a string, but with members doesn't get recognized as an enum #150
• Subtypes are now being properly converted to API Blueprint-compatible types during API Blueprint compilation. Parameter subtypes aren't being converted to Blueprint-compatible types #147
• Scopes are now passed down through @api-see annotations, much like @api-version is already. Scope not applied to @api-see annotations #140
• Multi-line enum descriptions are now supported. Multi-line enum descriptions fail #160
• Non-aliased paths can no longer be selected as the primary path for a resource action. Action URI checking isn't quite right #139

Removed

• @api-capability has been removed and replaced with a new @api-vendorTag system. @api-vendorTag #148