search

domaindrivendev / Swashbuckle.AspNetCore

Swagger tools for documenting API's built on ASP.NET Core
MIT License
5.22k stars 1.31k forks source link

[Bug]: 6.6.2 doesn't accept Assembly in the param in IncludeXmlComments #2935

Open janzenz opened 4 months ago

janzenz commented 4 months ago

Describe the bug

According to the documentation here: https://github.com/domaindrivendev/Swashbuckle.AspNetCore?tab=readme-ov-file#include-descriptions-from-xml-comments

IncludeXmlComments should accept Assembly as a parameter but in the latest version 6.6.2 as of this writing isn't exposing this new method.

Expected behavior

IncludeXmlComments should accept Assembly as param as mentioned in the instructions.

Actual behavior

It doesn't accept Assembly and the IDE complains that this method doesn't have this override.

Steps to reproduce

Exception(s) (if any)

No response

Swashbuckle.AspNetCore version

6.6.2

.NET Version

8.0

Anything else?

No response

martincostello commented 3 months ago

@leotsarev Could you do a PR to tweak the README to note that this feature is available from v6.7.0 please?

github-actions[bot] commented 1 month ago

This issue is stale because it has been open for 60 days with no activity. It will be automatically closed in 14 days if no further updates are made.

leotsarev commented 1 month ago

I'm sorry for inconvenience. Missed bug. I think now that 6.7 have been released, it's no point to add this information.

martincostello commented 1 month ago

Is it fixed in 6.7.0? If not, the information is still useful.

leotsarev commented 1 month ago

The problem is that README recommends method that was added only in 6.7.0

martincostello commented 1 month ago

That's not a problem - 6.7.0 is the latest released version and that's what we recommend people use.

If 6.7.0 resolved the ask, we can close this issue. If it didn't, then we need more information to action it.