ff-ruby-server-sdk 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dee84b9df38fbf84679cc05accc99fcca8f0c44ae7df00b5786ea34c2990569
-  data.tar.gz: bdcdad8c786cb642a4261801c25f140511dd1a6789696d33b3a59d913e42c591
+  metadata.gz: aba1a45b397eb95bc2553bc91bea245d08afbbd22ca554002aa193253a32c6c8
+  data.tar.gz: '08d95e3f7102bf3464f9bce2e7b215141ab86dbaf26f442ece6ccd483c628f00'
 SHA512:
-  metadata.gz: 168e0964f465430c0639560daaf8ae72d161e6153e268e2fc0f62da5a6a19dca36bbfa03af069b99d2c8de4a246491d61e0206e7a3cfb94403c0eaa24c8b20ef
-  data.tar.gz: 1daa90440c9bc18c305433eee228ed241400625b757e23442ec02b9df998e9d98b52cba1aa71917438b8a5d9e6d7462705e7fd58ccfc936ea52a13c77cc9725c
+  metadata.gz: b7cbe6267b64b4fa05589dc3255fb49d97d3e3a859a1b17779dc26f611ddb2138ce5e71f2bd8d6f4370a5bfc3966d5757e9e889df2ded6d04df79f4ec5546d9f
+  data.tar.gz: 0fed32b0db4f07ca3a1961a9ce86257711ab47d2a93847c686adf322fc38f347dd5d4bd90c7ed4ad276f5982d394b3b03f44b32296db257142a943f37ebc5662

data/api.yaml

@@ -14,6 +14,8 @@ servers:
 tags:
   - name: client
   - name: metrics
+  - name: Proxy
+    description: APIs used by the ff-proxy
 paths:
   '/client/env/{environmentUUID}/feature-configs':
     get:
@@ -29,8 +31,9 @@ paths:
           description: Unique identifier for the environment object in the API.
           schema:
             type: string
+        - $ref: '#/components/parameters/clusterQueryOptionalParam'
       security:
-        - BearerAuth: [ ]
+        - BearerAuth: []
       responses:
         '200':
           description: OK
@@ -59,8 +62,9 @@ paths:
           description: Unique identifier for the environment object in the API.
           schema:
             type: string
+        - $ref: '#/components/parameters/clusterQueryOptionalParam'
       security:
-        - BearerAuth: [ ]
+        - BearerAuth: []
       responses:
         '200':
           description: OK
@@ -82,8 +86,10 @@ paths:
           description: Unique identifier for the environment object in the API.
           schema:
             type: string
+        - $ref: '#/components/parameters/clusterQueryOptionalParam'
+        - $ref: '#/components/parameters/segmentRulesV2QueryParam'
       security:
-        - BearerAuth: [ ]
+        - BearerAuth: []
       responses:
         '200':
           description: OK
@@ -121,8 +127,10 @@ paths:
           description: Unique identifier for the environment object in the API
           schema:
             type: string
+        - $ref: '#/components/parameters/clusterQueryOptionalParam'
+        - $ref: '#/components/parameters/segmentRulesV2QueryParam'
       security:
-        - BearerAuth: [ ]
+        - BearerAuth: []
       responses:
         '200':
           description: OK
@@ -184,8 +192,9 @@ paths:
           description: Unique identifier for the target object in the API.
           schema:
             type: string
+        - $ref: '#/components/parameters/clusterQueryOptionalParam'
       security:
-        - BearerAuth: [ ]
+        - BearerAuth: []
       responses:
         '200':
           description: OK
@@ -194,10 +203,7 @@ paths:
               schema:
                 allOf:
                   - $ref: '#/components/schemas/Pagination'
-                  - type: object
-                    properties:
-                      evaluations:
-                        $ref: '#/components/schemas/Evaluations'
+                  - $ref: '#/components/schemas/Evaluations'
   '/client/env/{environmentUUID}/target/{target}/evaluations/{feature}':
     get:
       summary: Get feature evaluations for target
@@ -223,8 +229,9 @@ paths:
           description: Unique identifier for the target object in the API.
           schema:
             type: string
+        - $ref: '#/components/parameters/clusterQueryOptionalParam'
       security:
-        - BearerAuth: [ ]
+        - BearerAuth: []
       responses:
         '200':
           description: OK
@@ -232,7 +239,7 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Evaluation'
-  '/metrics/{environment}':
+  '/metrics/{environmentUUID}':
     post:
       tags:
         - metrics
