Class: SemgrepWebApp::SecretsServiceApi

Inherits:
BaseApi
  • Object
show all
Defined in:
lib/semgrep_web_app/apis/secrets_service_api.rb

Overview

SecretsServiceApi

Constant Summary

Constants inherited from BaseApi

BaseApi::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseApi

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseApi

#initialize, #new_parameter, #new_request_builder, #new_response_handler, user_agent, user_agent_parameters

Constructor Details

This class inherits a constructor from SemgrepWebApp::BaseApi

Instance Method Details

#list_secrets_path(deployment_id, cursor: nil, limit: nil, since: nil, validation_state: nil, status: Status8::FINDING_STATUS_UNSPECIFIED, severity: nil, repo: nil) ⇒ ApiResponse

TODO: type endpoint description here here TODO: type description here Example:FINDING_STATUS_UNSPECIFIED description here here

Parameters:

  • deployment_id (String) —

    Required parameter: TODO: type description

  • cursor (String) (defaults to: nil) —

    Optional parameter: TODO: type description here

  • limit (Integer) (defaults to: nil) —

    Optional parameter: TODO: type description here

  • since (DateTime) (defaults to: nil) —

    Optional parameter: TODO: type description here

  • validation_state (Array[ValidationState3]) (defaults to: nil) —

    Optional parameter:

  • status (Status8) (defaults to: Status8::FINDING_STATUS_UNSPECIFIED) —

    Optional parameter:

  • severity (Array[Severity5]) (defaults to: nil) —

    Optional parameter: TODO: type

  • repo (Array[String]) (defaults to: nil) —

    Optional parameter: TODO: type description

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



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
 
# File 'lib/semgrep_web_app/apis/secrets_service_api.rb', line 24

def list_secrets_path(deployment_id,
                      cursor: nil,
                      limit: nil,
                      since: nil,
                      validation_state: nil,
                      status: Status8::FINDING_STATUS_UNSPECIFIED,
                      severity: nil,
                      repo: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/api/v1/deployments/{deploymentId}/secrets',
                                 Server::SEMGREP)
               .template_param(new_parameter(deployment_id, key: 'deploymentId')
                                .is_required(true)
                                .should_encode(true))
               .query_param(new_parameter(cursor, key: 'cursor'))
               .query_param(new_parameter(limit, key: 'limit'))
               .query_param(new_parameter(since, key: 'since'))
               .query_param(new_parameter(validation_state, key: 'validationState'))
               .query_param(new_parameter(status, key: 'status'))
               .query_param(new_parameter(severity, key: 'severity'))
               .query_param(new_parameter(repo, key: 'repo'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('SemgrepWebToken')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProtosOpenapiV1ListSecretsPathResponse.method(:from_hash))
                .is_api_response(true))
    .execute
end