microsoft / microsoft/typespec

Add a `api-version-parameter-strategy` option to openapi3 emitter

Open
#7,935 1 comment 0 reactions 0 assignees View on GitHub
emitter:openapi3 feature triaged:core
Dominant language
Java
Stars
5.9k
Forks
394
Avg merge
1d 23h
Merged PRs (30d)
104

Description

From design https://github.com/microsoft/typespec/issues/2819

```yaml
options:
@typespec/openapi3:
api-version-parameter: "flatten"
```

```tsp
@versioned(Versions)
@server("https://my-domain.com/api/{version}", "Main entry point", {version: Versions})
namespace MyNS;

enum Versions {v1, v2}
```

So it produce this
```
#--- v1.yaml
servers:
- url: https://my-domain.com/api/v1"
description: Main entry point
#--- v2.yaml
servers:
- url: https://my-domain.com/api/v2"
description: Main entry point
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.