-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[epic] v0.2 Development of the Client SDK #4
Closed
8 of 10 tasks
Comments
30 tasks
mariorodeghiero
added a commit
that referenced
this issue
Sep 7, 2020
…tion to receive an URL - #4 - update readme - refactor code to use client - refactor code to use open function - fix ckanAuthz url
|
mariorodeghiero
added a commit
that referenced
this issue
Sep 11, 2020
- create action function to be able create/update dataset and resource - add test to create a dataset - add test to create/update a resource - add test to the action function
mariorodeghiero
added a commit
that referenced
this issue
Sep 11, 2020
mariorodeghiero
added a commit
that referenced
this issue
Sep 11, 2020
anuveyatsu
added a commit
that referenced
this issue
Sep 11, 2020
…metadata [add][lg] create methods and test - #4
This was referenced Sep 14, 2020
Closed
|
In Progress:
|
2 tasks
kmanaseryan
added a commit
that referenced
this issue
Sep 14, 2020
rufuspollock
added a commit
that referenced
this issue
Sep 14, 2020
#4 Add support for generic action request to CKAN
4 tasks
kmanaseryan
added a commit
that referenced
this issue
Sep 15, 2020
This was referenced Sep 15, 2020
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
v0.1 was about basic "push" functionality which is done.
v0.2 is about refactoring this to be more elegant and support for reading/writing metadata
API design should follow https://github.com/datopian/ckan-client-guide (but tweaked for js/nodejs idioms)
https://github.com/okfn/ckan.js could probably be reused for the plumbing layer.
Acceptance
client.push(datasetMetadata)
function works which takes dataset JS object (in f11s format) and puts it to CKAN datastoreclient.pushBlob(resource, onProgressFn)
: uploads a resource's data to the Blob Storage.resource
is a data.jsFile
object of a specific type e.g.FileInterface
client.retrieve(datasetIdOrName)
Porcelain
client.action(...)
Bonus
client.pushResource(resource, dataset-name)
takes resource in data.js and saves data to storage and metadataclient.pushResourceMedata
Tasks
client.action
: wrapper for CKAN action API Method to call CKAN action API #10client.push
: put dataset metadata Push dataset metadata client.push(datasetMetadata) #11client.pushBlob
: refactor existing code pushBlob method to push resource data to blob storage #12client.retrieve
: retrieve method for dataset metdata #7API design
This is indicative - see individual issues for precise specifications
Uses
data.js
and its Frictionless (f11s) data interface as the way to access files and datasets. Metadata follows Frictionless formats.Plumbing
This is relatively raw low level APIs.
Porcelain
Example usage
What is an
f11s_dataset
?put
The text was updated successfully, but these errors were encountered: