Feature clarification request: multiple schemas about openapi-typescript HOT 5 OPEN

Ah if you’re looking to bundle schemas, then you should use the Redocly CLI bundle command. That needs to be run before openapi-typescript.

I’d welcome an addition to the docs that clarifies this (perhaps something like a tip added):

::: tip

This will preserve schemas 1:1 input:output. To bundle multiple schemas into one, use Redocly’s [bundle command](https://redocly.com/docs/resources/multi-file-definitions/#bundle)

:::

Feel free to adjust the wording 🙂

from openapi-typescript.

On the same topic what if we have:

• reference.json - which contains $defs
• openapi.yaml file that references the defs from the reference.json file

Is it possible to make it work? I don't see an example of this use case in the docs.

from openapi-typescript.

@drwpow Thanks for your response. In particular your call out that This will preserve schemas 1:1 input:output suggests to me that the existing documentation example should be updated in the following way:

Current

apis:
  core@v2:
    root: ./openapi/openapi.yaml
    x-openapi-ts:
      output: ./openapi/openapi.ts
  external@v1:
    root: ./openapi/external.yaml
    x-openapi-ts:
      output: ./openapi/openapi.ts

Updated

apis:
  core@v2:
    root: ./openapi/openapi.yaml
    x-openapi-ts:
      output: ./openapi/openapi.ts
  external@v1:
    root: ./openapi/external.yaml
    x-openapi-ts:
      output: ./openapi/external.ts  # note updated name

Does this make sense to you, or am I still confused on how this is meant to work?

from openapi-typescript.

@melissag yes! Apologies for not even noticing the typo in the docs. Yes that’s confusing, and your proposal is exactly how it should work. Would welcome a PR if you have time!

from openapi-typescript.

Done, thanks for the guidance! Let me know if I goofed on anything in the PR process, not super familiar.

from openapi-typescript.