fern icon indicating copy to clipboard operation
fern copied to clipboard

[Bug] Frustrating error message when running fern generate --docs

Open alexrejto opened this issue 1 year ago • 0 comments

Describe the Bug

I was trying to try out the docs page. But, because I have two apis in an apis/ directory, I got an unfriendly error like Cannot find api referenced in API Reference. But there was no mention of the ability to set an api-name on that object.

I needed to do this

  - api: API Reference
    api-name: public-api

Information to Reproduce

CLI Version

The version of the Fern CLI you are using (found in fern.config.json).

Actual Behavior

The buggy behavior that is produced.

Expected Behavior

What you wanted to happen. Please share a preview link or screenshot of the expected behavior.

API Definition (if relevant)

The minimal OpenAPI specification or Fern definition required to reproduce the bug.

types:
  Pet:
    name: string
    age: double

Additional Context

Add any other context about the problem here.

alexrejto avatar Apr 13 '24 00:04 alexrejto