Creating tag descriptions

[dryan-cais]

First off thanks for the development effort!

We are current accessing Typespec as a means of better managing our 9000 line OpenAPI spec. It is looking very promising but we are missing the ability to add tag descriptions in the top level tags section. I don't think we will be able to move over to Typespec if it cannot generate our current schema.

I had a look at the code, and it doesn't look like this is currently supported? Is this on the roadmap? I wouldn't mind having a go at producing a PR, but I fear I might need some advice to get started as I am both unfamiliar with the codebase, and haven't programmed in TS recently. If someone can point me in the right direction in regards what files need to change, then I can give it a go.

Thanks again.

[timotheeguerin]

We’ve had this issue on the backlog for a while feel free to thumbs up, it has been helpful to see what the community wants to see prioritized
#2220

the proposal in there with ‘@tagMetadata decorator is probably a good approach for contributions too

[dryan-cais]

That's awesome! Sorry I did try to search for any outstanding issues but didn't see this. Once we have completed moving over to Typespec, i'll try and create a PR for this.

[pschaeflein]

I can see that the @tagMetadata decorator is shipped. The OpenApi emitter processes it as expected.

However, the tsp compiler (and the language service in VSCode) reports an error. Is there an example/sample that I haven't found?

[timotheeguerin]

@pschaeflein just in case but did you try restarting the vscode extension/vscode itself?

And do you know which version of the openapi package you are using?

[pschaeflein]

restarting the vscode extension/vscode itself?

Not sure what you mean...

which version of the openapi package you are using?

The package.json in node_modules/@typespec/openapi has version 0.64.0 (Is that what you're asking?)

[timotheeguerin]

The package.json in node_modules/@typespec/openapi has version 0.64.0 (Is that what you're asking?)

yes, so most likely not the issue

restarting the vscode extension/vscode itself?

Did you try restarting VSCode? Or the reloading the TypeSpec language server CtrlOrCmd+shift+p > Restart TypeSpec Language Server

[pschaeflein]

Just restarted. Did not resolve.

[RodgeFu]

Thanks for the feedback, @pschaeflein . The error in vscode is not expected. We will investigate into the error in vscode and get back to you. thanks.