Class: PlatformAPI::ReviewAppConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

Review apps can be configured for pipelines.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ReviewAppConfig

Returns a new instance of ReviewAppConfig.



2833
2834
2835
 
# File 'lib/platform-api/client.rb', line 2833

def initialize(client)
  @client = client
end

Instance Method Details

#delete(pipeline_id) ⇒ Object

Disable review apps for a pipeline

Parameters:

  • pipeline_id: —

    unique identifier of pipeline



2863
2864
2865
 
# File 'lib/platform-api/client.rb', line 2863

def delete(pipeline_id)
  @client.review_app_config.delete(pipeline_id)
end

#enable(pipeline_id, body = {}) ⇒ Object

Enable review apps for a pipeline

Parameters:

  • pipeline_id: —

    unique identifier of pipeline

  • body: —

    the object to pass as the request payload



2841
2842
2843
 
# File 'lib/platform-api/client.rb', line 2841

def enable(pipeline_id, body = {})
  @client.review_app_config.enable(pipeline_id, body)
end

#info(pipeline_id) ⇒ Object

Get review apps configuration for a pipeline

Parameters:

  • pipeline_id: —

    unique identifier of pipeline



2848
2849
2850
 
# File 'lib/platform-api/client.rb', line 2848

def info(pipeline_id)
  @client.review_app_config.info(pipeline_id)
end

#update(pipeline_id, body = {}) ⇒ Object

Update review app configuration for a pipeline

Parameters:

  • pipeline_id: —

    unique identifier of pipeline

  • body: —

    the object to pass as the request payload



2856
2857
2858
 
# File 'lib/platform-api/client.rb', line 2856

def update(pipeline_id, body = {})
  @client.review_app_config.update(pipeline_id, body)
end