@@ -241,13 +248,15 @@ paths:
       operationId: postMetrics
       parameters:
         - $ref: '#/components/parameters/environmentPathParam'
+        - $ref: '#/components/parameters/clusterQueryOptionalParam'
       requestBody:
         content:
           application/json:
             schema:
               $ref: '#/components/schemas/Metrics'
       security:
-        - BearerAuth: [ ]
+        - ApiKeyAuth: []
+        - BearerAuth: []
       responses:
         '200':
           description: OK
@@ -269,8 +278,9 @@ paths:
           schema:
             type: string
           required: true
+        - $ref: '#/components/parameters/clusterQueryOptionalParam'
       security:
-        - BearerAuth: [ ]
+        - BearerAuth: []
       responses:
         '200':
           description: OK
@@ -293,65 +303,175 @@ paths:
                 default: '*'
         '503':
           description: Service Unavailable
+  /proxy/config:
+    get:
+      summary: Gets Proxy config for multiple environments
+      description: >-
+        Gets Proxy config for multiple environments if the Key query param is
+        provided or gets config for a single environment if an environment query
+        param is provided
+      operationId: GetProxyConfig
+      tags:
+        - Proxy
+      parameters:
+        - $ref: '#/components/parameters/pageNumber'
+        - $ref: '#/components/parameters/pageSize'
+        - $ref: '#/components/parameters/clusterQueryOptionalParam'
+        - in: query
+          name: environment
+          description: >-
+            Accepts an EnvironmentID. If this is provided then the endpoint will
+            only return config for this environment. If this is left empty then
+            the Proxy will return config for all environments associated with
+            the Proxy Key.
+          required: false
+          schema:
+            type: string
+        - in: query
+          name: key
+          description: Accpets a Proxy Key.
+          required: true
+          schema:
+            type: string
+      security:
+        - BearerAuth: []
+      responses:
+        '200':
+          $ref: '#/components/responses/ProxyConfigResponse'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '401':
+          $ref: '#/components/responses/Unauthenticated'
+        '403':
+          $ref: '#/components/responses/Unauthorized'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '500':
+          $ref: '#/components/responses/InternalServerError'
+  /proxy/auth:
+    post:
+      summary: Endpoint that the Proxy can use to authenticate with the client server
+      description: Endpoint that the Proxy can use to authenticate with the client server
+      operationId: AuthenticateProxyKey
+      tags:
+        - Proxy
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                proxyKey:
+                  type: string
+                  example: 896045f3-42ee-4e73-9154-086644768b96
+              required:
+                - proxyKey
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AuthenticationResponse'
+        '401':
+          $ref: '#/components/responses/Unauthenticated'
+        '403':
+          $ref: '#/components/responses/Unauthorized'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '500':
+          $ref: '#/components/responses/InternalServerError'
 components:
   schemas:
     FeatureState:
       type: string
+      description: The state of a flag either off or on
       enum:
         - 'on'
         - 'off'
     Variation:
       type: object
+      description: A variation of a flag that can be returned to a target
       properties:
         identifier:
           type: string
+          description: The unique identifier for the variation
+          example: off-variation
         value:
           type: string
+          description: >-
+            The variation value to serve such as true or false for a boolean
+            flag
+          example: 'true'
         name:
           type: string
+          description: The user friendly name of the variation
+          example: Off VAriation
         description:
           type: string
+          description: A description of the variation
       required:
         - identifier
         - value
     Clause:
       type: object
+      description: A clause describes what conditions are used to evaluate a flag
       properties:
         id:
           type: string
+          description: The unique ID for the clause
+          example: 32434243
         attribute:
           type: string
+          description: >-
+            The attribute to use in the clause.  This can be any target
+            attribute
+          example: identifier
         op:
           type: string
+          description: 'The type of operation such as equals, starts_with, contains'
+          example: starts_with
         values:
           type: array
+          description: The values that are compared against the operator
           items:
             type: string
         negate:
           type: boolean
+          description: Is the operation negated?
+          example: false
       required:
-        - id
         - attribute
         - op
         - negate
         - values
     WeightedVariation:
       type: object
+      description: >-
+        A variation and the weighting it should receive as part of a percentage
+        rollout
       properties:
         variation:
           type: string
+          description: The variation identifier
+          example: off-variation
         weight:
           type: integer
