diff options
Diffstat (limited to 'doc/api/search.md')
| -rw-r--r-- | doc/api/search.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/api/search.md b/doc/api/search.md index ca08f5ca0d7..8e20722052e 100644 --- a/doc/api/search.md +++ b/doc/api/search.md @@ -181,6 +181,7 @@ Example response: "merge_status": "can_be_merged", "sha": "78765a2d5e0a43585945c58e61ba2f822e4d090b", "merge_commit_sha": null, + "squash_commit_sha": null, "user_notes_count": 0, "discussion_locked": null, "should_remove_source_branch": null, @@ -299,6 +300,7 @@ Example response: { "basename": "home", "data": "hello\n\nand bye\n\nend", + "path": "home.md", "filename": "home.md", "id": null, "ref": "master", @@ -308,6 +310,8 @@ Example response: ] ``` +**Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path (see [this issue][gitlab-34521]). + ### Scope: commits **(STARTER)** This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. @@ -367,6 +371,7 @@ Example response: { "basename": "README", "data": "```\n\n## Installation\n\nQuick start using the [pre-built", + "path": "README.md", "filename": "README.md", "id": null, "ref": "master", @@ -376,6 +381,8 @@ Example response: ] ``` +**Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path (see [this issue][gitlab-34521]). + ### Scope: users ```bash @@ -577,6 +584,7 @@ Example response: "merge_status": "can_be_merged", "sha": "78765a2d5e0a43585945c58e61ba2f822e4d090b", "merge_commit_sha": null, + "squash_commit_sha": null, "user_notes_count": 0, "discussion_locked": null, "should_remove_source_branch": null, @@ -633,6 +641,7 @@ Example response: { "basename": "home", "data": "hello\n\nand bye\n\nend", + "path": "home.md", "filename": "home.md", "id": null, "ref": "master", @@ -642,6 +651,8 @@ Example response: ] ``` +**Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path (see [this issue][gitlab-34521]). + ### Scope: commits **(STARTER)** This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. @@ -701,6 +712,7 @@ Example response: { "basename": "README", "data": "```\n\n## Installation\n\nQuick start using the [pre-built", + "path": "README.md", "filename": "README.md", "id": null, "ref": "master", @@ -710,6 +722,8 @@ Example response: ] ``` +**Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path (see [this issue][gitlab-34521]). + ### Scope: users ```bash @@ -878,6 +892,7 @@ Example response: "merge_status": "can_be_merged", "sha": "78765a2d5e0a43585945c58e61ba2f822e4d090b", "merge_commit_sha": null, + "squash_commit_sha": null, "user_notes_count": 0, "discussion_locked": null, "should_remove_source_branch": null, @@ -981,6 +996,7 @@ Example response: { "basename": "home", "data": "hello\n\nand bye\n\nend", + "path": "home.md", "filename": "home.md", "id": null, "ref": "master", @@ -990,6 +1006,8 @@ Example response: ] ``` +**Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path (see [this issue][gitlab-34521]). + ### Scope: commits ```bash @@ -1051,6 +1069,7 @@ Example response: { "basename": "README", "data": "```\n\n## Installation\n\nQuick start using the [pre-built", + "path": "README.md", "filename": "README.md", "id": null, "ref": "master", @@ -1060,6 +1079,8 @@ Example response: ] ``` +**Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path (see [this issue][gitlab-34521]). + ### Scope: users ```bash @@ -1082,3 +1103,4 @@ Example response: ``` [ce-41763]: https://gitlab.com/gitlab-org/gitlab-foss/issues/41763 +[gitlab-34521]: https://gitlab.com/gitlab-org/gitlab/issues/34521 |