How can I limit what gets included?

[epugh]

I have controllers under the /api namespace that are primarily what I want to have included in the docs, but there are some that I might want to skip. How can I control which controllers are listed?

[a-chacon]

Hi! I understand. That is a missing feature of OasRails, I was looking, and you only can exclude the routes by the name space. I mean, I think you already set the namespace /api for OasRails. But there is no way to exclude certain controller/actions inside this namespace.

So I ask you which could be the best approach?

1. Exclude the controller/actions before OasRails process it, defining it in the initializer. Here:

   oas_rails/lib/oas_rails/extractors/route_extractor.rb

   Line 91 in e4951a1

   def valid_api_route?(route)

2. Exclude the action with a new tag (Example: # @exclude ) in the controller method. If all actions of the controller need to be excluded, then I think this can be not the best option.

I think the first works for you, but I want to hear your opinion

[epugh]

I'm going to dig a bit more. I wonder though, what if instead of configuring it like this, what if you needed to have a @summary tag? And if you have a @summary, then you are included? Or maybe, if you have any of the @ tags, like @parameter then it is listed. But without at least one then it gets excluded?

Does oas_rails ignore end points that only generate HTML? Is it smart enough to only include endpoints that do json/xml/csv?

[epugh]

Also, poking around, I notice that I have a LOT of extra routes being included, for example these turbo native routes that I don't understand (but assume are used by turbo) are listed:

[epugh]

Maybe for the situation Quepid has, I really need a @include? Would this be at the controller level?

[a-chacon]

How would you detect if an endpoint render HTML or json/xml/csv ? I made OasRails thinking in api only apps.

This is the reason you see this turbo routes too, I try to exclude some common routes, but I think I missed it too.

And yes, I think the @include or @exclude tag comment at controller level can be a great solution, but technically is a bit hard to implement because currently OasRails just read Method’s comments and not Controller’s comments.

Thinking about the turbo native routes included in the documentation. Are this routes inside the namespace api? I mean, OasRails should exclude any route outside the namespace you configure in the initializer, if this is not doing that then probably we have an error.

And to move forward with it, please open an issue as a feature request to exclude certain entire controllers and actions from being documented by oas rails with a possible solution a new tag at controller level or otherwise an initializer configuration.

[epugh]

Thanks... So, the end points that are purely JSON, not html or anything else ARE luckily under a api/ path, so let me take a stab at that.