use API docs to determine expected fields in API responses

Offen
#526 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
35/100
Issue-Typ
Feature
Klarheit
Muss geklärt werden
Aktivitätsstatus
Ruhig
Tech-Stack
r
Bereich
api

Rechercherichtung

Beginne mit der Prüfung der Pull Requests 513 und 509, insbesondere der Diskussion über das Entfernen von response-field und der Typüberprüfung. Untersuche anschließend, wie der Client die Connect-Version bereitstellt und wie API-Antworten derzeit zurückgegeben werden. Als abgeschlossen gilt die Aufgabe, wenn die entsprechende Connect API-Spezifikation verwendet wird, sofern verfügbar, um die erwarteten Antwortfelder zu bestimmen, ohne eine fragile Typüberprüfung wiederherzustellen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

in https://github.com/posit-dev/connectapi/pull/513 we removed the brittle list of expected response fields and types. Enforcing these fields and types caused a maintenance headache when the Connect API changed (lots of issues like this).

We don't want to bother with the type enforcement that we used to do, but when working on https://github.com/posit-dev/connectapi/pull/513 we did discuss the possibility of determining the expected fields based on Connect's API spec docs. The Connect client surfaces the Connect version (if it's not hidden by the server) which can be used to find the right spec.

Using the spec to ensure we return the expected fields might allow us to return more useful outputs in cases like this.

Vorherrschende Sprache
R
Sterne
54
Forks
27
Ø Merge
1 T. 21 Min.
Gemergte PRs (30 T.)
4

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus posit-dev/connectapi

Alle Issues in posit-dev/connectapi

Ähnliche Issues

Weitere Issues zu R

Neue Issues direkt in Ihr Postfach

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