Flagsmith / Flagsmith/flagsmith

featurestates_all_read has different response documented than actual

Open
#2,269 1 comment 0 reactions 1 assignee Assigned to @khvn26 View on GitHub
api bug
Dominant language
Python
Stars
6.6k
Forks
567
Avg merge
1d 13h
Merged PRs (30d)
121

Description

**Describe the bug**

/api/v1/environments/{environment_api_key}/identities/{identity_pk}/featurestates/all/ returns different content than is reported in Swagger/OpenApi.

Documented Return Type:

{
count* | integer
-- | --
next | string($uri)x-nullable: true
previous | string($uri)x-nullable: true
results* | [FeatureStateSerializerCreate{feature*integertitle: Featureenabledbooleantitle: Enabled }] | feature* | integertitle: Feature | enabled | booleantitle: Enabled |  
feature* | integertitle: Feature
enabled | booleantitle: Enabled
 }

Actual Return Data:

[
{
"feature": {
"id": 1,
"name": "left-nav-font-size",
"type": "STANDARD"
},
"enabled": true,
"feature_state_value": 10,
"overridden_by": null,
"segment": null,
"multivariate_feature_state_values": []
},
{
"feature": {
"id": 2,
"name": "test_dev_enabled_feature",
"type": "STANDARD"
},
"enabled": true,
"feature_state_value": null,
"overridden_by": null,
"segment": null,
"multivariate_feature_state_values": []
},
{
"feature": {
"id": 3,
"name": "TestCreateThroughRestAPI",
"type": "STANDARD"
},
"enabled": true,
"feature_state_value": "test",
"overridden_by": "IDENTITY",
"segment": null,
"multivariate_feature_state_values": []
},
]

**To Reproduce**

Steps to reproduce the behavior:

1. Go to 'Swagger
2. Use endpoint: /api/v1/environments/{environment_api_key}/identities/{identity_pk}/featurestates/all
3. Check results vs documented return type.

**Expected behavior**

Documented return type matches actual. The count, next, and previous properties would be beneficial to return.

**How are you running Flagsmith?**

- [ ] Self Hosted with Docker
- [x] Self Hosted with Kubernetes
- [ ] SaaS at flagsmith.com
- [ ] Some other way

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.