microsoft / microsoft/typespec

[rest] Include Resource name in @doc when using TypeSpec.Rest.Resource.ResourceOperations

Open
#5,328 0 comments 0 reactions 0 assignees View on GitHub
feature lib:rest 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 noticed in the playground using the REST Framework that the descriptions are not Resource specific.

For example:

```
description: Lists all instances of the resource.
```

When I would expect that it would say:

```
description: Lists all instances of Widget.
```

After some digging, I found out that you can pass in the Resource into @doc to provide this functionality:

```tsp
@doc("Lists all instances of {name}.", Resource)
```

But the REST Framework has not implemented this.

### 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.