# yaml-language-server: $schema=https://raw.githubusercontent.com/fern-api/fern/main/fern.schema.json

imports:
  errors: ./errors.yml

service:
  auth: false
  base-path: ""
  endpoints:
    getWithBasicAuth:
      auth: true
      docs: GET request with basic auth scheme
      path: /basic-auth
      method: GET
      response:
        boolean
        # headers:
        #   WWW-Authenticate: optional<string> # Specifies which auth scheme to use if CustomAuthScheme was not applied
        # body:
        #   success: boolean
      errors:
        - errors.UnauthorizedRequest

    postWithBasicAuth:
      auth: true
      docs: POST request with basic auth scheme
      path: /basic-auth
      method: POST
      request:
        name: PostWithBasicAuth
        body: unknown
      response: boolean
      errors:
        - errors.UnauthorizedRequest
        - errors.BadRequest