Value model in AdditionalFieldDefinition is an empty class, thus silently drops all data
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 55/100
Piste de recherche
Commencez dans glean/api_client/models/additionalfielddefinition.py en inspectant le modèle Value vide et la manière dont AdditionalFieldDefinition construit sa liste de valeurs. Reproduisez les exemples documentés avec des entrées anchor, hyperlink et dictionary, puis confirmez que model_dump() conserve les données fournies au lieu de produire des objets vides.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
The Value class in additionalfielddefinition.py is defined as an empty Pydantic BaseModel with no fields:
class Value(BaseModel):
r"""Either a string or HypertextField. When OpenAPI Generator supports oneOf, we can semantically enforce this in the docs."""
Because the SDK's BaseModel uses the default Pydantic extra = 'ignore' behavior, any data passed to Value(...) is silently discarded. This means the value field on AdditionalFieldDefinition, which is typed as Optional[List[Value]], cannot actually carry any data.
Impact
This affects any consumer using AdditionalFieldDefinition through either:
EmployeeInfoDefinition.additional_fieldsTeamInfoDefinition.additional_fields
When constructing an AdditionalFieldDefinition with values, the data in the value list is lost:
from glean.api_client.models.additionalfielddefinition import AdditionalFieldDefinition, Value
field = AdditionalFieldDefinition(
key="languages",
value=[Value(anchor="English"), Value(anchor="Spanish")]
)
print(field.model_dump())
# {'key': 'languages', 'value': [{}, {}]}
# ^^ ^^ all data silently dropped
The same applies to HypertextField-style values:
Value(anchor="Glean", hyperlink="https://glean.com")
# Value() — both anchor and hyperlink are silently ignored
This is the associated public docs page: https://developers.glean.com/api/indexing-api/bulk-index-employees. Note that even when passing in data to Value() as a dict, the whole dict object is ignored:
from glean.api_client.models.additionalfielddefinition import AdditionalFieldDefinition
raw = {"key": "username", "value": [{"username": "testuser"}]}
field = AdditionalFieldDefinition(**raw)
dumped = field.model_dump()
print(dumped)
# {'key': 'username', 'value': [{}]}
- Langage dominant
- Python
- Étoiles
- 20
- Forks
- 10
- Merge moyen
- 1 j 6 h
- PR mergées (30 j)
- 17
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de gleanwork/api-client-python
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
gleanwork/api-client-python#136 ·
-
Issue Obtaining Agent Schema Ouverte
Difficulté 3/5 1-2 jours Accessibilité débutants 45/100
gleanwork/api-client-python#137 ·
-
Difficulté 4/5 3-5 jours Accessibilité débutants 42/100
gleanwork/api-client-python#115 · 4 commentaires ·
-
Model serialization drops keys Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 45/100
gleanwork/api-client-python#105 · 2 commentaires ·
-
Difficulté 4/5 3-5 jours Accessibilité débutants 25/100
gleanwork/api-client-python#57 · 2 commentaires ·
Toutes les issues de gleanwork/api-client-python
Issues similaires
-
documentation help wanted
Difficulté 2/5 1-3 heures Accessibilité débutants 90/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 90/100
simonw/sqlite-utils#872 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100