NativeScript / NativeScript/ios-device-lib

"upload" method is incorrectly described in the documentation

Offen
#52 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
C++
Sterne
16
Forks
8
Ø Merge
19 Std. 29 Min.
Gemergte PRs (30 T.)
2

Beschreibung

The documentation for "upload" method states next required interface:

{
  "methods": [
    {
      "id": "5",
      "name": "upload",
      "args": [
        {
          "appId": "com.sample.MyApp",
          "deviceId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
          "source": "D:\\Project\\app.js",
          "destination": "Library\\Application Support\\LiveSync\\app\\app.js"
        }
      ]
    }
  ]
}

but the source code, actually, expects next one:

{
  "methods": [
    {
      "id": "5",
      "name": "upload",
      "args": [
        {
          "appId": "com.sample.MyApp",
          "deviceId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
          "files": [
            {
              "source": "D:\\Project\\app.js",
              "destination": "Library\\Application Support\\LiveSync\\app\\app.js"
            },
            ...
          ]
        }
      ]
    }
  ]
}

the discrepancy in the documentation made me spend time to figure out why the upload method does not work

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Vergleiche die dokumentierte Upload-Schnittstelle mit der vom Quellcode erwarteten Request-Struktur. Aktualisiere das Dokumentationsbeispiel so, dass der Upload ein files-Array mit source- und destination-Einträgen verwendet, und überprüfe anschließend, dass das Beispiel mit der Implementierung übereinstimmt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
cpp
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
55/100

Neue Issues direkt in Ihr Postfach

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