Implement display and DSLDoc modeling modifications to the Relax module

Description

Update the core resource() functions to accept arguments that represent some missing OpenAPI spec variables and modify the HTML output to reflect a new standardized documentation flow. Add an additional argument to the resource() method to accept a JSON representation of the resource in OpenAPI format.

The OpenAPI Spec provides a more descriptive hierarchical model for API's. It is the model used by Swagger and is accepted by Apiary.io., in addition to their blueprint

The current definition modeling for Relax is:

With the OpenAPI Spec, the hierarchy is more descriptive:

The HTML DSL Doc will display more descriptively, with flow and interaction similar to that used by APIary.io, but including the current Coldbox information:

Activity

Show:
Luis Majano
January 20, 2016, 3:11 AM

Jon, isn't this more for Relax than ColdBox though?

Jon Clausen
January 20, 2016, 3:12 AM

Brad asked me to put it up here for now, since there's no Relax project. He said he'd move it over once one was created.

Brad Wood
January 20, 2016, 3:14 AM

I admit, it's all true! And I would have gotten away with it, if it weren't for those meddling kids.

Jon Clausen
January 20, 2016, 3:17 AM

Scooooooby snack?!?

Luis Majano
January 20, 2016, 3:29 AM

Ok, moved

Fixed

Assignee

Jon Clausen

Reporter

Jon Clausen

Labels

None

Components

Fix versions

Priority

Minor

Epic Name

Update Relax for OpenAPI Spec