acd0c44c33
# What this PR does **Cleanup label typing:** 1. LabelParam -> two separate types LabekKey and LabelValue 2. LabelData -> renamed to LabelPair. 3. LabelKeyData -> renamed to LabelOption Data is not giving any info about what this type represents. 4. Remove LabelsData and LabelsKeysData types. They are just list of types listed above and with new naming it feels obsolete. 5. ValueData removed. LabelPair is used instead. 6. Rework AlertGroupCustomLabel to use LabelKey type for key to make type system more consistent. Name model type AlertGroupCustomLabel**DB** and api type AlertGroupCustomLabel**API** to clearly distinguish them. **Split update_labels_cache into two tasks** update_label_option_cache and update_label_pairs_cache. Original task was expecting array of LabelsData (now it's LabelPair) OR one LabelKeyData ( now it's LabelOption). I believe having one function with two sp different argument types makes it more complicated for understanding. **Make OnCall backend support prescribed labels**. OnCall will sync and store "prescribed" field for key and values, so Label dropdown able to disable editing for certain labels. ## Which issue(s) this PR fixes ## Checklist - [x] Unit, integration, and e2e (if applicable) tests updated - [ ] Documentation added (or `pr:no public docs` PR label added if not required) - [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not required) --------- Co-authored-by: Maxim Mordasov <maxim.mordasov@grafana.com> Co-authored-by: Yulya Artyukhina <Ferril.darkdiver@gmail.com>
59 lines
1.7 KiB
Python
59 lines
1.7 KiB
Python
from rest_framework import serializers
|
|
|
|
from apps.labels.models import AssociatedLabel, LabelKeyCache, LabelValueCache
|
|
from apps.labels.utils import is_labels_feature_enabled
|
|
|
|
|
|
class LabelKeySerializer(serializers.ModelSerializer):
|
|
id = serializers.CharField()
|
|
prescribed = serializers.BooleanField(default=False)
|
|
|
|
class Meta:
|
|
model = LabelKeyCache
|
|
fields = (
|
|
"id",
|
|
"name",
|
|
"prescribed",
|
|
)
|
|
|
|
|
|
class LabelValueSerializer(serializers.ModelSerializer):
|
|
id = serializers.CharField()
|
|
prescribed = serializers.BooleanField(default=False)
|
|
|
|
class Meta:
|
|
model = LabelValueCache
|
|
fields = (
|
|
"id",
|
|
"name",
|
|
"prescribed",
|
|
)
|
|
|
|
|
|
class LabelPairSerializer(serializers.Serializer):
|
|
key = LabelKeySerializer()
|
|
value = LabelValueSerializer()
|
|
|
|
|
|
class LabelOptionSerializer(serializers.Serializer):
|
|
key = LabelKeySerializer()
|
|
values = LabelValueSerializer(many=True)
|
|
|
|
|
|
class LabelReprSerializer(serializers.Serializer):
|
|
name = serializers.CharField()
|
|
|
|
|
|
class LabelsSerializerMixin(serializers.Serializer):
|
|
labels = LabelPairSerializer(many=True, required=False)
|
|
|
|
def validate_labels(self, labels):
|
|
if labels:
|
|
keys = {label["key"]["id"] for label in labels}
|
|
if len(keys) != len(labels):
|
|
raise serializers.ValidationError(detail="Duplicate label key")
|
|
return labels
|
|
|
|
def update_labels_association_if_needed(self, labels, instance, organization):
|
|
if labels is not None and is_labels_feature_enabled(organization):
|
|
AssociatedLabel.update_association(labels, instance, organization)
|