microsoft / microsoft/typespec

[Bug]: missing `@list` decorator in TypeSpec.Rest.Resource list operation template

Open
#5,740 2 comments 0 reactions 0 assignees View on GitHub
bug lib:rest triaged:core
Dominant language
Java
Stars
5.9k
Forks
394
Avg merge
1d 23h
Merged PRs (30d)
104

Description

### Describe the bug

The list operation template in TypeSpec.Rest.Resource does not have `@list` decorator.
https://github.com/microsoft/typespec/blob/typespec%400.64.0/packages/rest/lib/resource.tsp#L248-L259

Therefore, TCGC will not take this as a pageable API in client.

I am not sure which is the exact solution. Add the `@list` into the template; or make the `@listsResource` decorator adds `@list` within itself.

### Reproduction

e2e petstore
https://github.com/allenjzhang/typespec-e2e-demo/blob/main/petstore/spec/main.tsp#L69

or playground
https://cadlplayground.z22.web.core.windows.net/cadl-azure/?c=aW1wb3J0ICJAdHlwZXNwZWMvcmVzdCI7CtIZb3BlbmFwaSI7Cgp1c2luZyBUeXBlU3BlYy5IdHRwO9AVUmVzdNUVxAVvdXJjZTsKCkBzZXJ2aWNlKHsKICB0aXRsZTogIlBldCBTdG9yZSBTxh4iLAp9KQpuYW1lc3BhY2UgUGV0xSDEQWVycm9yCm1vZGVsyRhFxBQgxFNjb2RlOiBpbnQzMjsKICBtZXNzYWdlOiBzdHJpbmc7Cn0KCkBy5wCPKCJwZXRzIinKTcVDQGtlecUbSWQiKQogIGlkyVEKICDkAJXKTyAgdGFnP8oQxD9taW5WYWx1ZSgwxD5AbWF4xg8yxRDlAI7KT293bmVyScZiNjTlAKBpbnRlcmbnAPdzIGV4dGVuZHMg6AFFT3BlcmF0aW9uczxQZXQs7gEEPiB7fQoKLy8gaWYgd2UgZW5hYmxlIHRoZSBsaW5lIGJlbG93LMQQcmUgd291bGTEDG4gYmUgYSBraW5kPSJwYWdpbmciIG1ldGhvZCBpbiBUQ0dDxFNAQGxpc3Qo9gHbyQlMaXN0LsQpKTsK&e=%40azure-tools%2Ftypespec-client-generator-core&options=%7B%7D

### Checklist

- [x] Follow our [Code of Conduct](https://github.com/microsoft/typespec/blob/main/CODE_OF_CONDUCT.md)
- [x] Check that there isn't already an issue that request the same bug to avoid creating a duplicate.
- [x] Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/Microsoft/typespec/discussions).
- [x] The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.

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.