microsoft / microsoft/typespec

`@opExample` custom metadata

Open
#8,633 1 comment 0 reactions 0 assignees View on GitHub
design:needed needs-area triaged:core
Dominant language
Java
Stars
5.9k
Forks
394
Avg merge
1d 23h
Merged PRs (30d)
104

Description

### Clear and concise description of the problem

I am looking to add some custom metadata to an `@opExample`, but I can't seem to find a good way to do it. For example, I am trying to do something like this:
```tsp
@opExample(#{
returnType: #{
statusCode: 200,
body: #{
...
}
}
}, #{
`x-parameter-values`: #{
id: "abc123",
fields: "summary",
},
})
```
which would result in an openapi3 emitter output of
```yaml
examples:
example0:
x-parameter-values:
id: abc123
fields: summary
value:
...
```

### Checklist

- [x] Follow our [Code of Conduct](https://github.com/microsoft/typespec/blob/main/CODE_OF_CONDUCT.md)
- [x] Read the [docs](https://typespec.io/docs/).
- [x] Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

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.