"upload" method is incorrectly described in the documentation

Offen

#52 erstellt am 12.7.2019 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 1/5
Geschätzter Aufwand: Unter einer Stunde
Anfängerfreundlichkeit: 55/100

Issue-Typ: Dokumentation
Klarheit: Klar beschrieben
Aktivitätsstatus: Veraltet
Tech-Stack: cpp
Bereich: documentation

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.

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

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

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

Mehr aus NativeScript/ios-device-lib

any way we can differentiate between paired devices and non-paired devices Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

NativeScript/ios-device-lib#84 · Erstellt am 17.12.2024
Sometimes this is showing only 1 device while idevice_id from libimbile shows all connected devices Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 30/100

NativeScript/ios-device-lib#82 · Erstellt am 04.11.2023
"ios-device-lib" process hangs with CPU 100% on OSX Catalina Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 25/100

NativeScript/ios-device-lib#73 · 1 Kommentar · Erstellt am 08.1.2021
Error on communication Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 20/100

NativeScript/ios-device-lib#67 · Erstellt am 03.3.2020
There was an error from the device: InstallationLookupFailed Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 20/100

NativeScript/ios-device-lib#66 · 2 Reaktionen · Erstellt am 11.12.2019

Alle Issues in NativeScript/ios-device-lib