NativeScript / NativeScript/ios-device-lib
"upload" method is incorrectly described in the documentation
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 16
- Forks
- 8
- Avg merge
- 19h 29m
- Merged PRs (30d)
- 2
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the documented upload interface with the source code's expected request shape. Update the documentation example so upload uses a files array containing source and destination entries, then verify the example matches the implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100