Skip to content

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

@thegagne

Description

@thegagne

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:

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

But the REST Framework has not implemented this.

Checklist

  • Follow our Code of Conduct
  • Read the docs.
  • Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions