Flagr::ConstraintApi

October 19, 2017 ยท View on GitHub

All URIs are relative to http://localhost/api/v1

MethodHTTP requestDescription
create_constraintPOST /flags/{flagID}/segments/{segmentID}/constraints
delete_constraintDELETE /flags/{flagID}/segments/{segmentID}/constraints/{constraintID}
find_constraintsGET /flags/{flagID}/segments/{segmentID}/constraints
put_constraintPUT /flags/{flagID}/segments/{segmentID}/constraints/{constraintID}

create_constraint

Constraint create_constraint(flag_id, segment_id, body)

Example

# load the gem
require 'rbflagr'

api_instance = Flagr::ConstraintApi.new

flag_id = 789 # Integer | numeric ID of the flag

segment_id = 789 # Integer | numeric ID of the segment

body = Flagr::CreateConstraintRequest.new # CreateConstraintRequest | create a constraint


begin
  result = api_instance.create_constraint(flag_id, segment_id, body)
  p result
rescue Flagr::ApiError => e
  puts "Exception when calling ConstraintApi->create_constraint: #{e}"
end

Parameters

NameTypeDescriptionNotes
flag_idIntegernumeric ID of the flag
segment_idIntegernumeric ID of the segment
bodyCreateConstraintRequestcreate a constraint

Return type

Constraint

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

delete_constraint

delete_constraint(flag_id, segment_id, constraint_id)

Example

# load the gem
require 'rbflagr'

api_instance = Flagr::ConstraintApi.new

flag_id = 789 # Integer | numeric ID of the flag

segment_id = 789 # Integer | numeric ID of the segment

constraint_id = 789 # Integer | numeric ID of the constraint


begin
  api_instance.delete_constraint(flag_id, segment_id, constraint_id)
rescue Flagr::ApiError => e
  puts "Exception when calling ConstraintApi->delete_constraint: #{e}"
end

Parameters

NameTypeDescriptionNotes
flag_idIntegernumeric ID of the flag
segment_idIntegernumeric ID of the segment
constraint_idIntegernumeric ID of the constraint

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

find_constraints

Array<Constraint> find_constraints(flag_id, segment_id)

Example

# load the gem
require 'rbflagr'

api_instance = Flagr::ConstraintApi.new

flag_id = 789 # Integer | numeric ID of the flag

segment_id = 789 # Integer | numeric ID of the segment


begin
  result = api_instance.find_constraints(flag_id, segment_id)
  p result
rescue Flagr::ApiError => e
  puts "Exception when calling ConstraintApi->find_constraints: #{e}"
end

Parameters

NameTypeDescriptionNotes
flag_idIntegernumeric ID of the flag
segment_idIntegernumeric ID of the segment

Return type

Array<Constraint>

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

put_constraint

Constraint put_constraint(flag_id, segment_id, constraint_id, body)

Example

# load the gem
require 'rbflagr'

api_instance = Flagr::ConstraintApi.new

flag_id = 789 # Integer | numeric ID of the flag

segment_id = 789 # Integer | numeric ID of the segment

constraint_id = 789 # Integer | numeric ID of the constraint

body = Flagr::CreateConstraintRequest.new # CreateConstraintRequest | create a constraint


begin
  result = api_instance.put_constraint(flag_id, segment_id, constraint_id, body)
  p result
rescue Flagr::ApiError => e
  puts "Exception when calling ConstraintApi->put_constraint: #{e}"
end

Parameters

NameTypeDescriptionNotes
flag_idIntegernumeric ID of the flag
segment_idIntegernumeric ID of the segment
constraint_idIntegernumeric ID of the constraint
bodyCreateConstraintRequestcreate a constraint

Return type

Constraint

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json