Skip to content

G
gitlab-ce
Commit b66ccd00 authored by charlie ablett's avatar charlie ablett
Browse files
Options

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

Docs: standardize descriptions of search functions

See merge request gitlab-org/gitlab!33794
parents 3e467539 6af13943
Show whitespace changes
Inline Side-by-side
Showing with 28 additions and 28 deletions
app/graphql/resolvers/environments_resolver.rb
View file @ b66ccd00
......@@ -8,7 +8,7 @@ module Resolvers
argument :search, GraphQL::STRING_TYPE,
required: false,
description: 'Search query'
description: 'Search query for environment name'
argument :states, [GraphQL::STRING_TYPE],
required: false,
......
app/graphql/resolvers/issues_resolver.rb
View file @ b66ccd00
......@@ -44,7 +44,7 @@ module Resolvers
description: 'Issues closed after this date'
argument :search, GraphQL::STRING_TYPE,
required: false,
description: 'Search query for finding issues by title or description'
description: 'Search query for issue title or description'
argument :sort, Types::IssueSortEnum,
description: 'Sort issues by this criteria',
required: false,
......
app/graphql/resolvers/projects_resolver.rb
View file @ b66ccd00
......@@ -10,7 +10,7 @@ module Resolvers
argument :search, GraphQL::STRING_TYPE,
required: false,
description: 'Search criteria'
description: 'Search query for project name, path, or description'
def resolve(**args)
ProjectsFinder
......
app/graphql/types/error_tracking/sentry_error_collection_type.rb
View file @ b66ccd00
......@@ -17,7 +17,7 @@ module Types
resolver: Resolvers::ErrorTracking::SentryErrorsResolver do
argument :search_term,
String,
description: 'Search term for the Sentry error.',
description: 'Search query for the Sentry error details',
required: false
argument :sort,
String,
......
doc/api/graphql/reference/gitlab_schema.graphql
View file @ b66ccd00
......@@ -3424,7 +3424,7 @@ type Epic implements Noteable {
last: Int
"""
Filter epics by title and description
Search query for epic title or description
"""
search: String
......@@ -4701,7 +4701,7 @@ type Group {
labelName: [String!]
"""
Filter epics by title and description
Search query for epic title or description
"""
search: String
......@@ -4778,7 +4778,7 @@ type Group {
last: Int
"""
Filter epics by title and description
Search query for epic title or description
"""
search: String
......@@ -4899,7 +4899,7 @@ type Group {
milestoneTitle: [String]
"""
Search query for finding issues by title or description
Search query for issue title or description
"""
search: String
......@@ -8730,7 +8730,7 @@ type Project {
name: String
"""
Search query
Search query for environment name
"""
search: String
......@@ -8830,7 +8830,7 @@ type Project {
milestoneTitle: [String]
"""
Search query for finding issues by title or description
Search query for issue title or description
"""
search: String
......@@ -8930,7 +8930,7 @@ type Project {
milestoneTitle: [String]
"""
Search query for finding issues by title or description
Search query for issue title or description
"""
search: String
......@@ -9338,7 +9338,7 @@ type Project {
iids: [ID!]
"""
Filter requirements by title search
Search query for requirement title
"""
search: String
......@@ -9398,7 +9398,7 @@ type Project {
last: Int
"""
Filter requirements by title search
Search query for requirement title
"""
search: String
......@@ -10089,7 +10089,7 @@ type Query {
membership: Boolean
"""
Search criteria
Search query for project name, path, or description
"""
search: String
): ProjectConnection
......@@ -11440,7 +11440,7 @@ type SentryErrorCollection {
last: Int
"""
Search term for the Sentry error.
Search query for the Sentry error details
"""
searchTerm: String
......
doc/api/graphql/reference/gitlab_schema.json
View file @ b66ccd00
......@@ -9497,7 +9497,7 @@
},
{
"name": "search",
"description": "Filter epics by title and description",
"description": "Search query for epic title or description",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -13076,7 +13076,7 @@
},
{
"name": "search",
"description": "Filter epics by title and description",
"description": "Search query for epic title or description",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -13205,7 +13205,7 @@
},
{
"name": "search",
"description": "Filter epics by title and description",
"description": "Search query for epic title or description",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -13544,7 +13544,7 @@
},
{
"name": "search",
"description": "Search query for finding issues by title or description",
"description": "Search query for issue title or description",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -25957,7 +25957,7 @@
},
{
"name": "search",
"description": "Search query",
"description": "Search query for environment name",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -26294,7 +26294,7 @@
},
{
"name": "search",
"description": "Search query for finding issues by title or description",
"description": "Search query for issue title or description",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -26473,7 +26473,7 @@
},
{
"name": "search",
"description": "Search query for finding issues by title or description",
"description": "Search query for issue title or description",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -27483,7 +27483,7 @@
},
{
"name": "search",
"description": "Filter requirements by title search",
"description": "Search query for requirement title",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -27586,7 +27586,7 @@
},
{
"name": "search",
"description": "Filter requirements by title search",
"description": "Search query for requirement title",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -29710,7 +29710,7 @@
},
{
"name": "search",
"description": "Search criteria",
"description": "Search query for project name, path, or description",
"type": {
"kind": "SCALAR",
"name": "String",
......@@ -33629,7 +33629,7 @@
},
{
"name": "searchTerm",
"description": "Search term for the Sentry error.",
"description": "Search query for the Sentry error details",
"type": {
"kind": "SCALAR",
"name": "String",
ee/app/graphql/resolvers/epics_resolver.rb
View file @ b66ccd00
......@@ -18,7 +18,7 @@ module Resolvers
argument :search, GraphQL::STRING_TYPE,
required: false,
description: 'Filter epics by title and description'
description: 'Search query for epic title or description'
argument :sort, Types::EpicSortEnum,
required: false,
......
ee/app/graphql/resolvers/requirements_management/requirements_resolver.rb
View file @ b66ccd00
......@@ -21,7 +21,7 @@ module Resolvers
argument :search, GraphQL::STRING_TYPE,
required: false,
description: 'Filter requirements by title search'
description: 'Search query for requirement title'
argument :author_username, [GraphQL::STRING_TYPE],
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7