search

microsoft / vscode-azureapicenter

MIT License
17 stars 13 forks source link

docs: README/Changelog for 0.3.0 release #130

Closed pierceboggan closed 5 months ago

pierceboggan commented 5 months ago

@wenyt For search integration, what do we support searching? Just API name? I want to make sure I'm clear in Changelog / documentation.

wenytang-ms commented 5 months ago

@wenyt For search integration, what do we support searching? Just API name? I want to make sure I'm clear in Changelog / documentation.

Currently search APIs support not only API name, but also with some properties (API kind, created time, lifeCycleStage, description, summary, customProperties and so on).

pierceboggan commented 5 months ago

@wenytang-ms - Can you provide some examples of search queries using those properties so I can update the README/docs?

wenytang-ms commented 5 months ago

@pierceboggan let me show some sample

  1. if user want to search for all the rest APIs in the API Center Instance rest

  2. if user want to search for all the design lifecycle APIs, he may design

  3. if user want to search for all the customProperties like following Apis API test testabc

pierceboggan commented 5 months ago

@wenytang-ms - AH I see. I know what I was doing wrong. I was doing. "lifecycle:production type:REST"

But from what I see in the screenshots, you don't need to clarify which property you want to filter against?

wenytang-ms commented 5 months ago

@wenytang-ms - AH I see. I know what I was doing wrong. I was doing. "lifecycle:production type:REST"

But from what I see in the screenshots, you don't need to clarify which property you want to filter against?

@pierceboggan You are right! It should be give more clarify in the search box. Let me improve the search experience before the next release, so currently shall we suppose users only to search APIs name?

pierceboggan commented 5 months ago

@wenytang-ms That sounds good to me! We don't have to make any changes to the release branch. We can keep as-is for April release, and add the ability to refine search results as described above in the May release.

wenytang-ms commented 5 months ago

@pierceboggan Great! I already create a backlog into project to improve the search expericen. https://github.com/orgs/microsoft/projects/1014?pane=issue&itemId=59249311