File: dictionary.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (43 lines) | stat: -rw-r--r-- 1,202 bytes parent folder | download
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
# frozen_string_literal: true

module API
  module Admin
    class Dictionary < ::API::Base
      feature_category :database
      urgency :low

      before do
        authenticated_as_admin!
      end

      namespace 'admin' do
        resources 'databases/:database_name/dictionary/tables/:table_name' do
          desc 'Retrieve dictionary details' do
            success ::API::Entities::Dictionary::Table
            failure [
              { code: 401, message: '401 Unauthorized' },
              { code: 403, message: '403 Forbidden' },
              { code: 404, message: '404 Not found' }
            ]
          end
          params do
            requires :database_name,
              type: String,
              values: %w[main ci],
              desc: 'The database name'

            requires :table_name,
              type: String,
              desc: 'The table name'
          end
          get do
            table_dictionary = ::Gitlab::Database::Dictionary.entry(params[:table_name])
            not_found!('Table not found') unless table_dictionary

            present table_dictionary, with: Entities::Dictionary::Table
          end
        end
      end
    end
  end
end