+          description: The weight to be given to the variation in percent
+          example: 50
       required:
         - variation
         - weight
     Distribution:
       type: object
+      description: Describes a distribution rule
       properties:
         bucketBy:
           type: string
+          description: The attribute to use when distributing targets across buckets
         variations:
           type: array
+          description: A list of variations and the weight that should be given to each
           items:
             $ref: '#/components/schemas/WeightedVariation'
       required:
@@ -359,6 +479,9 @@ components:
         - variations
     Serve:
       type: object
+      description: >-
+        Describe the distribution rule and the variation that should be served
+        to the target
       properties:
         distribution:
           $ref: '#/components/schemas/Distribution'
@@ -366,13 +489,20 @@ components:
           type: string
     ServingRule:
       type: object
+      description: The rule used to determine what variation to serve to a target
       properties:
         ruleId:
           type: string
+          description: The unique identifier for this rule
         priority:
           type: integer
+          description: >-
+            The rules priority relative to other rules.  The rules are evaluated
+            in order with 1 being the highest
+          example: 1
         clauses:
           type: array
+          description: A list of clauses to use in the rule
           items:
             $ref: '#/components/schemas/Clause'
         serve:
@@ -381,14 +511,16 @@ components:
         - priority
         - clauses
         - serve
-        - ruleId
     Prerequisite:
       type: object
+      description: Feature Flag pre-requisites
       properties:
         feature:
           type: string
+          description: The feature identifier that is the prerequisite
         variations:
           type: array
+          description: A list of variations that must be met
           items:
             type: string
       required:
@@ -396,25 +528,35 @@ components:
         - variations
     TargetMap:
       type: object
+      description: Target map provides the details of a target that belongs to a flag
       properties:
         identifier:
           type: string
+          description: The identifier for the target
         name:
           type: string
+          description: The name of the target
       required:
-        - idenfifier
+        - identifier
         - name
     VariationMap:
       type: object
+      description: >-
+        A mapping of variations to targets and target groups (segments).  The
+        targets listed here should receive this variation.
       properties:
         variation:
           type: string
+          description: The variation identifier
+          example: off-variation
         targets:
           type: array
+          description: A list of target mappings
           items:
             $ref: '#/components/schemas/TargetMap'
         targetSegments:
           type: array
+          description: A list of target groups (segments)
           items:
             type: string
       required:
@@ -468,86 +610,123 @@ components:
         - state
         - kind
         - variations
-        - defaultTarget
         - offVariation
         - defaultServe
     Tag:
       type: object
-      description: A name and value pair.
+      description: A Tag object used to tag feature flags - consists of name and identifier
       properties:
         name:
           type: string
-        value:
+          description: The name of the tag
+          example: feature-flag-tag-1
+        identifier:
           type: string
+          description: The identifier of the tag
+          example: feature-flag-tag-1
       required:
         - name
+        - identifier
     Segment:
       type: object
+      description: A Target Group (Segment) response
       properties:
         identifier:
           type: string
-          description: Unique identifier for the segment.
+          description: Unique identifier for the target group.
         name:
           type: string
-          description: Name of the segment.
+          description: Name of the target group.
           example: Beta Testers
         environment:
           type: string
+          description: The environment this target group belongs to
+          example: Production
         tags:
           type: array
+          description: Tags for this target group
           items:
             $ref: '#/components/schemas/Tag'
         included:
           type: array
+          description: A list of Targets who belong to this target group
           items:
             $ref: '#/components/schemas/Target'
         excluded:
           type: array
+          description: A list of Targets who are excluded from this target group
           items:
             $ref: '#/components/schemas/Target'
         rules:
           type: array
           items:
             $ref: '#/components/schemas/Clause'
+        servingRules:
+          type: array
+          items:
+            $ref: '#/components/schemas/GroupServingRule'
           description: >-
             An array of rules that can cause a user to be included in this
             segment.
         createdAt:
           type: integer
+          description: The data and time in milliseconds when the group was created
           format: int64
         modifiedAt:
           type: integer
+          description: The data and time in milliseconds when the group was last modified
           format: int64
         version:
           type: integer
+          description: >-
+            The version of this group.  Each time it is modified the version is
+            incremented
+          example: 1
           format: int64
       required:
         - identifier
         - name
     Target:
       type: object
+      description: A Target object
       properties:
         identifier:
           type: string
+          description: The unique identifier for this target
+          example: john-doe
         account:
           type: string
+          description: The account ID that the target belongs to
+          example: abcXDdffdaffd
         org:
           type: string
