add examples to the API specs

[onthebreeze]

API docs like http://ausdigital.org/specs/ausdigital-dcp/1.0/api are nice but seem to be missing important information about the request/response body.

Need to add examples - something like https://jexhson.github.io/jekyll-swagger/example-1.html

[kshychko]

@webilhan , could you please adjust the layout for a box with an example?

[webilhan]

@kshychko Layout adjusted please check.

[kshychko]

@webilhan , thanks! Looks OK now!

[kshychko]

@webilhan , please add a render of example property which is located in the request parameter. So if the request parameter has "example" property, render its value. For responses it is a text, but for requests it is JSON object, although should be treated as a text.

Example below:

"keyDetailPost": {
      "properties": {
        "pubKey": {
          "type": "string"
        },
        "revoked": {
          "type": "string",
          "format": "date-time"
        },
        "fingerprint": {
          "type": "string"
        }
      },
      "example": {
        "published": "2017-04-11T13:58:37.058Z",
        "keyid": "string",
        "pubKey": "string",
        "revoked": "2017-04-11T13:58:37.058Z",
        "fingerprint": "string"
      }
    }

[webilhan]

@kshychko Render of example property in the request parameter has been added.

[kshychko]

thanks! works well! Could you please also check why tags are not shown for the three of five methods in DCL spec - http://ausdigital.org/specs/ausdigital-dcl/1.0/api#

[webilhan]

@kshychko Tags showing fixed.

[kshychko]

verified as fixed, thanks!

[kshychko]

tags are now being duplicated: http://ausdigital.org/specs/ausdigital-dcp/1.0/api

[webilhan]

@kshychko Fixed.

[kshychko]

verified as fixed