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

LLMs.txt lists all API query parameter names in CamelCase #5689

Open
hkosova opened this issue Jan 21, 2025 · 0 comments
Open

LLMs.txt lists all API query parameter names in CamelCase #5689

hkosova opened this issue Jan 21, 2025 · 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 Jan 21, 2025

CLI Version (from fern.config.json)

0.50.13, also 0.46.22

Minimal API Specification

openapi: 3.1.0
info:
  title: LLMs.txt issues
  version: 1.0.0
servers:
  - url: https://example.com/v1

paths:
  /something:
    get:
      summary: Get something
      parameters:
        - in: query
          name: type
          schema:
            type: string
        - in: query
          name: id__in
          schema:
            type: string
      responses:
        '200':
          description: OK

Actual UI Behavior

When you view the .mdx page for an API endpoint or view <site>/llms-full.txt, the names of API query parameters in those files are specified in CamelCase.

For example, Fern generates the following .mdx for the OpenAPI spec provided above. Note the query parameter names are different from the names in the spec.

# Get something

`` `http
GET https://example.com/v1/something
`` `



## Query Parameters

- Type (optional)
- IdIn (optional)

## Examples

`` `shell
curl https://example.com/v1/something
`` `

Expected UI Behavior

Query parameter names in .mdx and /llms-full.txt are correct and are the same as defined in the OpenAPI spec.

## Query Parameters

- type (optional)
- id__in (optional)

Steps to Reproduce

  1. Create a docs project with the OpenAPI spec provided above.
  2. Publish the docs.
  3. Open the page for the GET /something endpoint and append .mdx to the page address.
  4. Check the query parameter names.

Environment Details

Node 22

@hkosova hkosova added bug Issues reporting bugs. product/docs Fern Docs which builds and hosts a developer documentation site labels Jan 21, 2025
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