Provide OpenAPI spec for v2

[kuhnroyal]

I am looking for an updated spec that includes the environmentKey- either an update on the main branch or in the v2 branch.
Are there any plans for that?

[erka]

Hey. Please check "rpc" folder. There are few openapi.yaml files. Like rpc/v2/environments/openapi.yaml

[kuhnroyal]

Hey, thanks - I am looking for the client evaluation API but I cant't find it there.

[erka]

Evaluation API could be found in rpc/flipt/openapi.yaml

[erka]

@kuhnroyal In general, there are no changes to the evaluation API between v1 and v2. Flipt clients should work with either version without modifications.

For v2, you may optionally include the X-Flipt-Environment header if you want to target a non-default environment.

[kuhnroyal]

Thanks, I looked at what the flipt UI is sending and saw the environmentKey being sent and was able to switch environments with this in Postman. Will try with the header.

My current client is generated from the Open API spec on the main branch. I can adapt this but for clarity the spec could be extended with the body field and/or header -both seem to be backwards compatible.

[erka]

The v2 rpc/flipt/openapi.yaml includes environmentKey as field

EvaluationRequest:
    required:
        - namespaceKey
        - flagKey
        - entityId
        - context
        - environmentKey
    type: object
        #...

You may recreate the new client from it.

The header is simply a way to make the migration to v2 a bit easier.

[kuhnroyal]

Thanks! This is what I was looking for.