generators.yml Configuration Schema

1
# Example generators.yml configuration
2
api:
3
  specs:
4
    - openapi: "./openapi.yml"
5
      namespace: "v1"
6
      settings:
7
        title-as-schema-name: true
8
        inline-path-parameters: false
9
        respect-forward-compatible-enums: true
10
11
whitelabel:
12
  github:
13
    username: "my-org"
14
    email: "sdk@mycompany.com"
15
    token: "ghp_xxxxxxxxxxxx"
16
17
metadata:
18
  description: "Official SDK for MyAPI"
19
  authors:
20
    - name: "SDK Team"
21
      email: "sdk@mycompany.com"
22
23
readme:
24
  introduction: "Welcome to the MyAPI SDK"
25
  apiReferenceLink: "https://docs.myapi.com"
26
  defaultEndpoint:
27
    method: "GET"
28
    path: "/users"
29
  features:
30
    authentication:
31
      - "POST /auth/login"
32
      - "GET /auth/profile"
33
    users:
34
      - "GET /users"
35
      - "POST /users"
36
37
default-group: "production"
38
39
groups:
40
  production:
41
    generators:
42
      - name: fernapi/fern-typescript-node-sdk
43
        version: 0.9.0
44
      - name: fernapi/fern-python-sdk
45
        version: 2.0.0

1
api:
2
  specs:
3
    - openapi: "./openapi.yml"
4
      namespace: "v1"
5
      settings:
6
        title-as-schema-name: true
7
        inline-path-parameters: false

1
api:
2
  specs:
3
    - openapi: "./openapi.yml"
4
      namespace: "v1"
5
      settings:
6
        title-as-schema-name: true
7
        inline-path-parameters: false
8
    - asyncapi: "./events.yml"
9
      namespace: "events"
10
  headers:
11
    Authorization: "Bearer ${API_TOKEN}"
12
  environments:
13
    production: "https://api.prod.com"
14
    staging: "https://api.staging.com"

1
api:
2
  specs:
3
    - openapi: "./openapi.yml"
4
      origin: "https://api.example.com/openapi.json"
5
      overrides: "./openapi-overrides.yml"
6
      namespace: "v1"
7
      settings:
8
        title-as-schema-name: true
9
        inline-path-parameters: false
10
        prefer-undiscriminated-unions-with-literals: true
11
        filter:
12
          endpoints: ["POST /users", "GET /users/{id}"]
13
        example-generation:
14
          request:
15
            max-depth: 2

1
api:
2
  specs:
3
    - asyncapi: "./asyncapi.yml"
4
      origin: "https://api.example.com/asyncapi.json"
5
      overrides: "./asyncapi-overrides.yml"
6
      namespace: "events"
7
      settings:
8
        message-naming: "v2"
9
        title-as-schema-name: false
10
        respect-nullable-schemas: true

1
api:
2
  specs:
3
    - proto:
4
        root: "./proto"
5
        target: "proto/service/v1/service.proto"
6
        local-generation: true

1
api:
2
  specs:
3
    conjure: "./conjure-api.yml"

1
whitelabel:
2
  github:
3
    username: "my-github-username"
4
    email: "my-email@example.com"
5
    token: "ghp_xxxxxxxxxxxx"

1
metadata:
2
  description: "My API SDK"
3
  authors:
4
    - name: "John Doe"
5
      email: "john@example.com"
6
    - name: "Jane Smith"
7
      email: "jane@example.com"

1
readme:
2
  bannerLink: "https://example.com/banner"
3
  introduction: "Welcome to our API"
4
  apiReferenceLink: "https://docs.example.com"
5
  defaultEndpoint:
6
    method: "POST"
7
    path: "/users"
8
    stream: false
9
  features:
10
    authentication:
11
      - method: "POST"
12
        path: "/auth/login"
13
      - "GET /auth/profile"
14
    users:
15
      - method: "GET"
16
        path: "/users"
17
      - method: "POST"
18
        path: "/users"

1
default-group: "production"

1
groups:
2
  production:
3
    audiences: ["external"]
4
    generators:
5
      - name: fernapi/fern-typescript-node-sdk
6
        version: 0.9.0
7
        output:
8
          location: npm
9
          package-name: "@myorg/api-sdk"
10
          token: "${NPM_TOKEN}"
11
        github:
12
          repository: "myorg/typescript-sdk"
13
          mode: "release"
14
        config:
15
          clientName: "MyApiClient"
16
          packageName: "@myorg/api-sdk"
17
        metadata:
18
          package-description: "Official TypeScript SDK"
19
          author: "MyOrg SDK Team"
20
        keywords: ["CustomKeyword"]
21
        snippets:
22
          path: "./snippets"
23
        smart-casing: true
24
        api:
25
          settings:
26
            inline-path-parameters: true
27
      - name: fernapi/fern-python-sdk
28
        version: 2.0.0
29
        output:
30
          location: pypi
31
          package-name: "myorg-api-sdk"
32
          token: "${PYPI_TOKEN}"
33
          metadata:
34
            keywords: ["api", "sdk"]
35
            documentation-link: "https://docs.myorg.com"
36
    metadata:
37
      description: "Production SDKs for MyAPI"
38
      authors:
39
        - name: "SDK Team"
40
          email: "sdk@myorg.com"
41
    reviewers:
42
      teams:
43
        - name: "sdk-team"
44
      users:
45
        - name: "john-doe"

1
reviewers:
2
  teams:
3
    - name: "sdk-team"
4
    - name: "api-team"
5
  users:
6
    - name: "john-doe"
7
    - name: "jane-smith"