Do SmartDocs support importing JSON Refs or YAML Refs?

Not applicable

Hi all,

In SmartDocs, I was expecting to see headers and parameters (Authorization, apikey, include, where, etc.) specified in external yaml files. However, none of these parameters are displayed.

Am I missing anything? Or does it mean that I'll need to assemble all references into a single before importing into SmartDocs?

1807-smartdocs-missing-params.png

My swagger.yaml file looks like this:

paths:
  /orgs:
    get:
      produces:
        - "application/json; charset=utf-8"
      responses:
        200:
          $ref: "orgs_200_response.yaml"
      parameters:
        -
          $ref: "security_params.yaml#/apikey"
        -
          $ref: "security_params.yaml#/header"
        -
          $ref: "security_params.yaml#/limit"
        -
          $ref: "security_params.yaml#/where"
        -
          $ref: "security_params.yaml#/stacktrace"
        -
          $ref: "security_params.yaml#/describe"
        -
          $ref: "security_params.yaml#/attributes"
        -
          $ref: "security_params.yaml#/include"

security_params.yaml looks like this:

apikey:
  in: "query"
  name: "apikey"
  type: "string"
  required: true
  default: "XXXXXXXX"
header:
  in: "header"
  name: "Authorization"
  required: true
  type: "string"

Swagger-UI figures out the references correctly:

1805-swagger-ui-parameters.png

Thanks!

1 0 286
0 REPLIES 0