SearchResponse

Shape

• itemsarray of SearchHit

  • The SearchHit schema
  • idstringThe resource's own identifier, as its domain names it (an issue uid, a repository id, a group id, a release tag_name).
  • kindSearchHitKindissuemerge_requestrepositorygroupreleasecommentservicespecwikiWhat kind of thing a search result is.
  • ranknumber · floatHow well the result matches the query; results are ordered by it, highest first.
  • titlestring
  • updated_atstring
  • excerptstring or nulloptionalA short excerpt of the matching body, when the kind has one.
  • iidinteger · int64 or nulloptional0–∞The per-scope sequential number, for the kinds that have one. A comment carries the number of the work item or merge request it was written on.
  • onSearchHitKindissuemerge_requestrepositorygroupreleasecommentservicespecwikior nulloptionalFor a comment: what it was written on, issue or merge_request. With scope and iid it addresses the thread the comment belongs to.
  • pathstring or nulloptionalFor a spec: the document's file in its repository. For a wiki page: the page's path, which is what reads it.
  • scopeScopeRef or nulloptionalThe group or repository the result belongs to — a service's group, a comment's work item's or merge request's scope. Absent for a group and a repository, which are one themselves.
• next_tokenstring or nulloptional

Graph

Used by