feat(cli): Add OpenAPI tree-shaking setting #5168

amckinney · 2024-11-13T01:16:29Z

This adds the only-include-referenced-schemas setting to implement OpenAPI tree shaking for endpoints, webhooks, and websocket channels.

Users can opt-in with the following configuration:

# generators.yml
api:
  specs:
    - openapi: ../openapi.yml
      settings:
        only-include-referenced-schemas: true

github-actions · 2024-11-13T01:19:18Z

packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts

amckinney added 5 commits November 12, 2024 18:04

feat(cli): Add endpoint tree-shaking

13688c0

Update to 'only-include-referenced-schemas'

e4c4ca2

Add only-include-referenced-schemas test definition

8707aa1

Update only-include-referenced-schemas snapshot

f0b1aa6

Add tree-shaking support for webhooks and channels

4b6c52e

amckinney requested a review from dsinghvi as a code owner November 13, 2024 01:16

amckinney commented Nov 13, 2024

View reviewed changes

packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts Outdated Show resolved Hide resolved

Run 'pnpm jsonschema'

99860a4

dsinghvi approved these changes Nov 13, 2024

View reviewed changes

amckinney added 2 commits November 13, 2024 12:43

Refactor with State enum

3de3b60

Clear up control flow with getSchemaIdsToExclude helper function

3be530f

amckinney merged commit 44ac642 into main Nov 13, 2024
59 checks passed

amckinney deleted the amckinney/cli/tree-shaking branch November 13, 2024 19:14

Provide feedback