Discussions

Ask a Question
Back to All

Unable to render endpoints that $ref a file that has already been $ref by another endpoint

We've recently started to use readme.io, and we've run into a problem. It seems that readme.io is unable to render endpoints that include a parameters section that $ref a file that has already been $ref before.

When viewing pages for any endpoint that matches the above criteria, the page will show the error code ERR-JUAMVC with a message: "This reference guide is currently experiencing difficulties and will be back online shortly."

A truncated version of our YML file:

  '/users/{id}':
    put:
      parameters:
        $ref: common/users/uid.yml
      requestBody:
        required: true
        content:
          application/json:
            $ref: common/users/update.yml

  '/users/{id}/resources':
    post:
      parameters:
        $ref: common/users/uid.yml
      requestBody:
        content:
          application/json:
            $ref: common/users/create_resources.yml

In the case above, the file common/users/uid.yml is referenced inside two endpoints. The page for PUT /users/{id} renders successfully, but POST /users/{id}/resourcesfails to do so.

We've tried to use redocly to render the same above YAML file and it works without issues, and rdme openapi:validate also returns no error.

Could you help check what could be the cause of this issue?