How to omit methods from Swagger documentation

189 views
Skip to first unread message

Steve Wilkinson

unread,
Apr 22, 2015, 5:34:15 PM4/22/15
to swagger-sw...@googlegroups.com
I have a C# ASP.NET WebAPI application with API documentation being automatically generated using Swashbuckle. I want to be able to omit certain methods from the documentation but I can't seem to work out how to tell Swagger not to include them in the Swagger UI output.

I sense it is something to do with adding a model or schema filter but it isn't obvious what to do and the documentation only seems to provide examples of how to modify the output for a method, not remove it completely from the output.

Thanks in advance - Steve.

Ron Ratovsky

unread,
Apr 26, 2015, 7:33:55 AM4/26/15
to swagger-sw...@googlegroups.com
Hi Steve,

I think https://github.com/domaindrivendev/Swashbuckle/issues/153 covers your use case to filter operations from the documentation itself.

Swagger-UI itself displays the documentation as is and does not filter out operations.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.



--
-----------------------------------------
http://swagger.io
https://twitter.com/SwaggerApi
-----------------------------------------

Steve Wilkinson

unread,
Apr 27, 2015, 2:10:06 AM4/27/15
to swagger-sw...@googlegroups.com
Many thanks Ron, will give that a try.


On Sunday, 26 April 2015 12:33:55 UTC+1, Ron wrote:
Hi Steve,

I think https://github.com/domaindrivendev/Swashbuckle/issues/153 covers your use case to filter operations from the documentation itself.

Swagger-UI itself displays the documentation as is and does not filter out operations.
On Thu, Apr 23, 2015 at 12:34 AM, Steve Wilkinson <steve.c....@gmail.com> wrote:
I have a C# ASP.NET WebAPI application with API documentation being automatically generated using Swashbuckle. I want to be able to omit certain methods from the documentation but I can't seem to work out how to tell Swagger not to include them in the Swagger UI output.

I sense it is something to do with adding a model or schema filter but it isn't obvious what to do and the documentation only seems to provide examples of how to modify the output for a method, not remove it completely from the output.

Thanks in advance - Steve.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.
Reply all
Reply to author
Forward
0 new messages