# Generated with protoc-gen-flipt-openapi openapi: 3.0.3 info: title: Common API version: 0.0.1 servers: - url: http://localhost:8080 paths: /api/v1/namespaces/{namespaceKey}/flags: get: tags: - Flipt - FlagsService operationId: listFlags parameters: - name: namespaceKey in: path required: true schema: type: string - name: limit in: query schema: type: integer format: int32 - name: offset in: query schema: type: integer format: int32 - name: pageToken in: query schema: type: string - name: reference in: query schema: type: string - name: environmentKey in: query schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/FlagList' /auth/v1/method/kubernetes/serviceaccount: post: tags: - AuthenticationMethodKubernetesService operationId: kubernetesVerifyServiceAccount requestBody: content: application/json: schema: $ref: '#/components/schemas/VerifyServiceAccountRequest' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VerifyServiceAccountResponse' /auth/v1/method/oidc/{provider}/authorize: get: tags: - AuthenticationMethodOIDCService operationId: oidcAuthorizeURL parameters: - name: provider in: path required: true schema: type: string - name: state in: query schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AuthorizeURLResponse' /auth/v1/method/oidc/{provider}/callback: get: tags: - AuthenticationMethodOIDCService operationId: oidcCallback parameters: - name: provider in: path required: true schema: type: string - name: code in: query schema: type: string - name: state in: query schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CallbackResponse' /auth/v1/method/oidc/{provider}/revoke: get: tags: - AuthenticationMethodOIDCService description: Handles OpenID Connect Front-Channel Logout requests initiated by the identity provider. The optional `iss` and `sid` query parameters are used to identify the user session to be terminated. operationId: oidcFrontChannelLogout parameters: - name: provider in: path required: true schema: type: string - name: iss in: query schema: type: string - name: sid in: query schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RevokeOIDCResponse' post: tags: - AuthenticationMethodOIDCService description: Handles OpenID Connect Back-Channel Logout requests initiated by the identity provider. operationId: oidcRevoke parameters: - name: provider in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RevokeOIDCRequest' application/x-www-form-urlencoded: schema: required: - logout_token type: object properties: logout_token: type: string required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RevokeOIDCResponse' /auth/v1/self: get: tags: - AuthenticationService operationId: getAuthSelf responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Authentication' /auth/v1/self/expire: put: tags: - AuthenticationService description: 'Deprecated: use RevokeAuthenticationSelf instead.' operationId: expireAuthSelf parameters: - name: expiresAt in: query schema: type: string format: date-time responses: "200": description: OK content: {} /auth/v1/self/revoke: delete: tags: - AuthenticationService operationId: revokeAuthSelf responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/RevokeAuthenticationSelfResponse' /auth/v1/tokens: get: tags: - AuthenticationService operationId: listAuthTokens parameters: - name: method in: query schema: enum: - METHOD_NONE - METHOD_TOKEN - METHOD_OIDC - METHOD_KUBERNETES - METHOD_GITHUB - METHOD_JWT type: string format: enum - name: limit in: query schema: type: integer format: int32 - name: pageToken in: query schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ListAuthenticationsResponse' /auth/v1/tokens/{id}: get: tags: - AuthenticationService operationId: getAuthToken parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/Authentication' delete: tags: - AuthenticationService operationId: deleteAuthToken parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK content: {} /evaluate/v1/batch: post: tags: - EvaluationService operationId: evaluateBatch requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchEvaluationRequest' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BatchEvaluationResponse' /evaluate/v1/boolean: post: tags: - EvaluationService operationId: evaluateBoolean requestBody: content: application/json: schema: $ref: '#/components/schemas/EvaluationRequest' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BooleanEvaluationResponse' /evaluate/v1/variant: post: tags: - EvaluationService operationId: evaluateVariant requestBody: content: application/json: schema: $ref: '#/components/schemas/EvaluationRequest' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/VariantEvaluationResponse' /ofrep/v1/evaluate/flags: post: tags: - OFREPService description: OFREP bulk flag evaluation operationId: ofrep.evaluateFlagsBulk requestBody: content: application/json: schema: $ref: '#/components/schemas/EvaluateBulkRequest' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BulkEvaluationResponse' /ofrep/v1/evaluate/flags/{key}: post: tags: - OFREPService description: OFREP single flag evaluation operationId: ofrep.evaluateFlag parameters: - name: key in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EvaluateFlagRequest' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/EvaluationResponse' components: schemas: Authentication: type: object properties: id: type: string method: enum: - METHOD_NONE - METHOD_TOKEN - METHOD_OIDC - METHOD_KUBERNETES - METHOD_GITHUB - METHOD_JWT type: string format: enum expiresAt: type: string format: date-time createdAt: type: string format: date-time updatedAt: type: string format: date-time metadata: type: object additionalProperties: type: string AuthorizeURLResponse: type: object properties: authorizeUrl: type: string BatchEvaluationRequest: required: - requests type: object properties: requestId: type: string requests: type: array items: $ref: '#/components/schemas/EvaluationRequest' reference: type: string BatchEvaluationResponse: type: object properties: requestId: type: string responses: type: array items: $ref: '#/components/schemas/EvaluationResponse' requestDurationMillis: type: number format: double BooleanEvaluationResponse: type: object properties: enabled: type: boolean reason: enum: - UNKNOWN_EVALUATION_REASON - FLAG_DISABLED_EVALUATION_REASON - MATCH_EVALUATION_REASON - DEFAULT_EVALUATION_REASON type: string format: enum requestId: type: string requestDurationMillis: type: number format: double timestamp: type: string format: date-time flagKey: type: string segmentKeys: type: array items: type: string BulkEvaluationResponse: required: - flags type: object properties: flags: type: array items: $ref: '#/components/schemas/EvaluationResponse' eventStreams: type: array items: $ref: '#/components/schemas/EventStream' description: The array of real-time change notification connections CallbackResponse: type: object properties: clientToken: type: string authentication: $ref: '#/components/schemas/Authentication' Distribution: type: object properties: variant: type: string rollout: type: number format: float ErrorEvaluationResponse: type: object properties: flagKey: type: string namespaceKey: type: string reason: enum: - UNKNOWN_ERROR_EVALUATION_REASON - NOT_FOUND_ERROR_EVALUATION_REASON type: string format: enum EvaluateBulkRequest: type: object properties: context: type: object additionalProperties: type: string EvaluateFlagRequest: type: object properties: key: type: string context: type: object additionalProperties: type: string EvaluationRequest: required: - namespaceKey - flagKey - entityId - context - environmentKey type: object properties: requestId: type: string namespaceKey: type: string flagKey: type: string entityId: type: string context: type: object additionalProperties: type: string reference: type: string environmentKey: type: string EvaluationResponse: type: object properties: type: enum: - VARIANT_EVALUATION_RESPONSE_TYPE - BOOLEAN_EVALUATION_RESPONSE_TYPE - ERROR_EVALUATION_RESPONSE_TYPE type: string format: enum booleanResponse: $ref: '#/components/schemas/BooleanEvaluationResponse' variantResponse: $ref: '#/components/schemas/VariantEvaluationResponse' errorResponse: $ref: '#/components/schemas/ErrorEvaluationResponse' EventStream: required: - endpoint type: object properties: type: type: string description: The connection type identifying the push mechanism to use endpoint: allOf: - $ref: '#/components/schemas/EventStreamEndpoint' description: The endpoint URL the client should connect to for real-time flag change notifications description: A real-time change notification connection endpoint EventStreamEndpoint: required: - requestUri type: object properties: requestUri: type: string description: The path + query portion of the endpoint URL. Must start with `/`. origin: type: string description: The scheme + host + optional port portion of the endpoint URL. Flag: type: object properties: key: type: string type: enum: - VARIANT_FLAG_TYPE - BOOLEAN_FLAG_TYPE type: string format: enum name: type: string description: type: string enabled: type: boolean variants: type: array items: $ref: '#/components/schemas/Variant' rules: type: array items: $ref: '#/components/schemas/Rule' rollouts: type: array items: $ref: '#/components/schemas/Rollout' defaultVariant: type: string metadata: type: object FlagList: type: object properties: flags: type: array items: $ref: '#/components/schemas/Flag' nextPageToken: type: string totalCount: type: integer format: int32 GoogleProtobufValue: description: Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. ListAuthenticationsResponse: type: object properties: authentications: type: array items: $ref: '#/components/schemas/Authentication' nextPageToken: type: string RevokeAuthenticationSelfResponse: type: object properties: nextUri: type: string RevokeOIDCRequest: type: object properties: provider: type: string logoutToken: type: string RevokeOIDCResponse: type: object properties: {} Rollout: type: object properties: type: enum: - UNKNOWN_ROLLOUT_TYPE - SEGMENT_ROLLOUT_TYPE - THRESHOLD_ROLLOUT_TYPE type: string format: enum description: type: string segment: $ref: '#/components/schemas/RolloutSegment' threshold: $ref: '#/components/schemas/RolloutThreshold' RolloutSegment: type: object properties: value: type: boolean segments: type: array items: type: string segmentOperator: enum: - OR_SEGMENT_OPERATOR - AND_SEGMENT_OPERATOR type: string format: enum RolloutThreshold: type: object properties: percentage: type: number format: float value: type: boolean Rule: type: object properties: segmentOperator: enum: - OR_SEGMENT_OPERATOR - AND_SEGMENT_OPERATOR type: string format: enum segments: type: array items: type: string distributions: type: array items: $ref: '#/components/schemas/Distribution' Variant: type: object properties: key: type: string name: type: string description: type: string attachment: $ref: '#/components/schemas/GoogleProtobufValue' VariantEvaluationResponse: type: object properties: match: type: boolean segmentKeys: type: array items: type: string reason: enum: - UNKNOWN_EVALUATION_REASON - FLAG_DISABLED_EVALUATION_REASON - MATCH_EVALUATION_REASON - DEFAULT_EVALUATION_REASON type: string format: enum variantKey: type: string variantAttachment: type: string requestId: type: string requestDurationMillis: type: number format: double timestamp: type: string format: date-time flagKey: type: string VerifyServiceAccountRequest: type: object properties: serviceAccountToken: type: string VerifyServiceAccountResponse: type: object properties: clientToken: type: string authentication: $ref: '#/components/schemas/Authentication' securitySchemes: bearerAuth: type: http scheme: bearer jwtAuth: type: http scheme: JWT security: - bearerAuth: [] tags: - name: AuthenticationMethodKubernetesService - name: AuthenticationMethodOIDCService - name: AuthenticationService - name: EvaluationService - name: Flipt - name: OFREPService