IContentSearchService and IMediaSearchService are not documented

[arknu]

What type of issue is it? (Choose one - delete the others)

Missing documentation

Describe the issue

umbraco/Umbraco-CMS#19046 introduced IContentSearchService and IMediaSearchService in Umbraco 16 to be able to change the backend implementation of search in List View. This is currently not documented anywhere, so unless you are aware of this PR, there is no way to discover you can even do this.

[sofietoft]

Thanks for reporting this @arknu !
Looks like a classic case of "docs or it didn't happen" ;)

I'll flag this with our developers.

[sofietoft]

Hi @arknu !
Apologies for the delay on this one.

Unfortunately, we don't currently have a process for documenting the use of each of these available services.
Alternatively, you can find and learn more about them in our API docs:
Backend: https://apidocs.umbraco.com/v16/csharp/api/Umbraco.Cms.Core.html
Frontend: https://apidocs.umbraco.com/v17/ui-api/index.html

I'll close this issue for now.
Please do not hesitate to get back in touch, if needed!

[arknu]

@sofietoft Why close the issue then? It should be left open until there are proper docs for how to use these APIs. I might even take a stab at writing them myself if I get the time. What is the point of opening a docs issue if it just gets closed stating "yes, we don't have docs for that"?

[sofietoft]

Yeah, that's a good question!

It's my understanding that the HQ development team would like to document these available services in a streamlined manner, coming up with a template and process for how this should be done.
That's really the main reason for closing the issue.

I do see the point about keeping it open, in case someone else comes looking for this type of docs.
Happy to re-open it 🙌