eclipse-cdt-cloud / eclipse-cdt-cloud/trace-server-protocol

Non-matching types for IDs (int64) and query parameter requested_items (array of int32)

Offen
#140 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Python
Sterne
26
Forks
21
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

### Bug Description:

The entry IDs of tree entries (e.g. `XYTreeEntry` or `TimeGraphEntry`) through their base class `TreeDataModel`) are defined as int64 numbers (as well parentId). Those IDs are passed as input parameters in array `requested_items` to fetch the data (e,g, xy series, timegraph rows) for those entries, however the `requested_items` is defined as an array of int32 numbers.

The same is true for the `TooltipParameters`.

The types need to match in the API. Once this is fixed in the API the sever and client implementations need to be adapted for this.

### Steps to Reproduce:

1. Open API.yaml
2. See data structure definition for `TreeDataModel`
3. See data structure definitions for `RequestedParameters` and `GenericXYRequestedParameters` and `TooltipParameters`

### Additional Information

Note: API definition needs to be updated through swagger annotations in the Trace Compass server.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginnen Sie mit API.yaml und vergleichen Sie TreeDataModel und dessen parentId-Typ mit requested_items in RequestedParameters, GenericXYRequestedParameters und TooltipParameters. Verfolgen Sie dann die Swagger-Annotationen im Trace Compass-Server und identifizieren Sie die Client- und Serverimplementierungen, die diese Felder verwenden. Als abgeschlossen gilt die Aufgabe, wenn die API-Typen übereinstimmen und die betroffenen Implementierungen konsistent angepasst sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
openapi, python
Bereich
api, backend-api-design
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.