Skip to navigation
OpenRPCExtensions

API Explorer control

View as Markdown

The API Explorer is enabled by default for every method. Set x-fern-explorer: false at the document root to hide the Playground for all methods, and override it on individual methods; a method’s own value takes precedence. Non-boolean values are reported as errors when importing the specification.

openrpc.yml
openrpc: 1.2.4
info:
  title: Plant Store API
  version: 1.0.0
x-fern-explorer: false  # Disable the Explorer for all methods
servers:
  - url: https://api.example.com/rpc
methods:
  - name: plant_get
    x-fern-explorer: true  # Enable the Explorer for this method
    params:
      - name: plantId
        required: true
        schema:
          type: string
    result:
      name: plant
      schema:
        type: object
        properties:
          plantId:
            type: string
  - name: plant_delete  # Remains disabled (document-level value applies)
    params:
      - name: plantId
        required: true
        schema:
          type: string
    result:
      name: success
      schema:
        type: boolean