Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

`SoftwareCatalogApi.list_catalog_entity` does not filter services when `filter_name` is passed

Ouverte
  • Quelque chose ne va pas ?
#2,756 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 2 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
38/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
openapi, python
Domaine
api, backend-api-design

Piste de recherche

Commencez au point d’entrée SoftwareCatalogApi.list_catalog_entity et reproduisez la requête avec filter_name="service:<app_name>" et filter_kind="service". Suivez la manière dont le filtre est envoyé et vérifiez la réponse par rapport au service attendu ; le travail est terminé lorsque l’API renvoie le service demandé quand filter_name est fourni.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

kind/bug stale

Describe the bug
I have tried to pass in variations of filter_name such as filter_name=app_name, filter_name=f"name:{app_name}", and filter_name=f"service:{app_name}". The results always return the services in alphabetical order. I have verified the services I'm filtering exist.

Label the issue properly.

  • Add severity/ label.
  • Add documentation label if this issue is related to documentation changes.

To Reproduce
Steps to reproduce the behavior:

def associate_datadog_teams(app_name: str, owner: str) -> str:
    if not app_name or not isinstance(app_name, str):
        raise ValueError("Invalid app_name provided")
    if not owner or not isinstance(owner, str):
        raise ValueError("Invalid owner provided")

    # Make sure application key is available under the env var the SDK expects
    if os.getenv("DD_APP_KEY") is None and os.getenv("DD_APPLICATION_KEY"):
        os.environ["DD_APP_KEY"] = os.environ["DD_APPLICATION_KEY"]

    # Validate required credentials are present
    if not os.getenv("DD_API_KEY") or not os.getenv("DD_APP_KEY"):
        raise ValueError(
            "Missing Datadog credentials. Ensure DD_API_KEY and DD_APP_KEY (or DD_APPLICATION_KEY) are set."
        )

    # Helper for safely getting nested attributes whether SDK returns models or dicts
    def _get(obj, path: list[str], default=None):
        cur = obj
        for key in path:
            if cur is None:
                return default
            if isinstance(cur, dict):
                cur = cur.get(key)
            else:
                cur = getattr(cur, key, None)
        return cur if cur is not None else default

    # Search for service by exact name
    configuration = Configuration()
    with ApiClient(configuration) as api_client:
        api = SoftwareCatalogApi(api_client)
        try:
            resp = api.list_catalog_entity(filter_name=f"service:{app_name}", filter_kind="service", page_limit=5)
        except Exception as e:
            raise ValueError(f"Failed to query Datadog Software Catalog: {e}") from e
        
        print("Services returned by API:")
        for item in resp.data:
            service_name = item.attributes.name
            print(f"  - {service_name}")
        print()

        items = _get(resp, ["data"], [])
        # Find an exact name match among returned items
        matched = None
        for it in items or []:
            name = _get(it, ["attributes", "name"]) or _get(it, ["attributes", "metadata", "name"])  # fallback
            if name == app_name:
                matched = it
                break

        if not matched:
            return f"Service '{app_name}' not found in Datadog Service Catalog. Skipping association."

Expected behavior

It should return the service I'm passing as filter_name.

Screenshots
If applicable, add screenshots to help explain your problem.

Environment and Versions (please complete the following information):
A clear and precise description of your setup:
datadog_api_client==2.40.0

Langage dominant
Python
Étoiles
167
Forks
55
Merge moyen
2 j 23 h
PR mergées (30 j)
74

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de DataDog/datadog-api-client-python

Toutes les issues de DataDog/datadog-api-client-python

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.