Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
9bf89998
Commit
9bf89998
authored
Apr 29, 2021
by
Alex Kalderimis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add description of `see:` field property
parent
d59d9774
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
23 additions
and
0 deletions
+23
-0
doc/development/api_graphql_styleguide.md
doc/development/api_graphql_styleguide.md
+23
-0
No files found.
doc/development/api_graphql_styleguide.md
View file @
9bf89998
...
...
@@ -770,6 +770,29 @@ argument :title, GraphQL::STRING_TYPE,
description:
copy_field_description
(
Types
::
MergeRequestType
,
:title
)
```
### Documentation references
Sometimes we want to refer to external URLs in our descriptions. To make this
easier, and provide proper markup in the generated reference documentation, we
provide a
`see`
property on fields. For example:
```
ruby
field
:genus
,
type:
GraphQL
::
STRING_TYPE
,
null:
true
,
description:
'A taxonomic genus.'
see:
{
'Wikipedia page on genera'
=>
'https://wikipedia.org/wiki/Genus'
}
```
This will render in our documentation as:
```
markdown
A taxonomic genus. See:
[
Wikipedia page on genera
](
https://wikipedia.org/wiki/Genus
)
```
Multiple documentation references can be provided. The syntax for this property
is a
`HashMap`
where the keys are textual descriptions, and the values are URLs.
## Authorization
See:
[
GraphQL Authorization
](
graphql_guide/authorization.md
)
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment