search

orval-labs / orval

orval is able to generate client with appropriate type-signatures (TypeScript) from any valid OpenAPI v3 or Swagger v2 specification, either in yaml or json formats. 🍺
https://orval.dev
MIT License
3.18k stars 336 forks source link

feat: generate API as `TypeDoc` docs #1705

Closed huwshimi closed 3 days ago

huwshimi commented 1 week ago

Status

READY

Description

Generate docs from the output using TypeDoc.

Fixes: #773.

Related PRs

List related PRs against other branches:

branch PR
other_pr_production [link]()
other_pr_master [link]()

Todos

Steps to Test or Reproduce

Outline the steps to test or reproduce the PR here.

> git pull --prune
> git checkout <branch>
> grunt jasmine
  1. Open the orval.config.ts for an example and add docs: true, to the output object.
  2. Run yarn generate-api.
  3. The markdown docs should get built alongside the API files.
soartec-lab commented 1 week ago

sounds good! I'll try this later.

soartec-lab commented 4 days ago

@huwshimi The test has failed due to the release of v7.3.0. Can I rebase it? I'll do this as soon as I can see that.

huwshimi commented 3 days ago

@soartec-lab I rebased and fixed the merge conflict. Tests are passing now.