Skip to content

Additional work needed on the Search API page

Problem to solve

As part of cleaning up API pages for groupsource code, @aqualls stumbled into doc/api/search.md. She had already cleaned a lot of the page up before getting confirmation that the page belonged to groupglobal search instead. The page is lacking some specific information that can probably be found, but is better suited for handover to the TW for Global Search.

Further details

Problems not resolved in Amy's cleanup:

  • Response examples are of unknown age, may or may not be correct, and may or may not follow our fake-data guidelines.

  • The move of some features to Premium is listed in the history of several subsections, but the history should link to the relevant issue or merge request. (Here's how it should be structured. It's also possible that it's too old to be included.)

  • The assignee information should link to a deprecation issue. It may be out of date or wrong. Ideally, we should have a deprecation notice posted that includes a removal date:

    The `assignee` column is deprecated. It is shown as a single-sized array `assignees` to
conform to the GitLab EE API.

    This information may in fact be so outdated that the correct approach may be to instead add a version history note linking to when the deprecated field was removed.

  • The filename information is at a minimum incomplete, but may be out of date or wrong. It links to an open issue (#34521) but I strongly suspect we don't have an actual deprecation notice or a plan for actually removing it:

    `filename` is deprecated in favor of `path`. Both return the full path of the file inside
the repository, but in the future `filename` is intended to be only the filename and not
the full path.

Proposal

Who can address the issue

The technical writer for groupglobal search in tandem with the PM or EM.

Other links/references

Edited by Amy Qualls