Commit b66ccd00 authored by charlie ablett's avatar charlie ablett

Merge branch '217567-fix-definitions' into 'master'

Docs: standardize descriptions of search functions

See merge request gitlab-org/gitlab!33794
parents 3e467539 6af13943
...@@ -8,7 +8,7 @@ module Resolvers ...@@ -8,7 +8,7 @@ module Resolvers
argument :search, GraphQL::STRING_TYPE, argument :search, GraphQL::STRING_TYPE,
required: false, required: false,
description: 'Search query' description: 'Search query for environment name'
argument :states, [GraphQL::STRING_TYPE], argument :states, [GraphQL::STRING_TYPE],
required: false, required: false,
......
...@@ -44,7 +44,7 @@ module Resolvers ...@@ -44,7 +44,7 @@ module Resolvers
description: 'Issues closed after this date' description: 'Issues closed after this date'
argument :search, GraphQL::STRING_TYPE, argument :search, GraphQL::STRING_TYPE,
required: false, required: false,
description: 'Search query for finding issues by title or description' description: 'Search query for issue title or description'
argument :sort, Types::IssueSortEnum, argument :sort, Types::IssueSortEnum,
description: 'Sort issues by this criteria', description: 'Sort issues by this criteria',
required: false, required: false,
......
...@@ -10,7 +10,7 @@ module Resolvers ...@@ -10,7 +10,7 @@ module Resolvers
argument :search, GraphQL::STRING_TYPE, argument :search, GraphQL::STRING_TYPE,
required: false, required: false,
description: 'Search criteria' description: 'Search query for project name, path, or description'
def resolve(**args) def resolve(**args)
ProjectsFinder ProjectsFinder
......
...@@ -17,7 +17,7 @@ module Types ...@@ -17,7 +17,7 @@ module Types
resolver: Resolvers::ErrorTracking::SentryErrorsResolver do resolver: Resolvers::ErrorTracking::SentryErrorsResolver do
argument :search_term, argument :search_term,
String, String,
description: 'Search term for the Sentry error.', description: 'Search query for the Sentry error details',
required: false required: false
argument :sort, argument :sort,
String, String,
......
...@@ -3424,7 +3424,7 @@ type Epic implements Noteable { ...@@ -3424,7 +3424,7 @@ type Epic implements Noteable {
last: Int last: Int
""" """
Filter epics by title and description Search query for epic title or description
""" """
search: String search: String
...@@ -4701,7 +4701,7 @@ type Group { ...@@ -4701,7 +4701,7 @@ type Group {
labelName: [String!] labelName: [String!]
""" """
Filter epics by title and description Search query for epic title or description
""" """
search: String search: String
...@@ -4778,7 +4778,7 @@ type Group { ...@@ -4778,7 +4778,7 @@ type Group {
last: Int last: Int
""" """
Filter epics by title and description Search query for epic title or description
""" """
search: String search: String
...@@ -4899,7 +4899,7 @@ type Group { ...@@ -4899,7 +4899,7 @@ type Group {
milestoneTitle: [String] milestoneTitle: [String]
""" """
Search query for finding issues by title or description Search query for issue title or description
""" """
search: String search: String
...@@ -8730,7 +8730,7 @@ type Project { ...@@ -8730,7 +8730,7 @@ type Project {
name: String name: String
""" """
Search query Search query for environment name
""" """
search: String search: String
...@@ -8830,7 +8830,7 @@ type Project { ...@@ -8830,7 +8830,7 @@ type Project {
milestoneTitle: [String] milestoneTitle: [String]
""" """
Search query for finding issues by title or description Search query for issue title or description
""" """
search: String search: String
...@@ -8930,7 +8930,7 @@ type Project { ...@@ -8930,7 +8930,7 @@ type Project {
milestoneTitle: [String] milestoneTitle: [String]
""" """
Search query for finding issues by title or description Search query for issue title or description
""" """
search: String search: String
...@@ -9338,7 +9338,7 @@ type Project { ...@@ -9338,7 +9338,7 @@ type Project {
iids: [ID!] iids: [ID!]
""" """
Filter requirements by title search Search query for requirement title
""" """
search: String search: String
...@@ -9398,7 +9398,7 @@ type Project { ...@@ -9398,7 +9398,7 @@ type Project {
last: Int last: Int
""" """
Filter requirements by title search Search query for requirement title
""" """
search: String search: String
...@@ -10089,7 +10089,7 @@ type Query { ...@@ -10089,7 +10089,7 @@ type Query {
membership: Boolean membership: Boolean
""" """
Search criteria Search query for project name, path, or description
""" """
search: String search: String
): ProjectConnection ): ProjectConnection
...@@ -11440,7 +11440,7 @@ type SentryErrorCollection { ...@@ -11440,7 +11440,7 @@ type SentryErrorCollection {
last: Int last: Int
""" """
Search term for the Sentry error. Search query for the Sentry error details
""" """
searchTerm: String searchTerm: String
......
...@@ -9497,7 +9497,7 @@ ...@@ -9497,7 +9497,7 @@
}, },
{ {
"name": "search", "name": "search",
"description": "Filter epics by title and description", "description": "Search query for epic title or description",
"type": { "type": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "String", "name": "String",
...@@ -13076,7 +13076,7 @@ ...@@ -13076,7 +13076,7 @@
}, },
{ {
"name": "search", "name": "search",
"description": "Filter epics by title and description", "description": "Search query for epic title or description",
"type": { "type": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "String", "name": "String",
...@@ -13205,7 +13205,7 @@ ...@@ -13205,7 +13205,7 @@
}, },
{ {
"name": "search", "name": "search",
"description": "Filter epics by title and description", "description": "Search query for epic title or description",
"type": { "type": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "String", "name": "String",
...@@ -13544,7 +13544,7 @@ ...@@ -13544,7 +13544,7 @@
}, },
{ {
"name": "search", "name": "search",
"description": "Search query for finding issues by title or description", "description": "Search query for issue title or description",
"type": { "type": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "String", "name": "String",
...@@ -25957,7 +25957,7 @@ ...@@ -25957,7 +25957,7 @@
}, },
{ {
"name": "search", "name": "search",
"description": "Search query", "description": "Search query for environment name",
"type": { "type": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "String", "name": "String",
...@@ -26294,7 +26294,7 @@ ...@@ -26294,7 +26294,7 @@
}, },
{ {
"name": "search", "name": "search",
"description": "Search query for finding issues by title or description", "description": "Search query for issue title or description",
"type": { "type": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "String", "name": "String",
...@@ -26473,7 +26473,7 @@ ...@@ -26473,7 +26473,7 @@
}, },
{ {
"name": "search", "name": "search",
"description": "Search query for finding issues by title or description", "description": "Search query for issue title or description",
"type": { "type": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "String", "name": "String",
...@@ -27483,7 +27483,7 @@ ...@@ -27483,7 +27483,7 @@
}, },
{ {
"name": "search", "name": "search",
"description": "Filter requirements by title search", "description": "Search query for requirement title",
"type": { "type": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "String", "name": "String",
...@@ -27586,7 +27586,7 @@ ...@@ -27586,7 +27586,7 @@
}, },
{ {
"name": "search", "name": "search",
"description": "Filter requirements by title search", "description": "Search query for requirement title",
"type": { "type": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "String", "name": "String",
...@@ -29710,7 +29710,7 @@ ...@@ -29710,7 +29710,7 @@
}, },
{ {
"name": "search", "name": "search",
"description": "Search criteria", "description": "Search query for project name, path, or description",
"type": { "type": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "String", "name": "String",
...@@ -33629,7 +33629,7 @@ ...@@ -33629,7 +33629,7 @@
}, },
{ {
"name": "searchTerm", "name": "searchTerm",
"description": "Search term for the Sentry error.", "description": "Search query for the Sentry error details",
"type": { "type": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "String", "name": "String",
...@@ -18,7 +18,7 @@ module Resolvers ...@@ -18,7 +18,7 @@ module Resolvers
argument :search, GraphQL::STRING_TYPE, argument :search, GraphQL::STRING_TYPE,
required: false, required: false,
description: 'Filter epics by title and description' description: 'Search query for epic title or description'
argument :sort, Types::EpicSortEnum, argument :sort, Types::EpicSortEnum,
required: false, required: false,
......
...@@ -21,7 +21,7 @@ module Resolvers ...@@ -21,7 +21,7 @@ module Resolvers
argument :search, GraphQL::STRING_TYPE, argument :search, GraphQL::STRING_TYPE,
required: false, required: false,
description: 'Filter requirements by title search' description: 'Search query for requirement title'
argument :author_username, [GraphQL::STRING_TYPE], argument :author_username, [GraphQL::STRING_TYPE],
required: false, required: false,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment