microsoft / microsoft/typespec

Support operation links in OpenAPI3 generator

Open
#713 1 comment 2 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
5.9k
Forks
394
Avg merge
1d 23h
Merged PRs (30d)
104

Description

This is to support paging and lro scenarios in OpenAPI 3.
- move OperationLink decorator into the core or core http library
- When emitting an operation in OpenAPI3, use the OperationLink accessor to get operation link details and transform into OpenAPI3.
- emit the link name and description (corresponding to the name passed to '@operationLink')
- The parameter / property maps in operation link decorators will need o be translated to request and response properties per openAPI3 rules when emitting link decorators:
- `RequestParameter<"paramName">` -> `$request.`
- `ResponseProperty<"propertyName">` -> `$response.`
- location specifiers include:
- `@header` -> `header.`
- `@path` -> `path.`
- `@query` -> `query.`
- body property -> `.body/#`

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.