Filter API documentation by tags in documentation hubs

[jayshao]

It would be nice to be able to filter which tags to show in the documentation hub.

The use case I'm thinking of is wanting to be able to document "Operational" or "Private" methods for internal team usage (things like Heartbeats, Metrics, etc.) but not publish them for public consumers

[marbemac]

You're reading our minds - we're going to be allowing an "x-private" property to be added to a tag. Then, anything tagged with that tag will not be included when referenced from hubs etc.

This will eventually be part of a more comprehensive filtering system (filtering parts of your docs / content for particular user groups, etc).

[jayshao]

I suspect I'd ask for a little more flexibility - in many respects I want to publish different documentation sets for different audiences - and in my head this is something I would either control at the point of publish - or maybe with multiple tags? I have avoided multiple tags so far though for fear of complicating... everything :)

On Thu, Nov 30, 2017 at 12:43 PM Marc MacLeod [email protected] wrote:

You're reading our minds - we're going to be allowing an "x-private" property to be added to a tag. Then, anything tagged with that tag will not be included when referenced from hubs etc.

This will eventually be part of a more comprehensive filtering system (filtering parts of your docs / content for particular user groups, etc).

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/stoplightio/desktop/issues/88#issuecomment-348264896, or mute the thread https://github.com/notifications/unsubscribe-auth/AAMitz2FS1O4R7Q_JIUHKnXfUnsStzDBks5s7ulOgaJpZM4Qsfwy .

--

Jason Shao

Head of Engineering

T: 212 644-6200 x9536

M: 732 221-9771

[email protected]

@jayshao https://twitter.com/jayshao

Intersection

10 Hudson Yards 26th Floor New York NY 10001

intersection.com

[jayshao]

@marbemac curious where on the priority queue this kind of filtering is landing - or if there are any interim workarounds?

For context - we currently treat one of our product lines as a single, cohesive set of APIs, but very much want to split out the APIs we expose to different audiences (e.g. depending in our case on if they are a publisher, send us data, or buy advertising). In the past we had explored forcing ourself to split into separate OAS files - but that has proven problematic - since some entities (e.g. orgs, users, etc.) we do want to show up in all contexts.

Ideal for me would be able to filter down by tag - or perhaps path - either in the GUI or in the code editor as a stopgap