summaryrefslogtreecommitdiff
path: root/app/graphql/types/snippet_type.rb
blob: c345aea08bd764acbf0bb070ca8c58fb77210405 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# frozen_string_literal: true

module Types
  class SnippetType < BaseObject
    graphql_name 'Snippet'
    description 'Represents a snippet entry'

    implements(Types::Notes::NoteableInterface)

    present_using SnippetPresenter

    authorize :read_snippet

    expose_permissions Types::PermissionTypes::Snippet

    field :id, Types::GlobalIDType[::Snippet],
          description: 'ID of the snippet.',
          null: false

    field :title, GraphQL::Types::String,
          description: 'Title of the snippet.',
          null: false

    field :project, Types::ProjectType,
          description: 'The project the snippet is associated with.',
          null: true,
          authorize: :read_project

    # Author can be nil in some scenarios. For example,
    # when the admin setting restricted visibility
    # level is set to public
    field :author, Types::UserType,
          description: 'The owner of the snippet.',
          null: true

    field :file_name, GraphQL::Types::String,
          description: 'File Name of the snippet.',
          null: true

    field :description, GraphQL::Types::String,
          description: 'Description of the snippet.',
          null: true

    field :visibility_level, Types::VisibilityLevelsEnum,
          description: 'Visibility Level of the snippet.',
          null: false

    field :created_at, Types::TimeType,
          description: 'Timestamp this snippet was created.',
          null: false

    field :updated_at, Types::TimeType,
          description: 'Timestamp this snippet was updated.',
          null: false

    field :web_url, type: GraphQL::Types::String,
          description: 'Web URL of the snippet.',
          null: false

    field :raw_url, type: GraphQL::Types::String,
          description: 'Raw URL of the snippet.',
          null: false

    field :blobs, type: Types::Snippets::BlobType.connection_type,
          description: 'Snippet blobs.',
          calls_gitaly: true,
          null: true,
          resolver: Resolvers::Snippets::BlobsResolver

    field :ssh_url_to_repo, type: GraphQL::Types::String,
          description: 'SSH URL to the snippet repository.',
          calls_gitaly: true,
          null: true

    field :http_url_to_repo, type: GraphQL::Types::String,
          description: 'HTTP URL to the snippet repository.',
          calls_gitaly: true,
          null: true

    markdown_field :description_html, null: true, method: :description

    def author
      Gitlab::Graphql::Loaders::BatchModelLoader.new(User, object.author_id).find
    end

    def project
      Gitlab::Graphql::Loaders::BatchModelLoader.new(Project, object.project_id).find
    end
  end
end