search

postmanlabs / postman-app-support

Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.
https://www.postman.com
5.83k stars 838 forks source link

Search For Published Documentation #3747

Open ypolishetty opened 6 years ago

ypolishetty commented 6 years ago

Could you please add support to search for APIs in the published documentation instead of a regular search on the web page? Something similar to the search you have in the below link:

https://www.getpostman.com/docs/postman/api_documentation/publishing_public_docs?q=&idx=blog&p=0&is_v=2

godfrzero commented 6 years ago

Thanks for the suggestion! We'll see if and when we can squeeze this into our development timeline. I'll post updates here when they're available.

ypolishetty commented 6 years ago

Hi,

Wondering if there is any ETA for this feature as our collection is getting bigger everyday and its becoming difficult for us to do a regular HTML page search. If you have any other alternate solutions such as we generating the documentation page ourselves from the collection so we could add a search ourselves, please let me know.

Yash

ypolishetty commented 6 years ago

Any update on the timeline please?

godfrzero commented 6 years ago

This is not something that's on the roadmap right now (you can keep an eye on the roadmap here).

How big is this collection, in terms of request or file-size?

ypolishetty commented 6 years ago

Its around 3.75MB with 467 APIs in total for now.

sankalp0o commented 6 years ago

@ypolishetty What kind of things are you not able search from the regular page search?

ypolishetty commented 6 years ago

A regular web page search is too cumbersome as we have around 500 APIs right now. Even after the search, it is difficult to identify from the left pane where exactly(under which sub folder) this api resides. I was requesting for a search bar similar to what you guys have here: https://www.getpostman.com/docs/v6/postman/api_documentation/publishing_public_docs

This would be perfect!

ypolishetty commented 4 years ago

Any update on this? Our collection is getting bigger and we badly need this search feature.

ypolishetty commented 4 years ago

Any update on the ETA please?

therockstorm commented 4 years ago

I second this. Algolia DocSearch is free for developer documentation. However, one of the items on their checklist before applying is,

You must be the owner of the website, or at least have the permissions to update its content. You'll have to include a JavaScript snippet to enable DocSearch.

Docusaurus handles this by allowing you to provide your Algolia API key and Index name in the config. Once this exists, Docusaurus shows the search bar in the header. Postman Docs supporting something like this would be excellent and means you wouldn't have to maintain search indexes yourself.