Skip to content

G
gitlab-ce
Commit d3036faf authored by Phil Hughes's avatar Phil Hughes
Browse files
Options

Merge branch 'cablett-backfilling-part-6-docs' into 'master' 

Backfill GraphQL descriptions

See merge request gitlab-org/gitlab!22199
parents e37ec37f 051b354b
Show whitespace changes
Inline Side-by-side
Showing with 206 additions and 83 deletions
app/graphql/types/tree/blob_type.rb
View file @ d3036faf
......@@ -10,8 +10,11 @@ module Types
graphql_name 'Blob'
field :web_url, GraphQL::STRING_TYPE, null: true # rubocop:disable Graphql/Descriptions
field :lfs_oid, GraphQL::STRING_TYPE, null: true, resolve: -> (blob, args, ctx) do # rubocop:disable Graphql/Descriptions
field :web_url, GraphQL::STRING_TYPE, null: true,
description: 'Web URL of the blob'
field :lfs_oid, GraphQL::STRING_TYPE, null: true,
description: 'LFS ID of the blob',
resolve: -> (blob, args, ctx) do
Gitlab::Graphql::Loaders::BatchLfsOidLoader.new(blob.repository, blob.id).find
end
# rubocop: enable Graphql/AuthorizeTypes
......
app/graphql/types/tree/entry_type.rb
View file @ d3036faf
......@@ -4,12 +4,18 @@ module Types
module EntryType
include Types::BaseInterface
field :id, GraphQL::ID_TYPE, null: false # rubocop:disable Graphql/Descriptions
field :sha, GraphQL::STRING_TYPE, null: false, description: "Last commit sha for entry", method: :id
field :name, GraphQL::STRING_TYPE, null: false # rubocop:disable Graphql/Descriptions
field :type, Tree::TypeEnum, null: false # rubocop:disable Graphql/Descriptions
field :path, GraphQL::STRING_TYPE, null: false # rubocop:disable Graphql/Descriptions
field :flat_path, GraphQL::STRING_TYPE, null: false # rubocop:disable Graphql/Descriptions
field :id, GraphQL::ID_TYPE, null: false,
description: 'ID of the entry'
field :sha, GraphQL::STRING_TYPE, null: false,
description: 'Last commit sha for the entry', method: :id
field :name, GraphQL::STRING_TYPE, null: false,
description: 'Name of the entry'
field :type, Tree::TypeEnum, null: false,
description: 'Type of tree entry'
field :path, GraphQL::STRING_TYPE, null: false,
description: 'Path of the entry'
field :flat_path, GraphQL::STRING_TYPE, null: false,
description: 'Flat path of the entry'
end
end
end
app/graphql/types/tree/submodule_type.rb
View file @ d3036faf
......@@ -8,8 +8,10 @@ module Types
graphql_name 'Submodule'
field :web_url, type: GraphQL::STRING_TYPE, null: true # rubocop:disable Graphql/Descriptions
field :tree_url, type: GraphQL::STRING_TYPE, null: true # rubocop:disable Graphql/Descriptions
field :web_url, type: GraphQL::STRING_TYPE, null: true,
description: 'Web URL for the sub-module'
field :tree_url, type: GraphQL::STRING_TYPE, null: true,
description: 'Tree URL for the sub-module'
end
# rubocop: enable Graphql/AuthorizeTypes
end
......
app/graphql/types/tree/tree_entry_type.rb
View file @ d3036faf
......@@ -11,7 +11,8 @@ module Types
graphql_name 'TreeEntry'
description 'Represents a directory'
field :web_url, GraphQL::STRING_TYPE, null: true # rubocop:disable Graphql/Descriptions
field :web_url, GraphQL::STRING_TYPE, null: true,
description: 'Web URL for the tree entry (directory)'
end
# rubocop: enable Graphql/AuthorizeTypes
end
......
app/graphql/types/tree/tree_type.rb
View file @ d3036faf
......@@ -11,17 +11,21 @@ module Types
null: true, complexity: 10, calls_gitaly: true, resolver: Resolvers::LastCommitResolver,
description: 'Last commit for the tree'
field :trees, Types::Tree::TreeEntryType.connection_type, null: false, resolve: -> (obj, args, ctx) do # rubocop:disable Graphql/Descriptions
field :trees, Types::Tree::TreeEntryType.connection_type, null: false,
description: 'Trees of the tree',
resolve: -> (obj, args, ctx) do
Gitlab::Graphql::Representation::TreeEntry.decorate(obj.trees, obj.repository)
end
# rubocop:disable Graphql/Descriptions
field :submodules, Types::Tree::SubmoduleType.connection_type, null: false, calls_gitaly: true, resolve: -> (obj, args, ctx) do
field :submodules, Types::Tree::SubmoduleType.connection_type, null: false,
description: 'Sub-modules of the tree',
calls_gitaly: true, resolve: -> (obj, args, ctx) do
Gitlab::Graphql::Representation::SubmoduleTreeEntry.decorate(obj.submodules, obj)
end
# rubocop:enable Graphql/Descriptions
field :blobs, Types::Tree::BlobType.connection_type, null: false, calls_gitaly: true, resolve: -> (obj, args, ctx) do # rubocop:disable Graphql/Descriptions
field :blobs, Types::Tree::BlobType.connection_type, null: false,
description: 'Blobs of the tree',
calls_gitaly: true, resolve: -> (obj, args, ctx) do
Gitlab::Graphql::Representation::TreeEntry.decorate(obj.blobs, obj.repository)
end
# rubocop: enable Graphql/AuthorizeTypes
......
doc/api/graphql/reference/gitlab_schema.graphql
View file @ d3036faf
......@@ -71,17 +71,44 @@ type AwardEmoji {
}
type Blob implements Entry {
"""
Flat path of the entry
"""
flatPath: String!
"""
ID of the entry
"""
id: ID!
"""
LFS ID of the blob
"""
lfsOid: String
"""
Name of the entry
"""
name: String!
"""
Path of the entry
"""
path: String!
"""
Last commit sha for entry
Last commit sha for the entry
"""
sha: String!
"""
Type of tree entry
"""
type: EntryType!
"""
Web URL of the blob
"""
webUrl: String
}
......@@ -1290,15 +1317,34 @@ type DiscussionEdge {
}
interface Entry {
"""
Flat path of the entry
"""
flatPath: String!
"""
ID of the entry
"""
id: ID!
"""
Name of the entry
"""
name: String!
"""
Path of the entry
"""
path: String!
"""
Last commit sha for entry
Last commit sha for the entry
"""
sha: String!
"""
Type of tree entry
"""
type: EntryType!
}
......@@ -5857,17 +5903,44 @@ type SnippetPermissions {
}
type Submodule implements Entry {
"""
Flat path of the entry
"""
flatPath: String!
"""
ID of the entry
"""
id: ID!
"""
Name of the entry
"""
name: String!
"""
Path of the entry
"""
path: String!
"""
Last commit sha for entry
Last commit sha for the entry
"""
sha: String!
"""
Tree URL for the sub-module
"""
treeUrl: String
"""
Type of tree entry
"""
type: EntryType!
"""
Web URL for the sub-module
"""
webUrl: String
}
......@@ -6256,6 +6329,9 @@ type ToggleAwardEmojiPayload {
}
type Tree {
"""
Blobs of the tree
"""
blobs(
"""
Returns the elements in the list that come after the specified cursor.
......@@ -6282,6 +6358,10 @@ type Tree {
Last commit for the tree
"""
lastCommit: Commit
"""
Sub-modules of the tree
"""
submodules(
"""
Returns the elements in the list that come after the specified cursor.
......@@ -6303,6 +6383,10 @@ type Tree {
"""
last: Int
): SubmoduleConnection!
"""
Trees of the tree
"""
trees(
"""
Returns the elements in the list that come after the specified cursor.
......@@ -6330,16 +6414,39 @@ type Tree {
Represents a directory
"""
type TreeEntry implements Entry {
"""
Flat path of the entry
"""
flatPath: String!
"""
ID of the entry
"""
id: ID!
"""
Name of the entry
"""
name: String!
"""
Path of the entry
"""
path: String!
"""
Last commit sha for entry
Last commit sha for the entry
"""
sha: String!
"""
Type of tree entry
"""
type: EntryType!
"""
Web URL for the tree entry (directory)
"""
webUrl: String
}
......
doc/api/graphql/reference/gitlab_schema.json
View file @ d3036faf
......@@ -11428,7 +11428,7 @@
"fields": [
{
"name": "blobs",
"description": null,
"description": "Blobs of the tree",
"args": [
{
"name": "after",
......@@ -11499,7 +11499,7 @@
},
{
"name": "submodules",
"description": null,
"description": "Sub-modules of the tree",
"args": [
{
"name": "after",
......@@ -11556,7 +11556,7 @@
},
{
"name": "trees",
"description": null,
"description": "Trees of the tree",
"args": [
{
"name": "after",
......@@ -12693,7 +12693,7 @@
"fields": [
{
"name": "flatPath",
"description": null,
"description": "Flat path of the entry",
"args": [
],
......@@ -12711,7 +12711,7 @@
},
{
"name": "id",
"description": null,
"description": "ID of the entry",
"args": [
],
......@@ -12729,7 +12729,7 @@
},
{
"name": "name",
"description": null,
"description": "Name of the entry",
"args": [
],
......@@ -12747,7 +12747,7 @@
},
{
"name": "path",
"description": null,
"description": "Path of the entry",
"args": [
],
......@@ -12765,7 +12765,7 @@
},
{
"name": "sha",
"description": "Last commit sha for entry",
"description": "Last commit sha for the entry",
"args": [
],
......@@ -12783,7 +12783,7 @@
},
{
"name": "type",
"description": null,
"description": "Type of tree entry",
"args": [
],
......@@ -12801,7 +12801,7 @@
},
{
"name": "webUrl",
"description": null,
"description": "Web URL for the tree entry (directory)",
"args": [
],
......@@ -12832,7 +12832,7 @@
"fields": [
{
"name": "flatPath",
"description": null,
"description": "Flat path of the entry",
"args": [
],
......@@ -12850,7 +12850,7 @@
},
{
"name": "id",
"description": null,
"description": "ID of the entry",
"args": [
],
......@@ -12868,7 +12868,7 @@
},
{
"name": "name",
"description": null,
"description": "Name of the entry",
"args": [
],
......@@ -12886,7 +12886,7 @@
},
{
"name": "path",
"description": null,
"description": "Path of the entry",
"args": [
],
......@@ -12904,7 +12904,7 @@
},
{
"name": "sha",
"description": "Last commit sha for entry",
"description": "Last commit sha for the entry",
"args": [
],
......@@ -12922,7 +12922,7 @@
},
{
"name": "type",
"description": null,
"description": "Type of tree entry",
"args": [
],
......@@ -13108,7 +13108,7 @@
"fields": [
{
"name": "flatPath",
"description": null,
"description": "Flat path of the entry",
"args": [
],
......@@ -13126,7 +13126,7 @@
},
{
"name": "id",
"description": null,
"description": "ID of the entry",
"args": [
],
......@@ -13144,7 +13144,7 @@
},
{
"name": "name",
"description": null,
"description": "Name of the entry",
"args": [
],
......@@ -13162,7 +13162,7 @@
},
{
"name": "path",
"description": null,
"description": "Path of the entry",
"args": [
],
......@@ -13180,7 +13180,7 @@
},
{
"name": "sha",
"description": "Last commit sha for entry",
"description": "Last commit sha for the entry",
"args": [
],
......@@ -13198,7 +13198,7 @@
},
{
"name": "treeUrl",
"description": null,
"description": "Tree URL for the sub-module",
"args": [
],
......@@ -13212,7 +13212,7 @@
},
{
"name": "type",
"description": null,
"description": "Type of tree entry",
"args": [
],
......@@ -13230,7 +13230,7 @@
},
{
"name": "webUrl",
"description": null,
"description": "Web URL for the sub-module",
"args": [
],
......@@ -13373,7 +13373,7 @@
"fields": [
{
"name": "flatPath",
"description": null,
"description": "Flat path of the entry",
"args": [
],
......@@ -13391,7 +13391,7 @@
},
{
"name": "id",
"description": null,
"description": "ID of the entry",
"args": [
],
......@@ -13409,7 +13409,7 @@
},
{
"name": "lfsOid",
"description": null,
"description": "LFS ID of the blob",
"args": [
],
......@@ -13423,7 +13423,7 @@
},
{
"name": "name",
"description": null,
"description": "Name of the entry",
"args": [
],
......@@ -13441,7 +13441,7 @@
},
{
"name": "path",
"description": null,
"description": "Path of the entry",
"args": [
],
......@@ -13459,7 +13459,7 @@
},
{
"name": "sha",
"description": "Last commit sha for entry",
"description": "Last commit sha for the entry",
"args": [
],
......@@ -13477,7 +13477,7 @@
},
{
"name": "type",
"description": null,
"description": "Type of tree entry",
"args": [
],
......@@ -13495,7 +13495,7 @@
},
{
"name": "webUrl",
"description": null,
"description": "Web URL of the blob",
"args": [
],
......
doc/api/graphql/reference/index.md
View file @ d3036faf
......@@ -35,14 +35,14 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph
| Name | Type | Description |
| --- | ---- | ---------- |
| `id` | ID! | |
| `sha` | String! | Last commit sha for entry |
| `name` | String! | |
| `type` | EntryType! | |
| `path` | String! | |
| `flatPath` | String! | |
| `webUrl` | String | |
| `lfsOid` | String | |
| `id` | ID! | ID of the entry |
| `sha` | String! | Last commit sha for the entry |
| `name` | String! | Name of the entry |
| `type` | EntryType! | Type of tree entry |
| `path` | String! | Path of the entry |
| `flatPath` | String! | Flat path of the entry |
| `webUrl` | String | Web URL of the blob |
| `lfsOid` | String | LFS ID of the blob |
### Commit
......@@ -856,14 +856,14 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph
| Name | Type | Description |
| --- | ---- | ---------- |
| `id` | ID! | |
| `sha` | String! | Last commit sha for entry |
| `name` | String! | |
| `type` | EntryType! | |
| `path` | String! | |
| `flatPath` | String! | |
| `webUrl` | String | |
| `treeUrl` | String | |
| `id` | ID! | ID of the entry |
| `sha` | String! | Last commit sha for the entry |
| `name` | String! | Name of the entry |
| `type` | EntryType! | Type of tree entry |
| `path` | String! | Path of the entry |
| `flatPath` | String! | Flat path of the entry |
| `webUrl` | String | Web URL for the sub-module |
| `treeUrl` | String | Tree URL for the sub-module |
### TaskCompletionStatus
......@@ -938,13 +938,13 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph
| Name | Type | Description |
| --- | ---- | ---------- |
| `id` | ID! | |
| `sha` | String! | Last commit sha for entry |
| `name` | String! | |
| `type` | EntryType! | |
| `path` | String! | |
| `flatPath` | String! | |
| `webUrl` | String | |
| `id` | ID! | ID of the entry |
| `sha` | String! | Last commit sha for the entry |
| `name` | String! | Name of the entry |
| `type` | EntryType! | Type of tree entry |
| `path` | String! | Path of the entry |
| `flatPath` | String! | Flat path of the entry |
| `webUrl` | String | Web URL for the tree entry (directory) |
### UpdateEpicPayload
......
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