Class: CloudsmithApi::AuditLogApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudsmith-api/api/audit_log_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuditLogApi

Returns a new instance of AuditLogApi.



19
20
21
 
# File 'lib/cloudsmith-api/api/audit_log_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cloudsmith-api/api/audit_log_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#audit_log_namespace_list(owner, opts = {}) ⇒ Array<NamespaceAuditLog>

Lists audit log entries for a specific namespace. Lists audit log entries for a specific namespace.

Parameters:

  • owner
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :query (String) —

    A search term for querying events, actors, or timestamps of log records.

Returns:



30
31
32
33
 
# File 'lib/cloudsmith-api/api/audit_log_api.rb', line 30

def audit_log_namespace_list(owner, opts = {})
  data, _status_code, _headers = audit_log_namespace_list_with_http_info(owner, opts)
  data
end

#audit_log_namespace_list_with_http_info(owner, opts = {}) ⇒ Array<(Array<NamespaceAuditLog>, Fixnum, Hash)>

Lists audit log entries for a specific namespace. Lists audit log entries for a specific namespace.

Parameters:

  • owner
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :query (String) —

    A search term for querying events, actors, or timestamps of log records.

Returns:

  • (Array<(Array<NamespaceAuditLog>, Fixnum, Hash)>) —

    Array<NamespaceAuditLog> data, response status code and response headers



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
 
# File 'lib/cloudsmith-api/api/audit_log_api.rb', line 43

def audit_log_namespace_list_with_http_info(owner, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuditLogApi.audit_log_namespace_list ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling AuditLogApi.audit_log_namespace_list"
  end
  # resource path
  local_var_path = '/audit-log/{owner}/'.sub('{' + 'owner' + '}', owner.to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<NamespaceAuditLog>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuditLogApi#audit_log_namespace_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#audit_log_repo_list(owner, repo, opts = {}) ⇒ Array<RepositoryAuditLog>

Lists audit log entries for a specific repository. Lists audit log entries for a specific repository.

Parameters:

  • owner
  • repo
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :query (String) —

    A search term for querying events, actors, or timestamps of log records.

Returns:



94
95
96
97
 
# File 'lib/cloudsmith-api/api/audit_log_api.rb', line 94

def audit_log_repo_list(owner, repo, opts = {})
  data, _status_code, _headers = audit_log_repo_list_with_http_info(owner, repo, opts)
  data
end

#audit_log_repo_list_with_http_info(owner, repo, opts = {}) ⇒ Array<(Array<RepositoryAuditLog>, Fixnum, Hash)>

Lists audit log entries for a specific repository. Lists audit log entries for a specific repository.

Parameters:

  • owner
  • repo
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :query (String) —

    A search term for querying events, actors, or timestamps of log records.

Returns:

  • (Array<(Array<RepositoryAuditLog>, Fixnum, Hash)>) —

    Array<RepositoryAuditLog> data, response status code and response headers



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/cloudsmith-api/api/audit_log_api.rb', line 108

def audit_log_repo_list_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuditLogApi.audit_log_repo_list ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling AuditLogApi.audit_log_repo_list"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling AuditLogApi.audit_log_repo_list"
  end
  # resource path
  local_var_path = '/audit-log/{owner}/{repo}/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<RepositoryAuditLog>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuditLogApi#audit_log_repo_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end