Skip to content

Latest commit

 

History

History
382 lines (236 loc) · 7.83 KB

FlagApi.md

File metadata and controls

382 lines (236 loc) · 7.83 KB
Raw

Flagr::FlagApi

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

Method HTTP request Description
create_flag POST /flags
delete_flag DELETE /flags/{flagID}
find_flags GET /flags
get_flag GET /flags/{flagID}
get_flag_entity_types GET /flags/entity_types
get_flag_snapshots GET /flags/{flagID}/snapshots
put_flag PUT /flags/{flagID}
set_flag_enabled PUT /flags/{flagID}/enabled

create_flag

Flag create_flag(body)

Example

# load the gem
require 'rbflagr'

api_instance = Flagr::FlagApi.new

body = Flagr::CreateFlagRequest.new # CreateFlagRequest | create a flag


begin
  result = api_instance.create_flag(body)
  p result
rescue Flagr::ApiError => e
  puts "Exception when calling FlagApi->create_flag: #{e}"
end

Parameters

Name Type Description Notes
body CreateFlagRequest create a flag

Return type

Flag

Authorization

No authorization required

HTTP request headers

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

delete_flag

delete_flag(flag_id)

Example

# load the gem
require 'rbflagr'

api_instance = Flagr::FlagApi.new

flag_id = 789 # Integer | numeric ID of the flag


begin
  api_instance.delete_flag(flag_id)
rescue Flagr::ApiError => e
  puts "Exception when calling FlagApi->delete_flag: #{e}"
end

Parameters

Name Type Description Notes
flag_id Integer numeric ID of the flag

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

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

find_flags

Array<Flag> find_flags(opts)

Example

# load the gem
require 'rbflagr'

api_instance = Flagr::FlagApi.new

opts = { 
  limit: 789, # Integer | the numbers of flags to return
  enabled: true, # BOOLEAN | return flags having given enabled status
  description: 'description_example', # String | return flags exactly matching given description
  tags: 'tags_example', # String | return flags with the given tags (comma separated)
  description_like: 'description_like_example', # String | return flags partially matching given description
  key: 'key_example', # String | return flags matching given key
  offset: 789, # Integer | return flags given the offset, it should usually set together with limit
  preload: true # BOOLEAN | return flags with preloaded segments and variants
}

begin
  result = api_instance.find_flags(opts)
  p result
rescue Flagr::ApiError => e
  puts "Exception when calling FlagApi->find_flags: #{e}"
end

Parameters

Name Type Description Notes
limit Integer the numbers of flags to return [optional]
enabled BOOLEAN return flags having given enabled status [optional]
description String return flags exactly matching given description [optional]
tags String return flags with the given tags (comma separated) [optional]
description_like String return flags partially matching given description [optional]
key String return flags matching given key [optional]
offset Integer return flags given the offset, it should usually set together with limit [optional]
preload BOOLEAN return flags with preloaded segments and variants [optional]

Return type

Array<Flag>

Authorization

No authorization required

HTTP request headers

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

get_flag

Flag get_flag(flag_id)

Example

# load the gem
require 'rbflagr'

api_instance = Flagr::FlagApi.new

flag_id = 789 # Integer | numeric ID of the flag to get


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

Parameters

Name Type Description Notes
flag_id Integer numeric ID of the flag to get

Return type

Flag

Authorization

No authorization required

HTTP request headers

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

get_flag_entity_types

Array<String> get_flag_entity_types

Example

# load the gem
require 'rbflagr'

api_instance = Flagr::FlagApi.new

begin
  result = api_instance.get_flag_entity_types
  p result
rescue Flagr::ApiError => e
  puts "Exception when calling FlagApi->get_flag_entity_types: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Array<String>

Authorization

No authorization required

HTTP request headers

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

get_flag_snapshots

Array<FlagSnapshot> get_flag_snapshots(flag_id)

Example

# load the gem
require 'rbflagr'

api_instance = Flagr::FlagApi.new

flag_id = 789 # Integer | numeric ID of the flag to get


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

Parameters

Name Type Description Notes
flag_id Integer numeric ID of the flag to get

Return type

Array<FlagSnapshot>

Authorization

No authorization required

HTTP request headers

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

put_flag

Flag put_flag(flag_id, body)

Example

# load the gem
require 'rbflagr'

api_instance = Flagr::FlagApi.new

flag_id = 789 # Integer | numeric ID of the flag to get

body = Flagr::PutFlagRequest.new # PutFlagRequest | update a flag


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

Parameters

Name Type Description Notes
flag_id Integer numeric ID of the flag to get
body PutFlagRequest update a flag

Return type

Flag

Authorization

No authorization required

HTTP request headers

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

set_flag_enabled

Flag set_flag_enabled(flag_id, body)

Example

# load the gem
require 'rbflagr'

api_instance = Flagr::FlagApi.new

flag_id = 789 # Integer | numeric ID of the flag to get

body = Flagr::SetFlagEnabledRequest.new # SetFlagEnabledRequest | set flag enabled state


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

Parameters

Name Type Description Notes
flag_id Integer numeric ID of the flag to get
body SetFlagEnabledRequest set flag enabled state

Return type

Flag

Authorization

No authorization required

HTTP request headers

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