+          description: The identifier for the organization that the target belongs to
         environment:
           type: string
+          description: The identifier for the environment that the target belongs to
         project:
           type: string
+          description: The identifier for the project that this target belongs to
         name:
           type: string
+          description: The name of this Target
+          example: John Doe
         anonymous:
           type: boolean
+          description: Indicates if this target is anonymous
         attributes:
           type: object
+          description: a JSON representation of the attributes for this target
+          example:
+            age: 20
+            location: Belfast
         createdAt:
           type: integer
+          description: The date and time in milliseconds when this Target was created
           format: int64
         segments:
           type: array
+          description: A list of Target Groups (Segments) that this Target belongs to
           items:
             $ref: '#/components/schemas/Segment'
       required:
@@ -557,13 +736,42 @@ components:
         - project
         - account
         - org
+    GroupServingRule:
+      type: object
+      description: The rule used to determine what variation to serve to a target
+      properties:
+        ruleId:
+          type: string
+          description: The unique identifier for this rule
+        priority:
+          type: integer
+          description: >-
+            The rules priority relative to other rules.  The rules are evaluated
+            in order with 1 being the highest
+          example: 1
+        clauses:
+          type: array
+          description: A list of clauses to use in the rule
+          items:
+            $ref: '#/components/schemas/Clause'
+      required:
+        - ruleId
+        - clauses
+        - priority
     Error:
       type: object
       properties:
         code:
           type: string
+          description: The http error code
+          example: 404
         message:
           type: string
+          description: The reason the request failed
+          example: 'Error retrieving projects, organization ''default_org'' does not exist'
+        details:
+          type: object
+          description: Additional details about the error
       required:
         - code
         - message
@@ -600,23 +808,31 @@ components:
       properties:
         version:
           type: integer
+          description: >-
+            The version of this object.  The version will be incremented each
+            time the object is modified
+          example: 5
         pageCount:
           type: integer
+          description: The total number of pages
+          example: 100
         itemCount:
           type: integer
+          description: The total number of items
           example: 1
         pageSize:
           type: integer
+          description: The number of items per page
           example: 1
         pageIndex:
           type: integer
+          description: The current page
           example: 0
       required:
         - pageCount
         - itemCount
         - pageSize
         - pageIndex
-        - pageIndex
     Evaluation:
       type: object
       properties:
@@ -696,11 +912,80 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/MetricsData'
+    ProxyConfig:
+      type: object
+      description: TBD
+      allOf:
+        - $ref: '#/components/schemas/Pagination'
+        - properties:
+            environments:
+              type: array
+              items:
+                type: object
+                properties:
+                  id:
+                    type: string
+                  apiKeys:
+                    type: array
+                    items:
+                      type: string
+                  featureConfigs:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/FeatureConfig'
+                  segments:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Segment'
   securitySchemes:
+    ApiKeyAuth:
+      type: apiKey
+      in: header
+      name: api-key
     BearerAuth:
       type: http
       scheme: bearer
       bearerFormat: JWT
+  parameters:
+    clusterQueryOptionalParam:
+      name: cluster
+      in: query
+      required: false
+      description: Unique identifier for the cluster for the account
+      schema:
+        type: string
+    segmentRulesV2QueryParam:
+      name: rules
+      in: query
+      required: false
+      description: >-
+        When set to rules=v2 will return AND rule compatible serving_rules
+        field. When not set or set to any other value will return old rules
+        field only compatible with OR rules.
+      allowEmptyValue: true
+      schema:
+        type: string
+    environmentPathParam:
+      name: environmentUUID
+      in: path
+      required: true
+      description: environment parameter in query.
+      schema:
+        type: string
+    pageNumber:
+      name: pageNumber
+      in: query
+      required: false
+      description: PageNumber
+      schema:
+        type: integer
+    pageSize:
+      name: pageSize
+      in: query
+      required: false
+      description: PageSize
+      schema:
+        type: integer
   responses:
     Unauthenticated:
       description: Unauthenticated
@@ -726,11 +1011,15 @@ components:
         application/json:
           schema:
             $ref: '#/components/schemas/Error'
-  parameters:
-    environmentPathParam:
-      name: environment
-      in: path
-      required: true
-      description: environment parameter in query.
-      schema:
-        type: string
+    ProxyConfigResponse:
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/ProxyConfig'
+    BadRequest:
+      description: Bad request
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'