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

supporting code samples for multipart file upload #5406

Open
cwcowell opened this issue Dec 13, 2024 · 1 comment
Open

supporting code samples for multipart file upload #5406

cwcowell opened this issue Dec 13, 2024 · 1 comment
Labels
bug Issues reporting bugs. product/docs Fern Docs which builds and hosts a developer documentation site

Comments

@cwcowell
Copy link
Contributor

CLI Version (from fern.config.json)

0.46.1

Minimal API Specification

openapi: 3.0.0
info:
  title: Demo API
  version: "0.1"
paths:
  /v2/conversations:
    post:
      operationId: createConversation
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  description: Files with local file paths
                  items:
                    type: string
                    format: binary
      responses:
        '200':
          description: OK
      x-fern-examples:
        - code-samples:
            - language: curl
              code: curl https://yahoo.com/
            - language: python
              code: print("hello”)

Actual UI Behavior

There’s no dropdown to pick the language for the sample code, and the sample code provided in openapi.yaml is ignored. Fern-generated code is shown instead.

image

Expected UI Behavior

There should be a dropdown to pick the language for the sample code, and the sample code provided in openapi.yaml should be displayed.

Steps to Reproduce

Start up a docs site with this openapi.yaml and visit the API reference page for Conversations/post.

Environment Details

Chrome 131, Safari 18.1.1, macOS 15.1

@cwcowell cwcowell added bug Issues reporting bugs. product/docs Fern Docs which builds and hosts a developer documentation site labels Dec 13, 2024
@cwcowell
Copy link
Contributor Author

This is a high-priority issue for us, since we rely on hand-written, heavily commented SDK sample code in the API reference pages to serve as the main reference material for our SDK.

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