As part of the Search action API, CirrusDoc is meant to be used only internally, for communication between the various Search components and it isn't a stable interface. To avoid other teams / use cases to start relying on that format, we need to make it clear in the response itself that this format is unstable.
Description
Description
Details
Details
Related Changes in Gerrit:
| Subject | Repo | Branch | Lines +/- | |
|---|---|---|---|---|
| Add a note to cirrus[build]doc output about format stability | mediawiki/extensions/CirrusSearch | master | +12 -0 |
Event Timeline
Comment Actions
I've seen other api's have an internal flag in Special:ApiSandbox, maybe we need to trigger the same interface element
Comment Actions
The API's were marked internal in https://gerrit.wikimedia.org/r/c/mediawiki/extensions/CirrusSearch/+/1127113 . I'm not sure what else we might need to do, this is mostly a UI flag in the Special:ApiSandbox but doesn't change anything else.
Comment Actions
I'm not clear on what isInternal() actually do. During some of our discussion, we discussed having something in the response payload making it clear that this should not be used (for example an additional field "comment" -> "The CirrusDoc format is meant for internal use by CirrusSearch or debugging of queries, it might change at any time without notice"). Should we still do this?
Comment Actions
Change #1131998 had a related patch set uploaded (by Ebernhardson; author: Ebernhardson):
[mediawiki/extensions/CirrusSearch@master] Add a note to cirrus[build]doc output about format stability
Comment Actions
Change #1131998 merged by jenkins-bot:
[mediawiki/extensions/CirrusSearch@master] Add a note to cirrus[build]doc output about format stability