Skip to content
This repository has been archived by the owner on Oct 1, 2024. It is now read-only.

Latest commit

 

History

History
524 lines (298 loc) · 12.7 KB

AdminApi.md

File metadata and controls

524 lines (298 loc) · 12.7 KB

\AdminApi

All URIs are relative to http://localhost:3000/api/1.0

Method HTTP request Description
CreateFeatureFlag Post /admin/feature-flag Create feature flag.
CreateTarget Post /admin/target Create target.
CreateTargetSegment Post /admin/target-segment Create target segment.
DeleteFeatureFlag Delete /admin/feature-flag/{id} Delete feature flag.
DeleteTarget Delete /admin/target/{id} Delete target.
DeleteTargetSegment Delete /admin/target-segment/{id} Delete target segment.
GetAllFeatureFlags Get /admin/feature-flag Retrieve all feature flags.
GetAllTargetSegments Get /admin/target-segment Retrieve all target segments.
GetAllTargets Get /admin/target Retrieve all targets.
GetFeatureFlag Get /admin/feature-flag/{id} Retrieve feature flag.
GetTarget Get /admin/target/{id} Retrieve target.
GetTargetSegment Get /admin/target-segment/{id} Retrieve target segment.
ModifyFeatureFlag Patch /admin/feature-flag/{id} Modify feature flag.
ModifyTarget Patch /admin/target/{id} Modify target.
ModifyTargetSegment Patch /admin/target-segment/{id} Modify target segment.

CreateFeatureFlag

CreateFeatureFlag(ctx, featureFlag)

Create feature flag.

Used to create feature flag.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
featureFlag FeatureFlag

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateTarget

CreateTarget(ctx, target)

Create target.

Used to create target.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
target Target

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateTargetSegment

CreateTargetSegment(ctx, targetSegment)

Create target segment.

Used to create target segment.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
targetSegment TargetSegment

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteFeatureFlag

DeleteFeatureFlag(ctx, id)

Delete feature flag.

Used to delete feature flag with certain id and account id.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string resource ID

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteTarget

DeleteTarget(ctx, id)

Delete target.

Used to delete target with certain id and account id.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string resource ID

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteTargetSegment

DeleteTargetSegment(ctx, id)

Delete target segment.

Used to delete target segment with certain id and account id.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string resource ID

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllFeatureFlags

FeatureFlag GetAllFeatureFlags(ctx, )

Retrieve all feature flags.

Used to retrieve all feature flags for certain account id.

Required Parameters

This endpoint does not need any parameter.

Return type

FeatureFlag

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllTargetSegments

TargetSegment GetAllTargetSegments(ctx, )

Retrieve all target segments.

Used to retrieve all target segments for certain account id.

Required Parameters

This endpoint does not need any parameter.

Return type

TargetSegment

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllTargets

Target GetAllTargets(ctx, )

Retrieve all targets.

Used to retrieve all targets for certain account id.

Required Parameters

This endpoint does not need any parameter.

Return type

Target

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetFeatureFlag

FeatureFlag GetFeatureFlag(ctx, id)

Retrieve feature flag.

Used to retrieve certain feature flags for certain id and account id.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string resource ID

Return type

FeatureFlag

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTarget

Target GetTarget(ctx, id)

Retrieve target.

Used to retrieve certain target for certain id and account id.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string resource ID

Return type

Target

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTargetSegment

TargetSegment GetTargetSegment(ctx, id)

Retrieve target segment.

Used to retrieve certain target segment for certain id and account id.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string resource ID

Return type

TargetSegment

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyFeatureFlag

FeatureFlag ModifyFeatureFlag(ctx, id, featureFlag)

Modify feature flag.

Used to modify feature flag with certain id and account id.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string resource ID
featureFlag FeatureFlag

Return type

FeatureFlag

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyTarget

Target ModifyTarget(ctx, id, target)

Modify target.

Used to modify target with certain id and account id.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string resource ID
target Target

Return type

Target

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyTargetSegment

TargetSegment ModifyTargetSegment(ctx, id, targetSegment)

Modify target segment.

Used to modify target segment with certain id and account id.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string resource ID
targetSegment TargetSegment

Return type

TargetSegment

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]