Commit 959f4697 authored by Amy Qualls's avatar Amy Qualls Committed by Mayra Cabrera

Repair GraphQL definitions to pass Kramdown

These GraphQL definitions contained unescaped square brackets, which
causes Kramdown to throw build warnings that the TWs see when building
the docs site locally. Escape these strings with inline code tags.
parent a16e12d9
...@@ -12,7 +12,7 @@ module Resolvers ...@@ -12,7 +12,7 @@ module Resolvers
argument :statuses, [Types::AlertManagement::StatusEnum], argument :statuses, [Types::AlertManagement::StatusEnum],
as: :status, as: :status,
required: false, required: false,
description: 'Alerts with the specified statues. For example, [TRIGGERED].' description: 'Alerts with the specified statues. For example, `[TRIGGERED]`.'
argument :sort, Types::AlertManagement::AlertSortEnum, argument :sort, Types::AlertManagement::AlertSortEnum,
description: 'Sort alerts by this criteria.', description: 'Sort alerts by this criteria.',
......
...@@ -11,7 +11,7 @@ module IssueResolverArguments ...@@ -11,7 +11,7 @@ module IssueResolverArguments
description: 'IID of the issue. For example, "1".' description: 'IID of the issue. For example, "1".'
argument :iids, [GraphQL::STRING_TYPE], argument :iids, [GraphQL::STRING_TYPE],
required: false, required: false,
description: 'List of IIDs of issues. For example, ["1", "2"].' description: 'List of IIDs of issues. For example, `["1", "2"]`.'
argument :label_name, [GraphQL::STRING_TYPE, null: true], argument :label_name, [GraphQL::STRING_TYPE, null: true],
required: false, required: false,
description: 'Labels applied to this issue.' description: 'Labels applied to this issue.'
......
...@@ -18,8 +18,8 @@ module Types ...@@ -18,8 +18,8 @@ module Types
value 'EVENT_COUNT_DESC', 'Events count by descending order.', value: :event_count_desc value 'EVENT_COUNT_DESC', 'Events count by descending order.', value: :event_count_desc
value 'SEVERITY_ASC', 'Severity from less critical to more critical.', value: :severity_asc value 'SEVERITY_ASC', 'Severity from less critical to more critical.', value: :severity_asc
value 'SEVERITY_DESC', 'Severity from more critical to less critical.', value: :severity_desc value 'SEVERITY_DESC', 'Severity from more critical to less critical.', value: :severity_desc
value 'STATUS_ASC', 'Status by order: Ignored > Resolved > Acknowledged > Triggered.', value: :status_asc value 'STATUS_ASC', 'Status by order: `Ignored > Resolved > Acknowledged > Triggered`.', value: :status_asc
value 'STATUS_DESC', 'Status by order: Triggered > Acknowledged > Resolved > Ignored.', value: :status_desc value 'STATUS_DESC', 'Status by order: `Triggered > Acknowledged > Resolved > Ignored`.', value: :status_desc
end end
end end
end end
...@@ -6,7 +6,7 @@ module Types ...@@ -6,7 +6,7 @@ module Types
class BoardIssueInputBaseType < BoardIssuableInputBaseType class BoardIssueInputBaseType < BoardIssuableInputBaseType
argument :iids, [GraphQL::STRING_TYPE], argument :iids, [GraphQL::STRING_TYPE],
required: false, required: false,
description: 'List of IIDs of issues. For example ["1", "2"].' description: 'List of IIDs of issues. For example `["1", "2"]`.'
argument :milestone_title, GraphQL::STRING_TYPE, argument :milestone_title, GraphQL::STRING_TYPE,
required: false, required: false,
......
...@@ -7,7 +7,7 @@ module Types ...@@ -7,7 +7,7 @@ module Types
argument :iids, [GraphQL::STRING_TYPE], argument :iids, [GraphQL::STRING_TYPE],
required: false, required: false,
description: 'List of IIDs of issues to exclude. For example, [1, 2].' description: 'List of IIDs of issues to exclude. For example, `[1, 2]`.'
argument :label_name, [GraphQL::STRING_TYPE], argument :label_name, [GraphQL::STRING_TYPE],
required: false, required: false,
description: 'Labels not applied to this issue.' description: 'Labels not applied to this issue.'
......
This diff is collapsed.
...@@ -11,7 +11,7 @@ module Resolvers ...@@ -11,7 +11,7 @@ module Resolvers
argument :iids, [GraphQL::ID_TYPE], argument :iids, [GraphQL::ID_TYPE],
required: false, required: false,
description: 'List of IIDs of epics, e.g., [1, 2].' description: 'List of IIDs of epics, e.g., `[1, 2]`.'
argument :state, Types::EpicStateEnum, argument :state, Types::EpicStateEnum,
required: false, required: false,
......
...@@ -14,7 +14,7 @@ module Resolvers ...@@ -14,7 +14,7 @@ module Resolvers
argument :iids, [GraphQL::ID_TYPE], argument :iids, [GraphQL::ID_TYPE],
required: false, required: false,
description: 'List of IIDs of requirements, e.g., [1, 2].' description: 'List of IIDs of requirements, e.g., `[1, 2]`.'
argument :last_test_report_state, ::Types::RequirementsManagement::RequirementStatusFilterEnum, argument :last_test_report_state, ::Types::RequirementsManagement::RequirementStatusFilterEnum,
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