Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lists are rendered incorrectly in error response descriptions #5368

Open
hkosova opened this issue Dec 9, 2024 · 0 comments
Open

Lists are rendered incorrectly in error response descriptions #5368

hkosova opened this issue Dec 9, 2024 · 0 comments
Labels
bug Issues reporting bugs. product/docs Fern Docs which builds and hosts a developer documentation site

Comments

@hkosova
Copy link

hkosova commented Dec 9, 2024

CLI Version (from fern.config.json)

0.45.0 (didn't check other versions)

Minimal API Specification

Docs must be configured with display-errors: true.

openapi: 3.1.0
info:
  title: Response descriptions
  version: 1.0.0

paths:
  /foo:
    get:
      summary: Get foo
      responses:
        '200':
          description: >-
            A successful response returns:

             * Thing 1
             * Thing 2
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Foo'
        '400':
          description: >-
            Possible reasons:

             * Reason 1
             * Reason 2
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Foo'

components:
  schemas:
    Foo:
      type: object

Actual UI Behavior

If the description of an error response contains a list, this list is rendered without bullets.

The issue affects only error responses and does not affect 2xx responses.

Expected UI Behavior

Markdown lists are rendered correctly in all parts of the API reference.

Steps to Reproduce

  1. Create a sample Fern docs project.
  2. Replace the OpenAPI spec with the provided one.
  3. Add display-errors: true to docs.yml.
  4. Run fern docs dev.
  5. Navigate to the API reference and expand the error response.

Environment Details

Chrome, Safari on macOS 15

@hkosova hkosova added bug Issues reporting bugs. product/docs Fern Docs which builds and hosts a developer documentation site labels Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issues reporting bugs. product/docs Fern Docs which builds and hosts a developer documentation site
Development

No branches or pull requests

1 participant