Data edit api #1044

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.

Sign up for GitHub

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

Jump to bottom

Merged

joaquinvanschoren merged 2 commits into develop from data_edit_api

Jul 10, 2020

Member

sahithyaravi commented May 13, 2020 •

edited

Loading

As discussed, this api can edit some meta-features of the dataset:
List of meta-features can be edited/ updated via data_edit API call,

description
creator
contributor
collection_date
language
citation
original_data_url
paper_url

These meta-features/ data will just need to call create_dataset api and create a new version: (python api)

attributes
data - the data itself
default_target_attribute
ignore_attribute
row_id_attribute

After the data_edit API is ready, I can create a single python API to handle both of these cases.
Based on the arguments (None or otherwise). We can either create a new dataset or call the data_edit API.

How to test this API?

Create a post request:
Request URL: localhost/api/v1/json/data/edit
Request body: Specify the data_id and atleast one of the 7 fields to edit as an XML

example data.xml:

<oml:data_edit_parameters xmlns:oml="http://openml.org/openml">
<oml:description> Testing description changes </oml:description>
<oml:creator> sahi </oml:creator>
<oml:contributor> Joaquin Vanschoren</oml:contributor>
<oml:collection_date> 2020 </oml:collection_date>
<oml:language>English</oml:language>
<oml:citation>xxx</oml:citation>
<oml:original_data_url>http://openml.org/d/1</oml:original_data_url>
<oml:paper_url>http://openml.org/d/1</oml:paper_url>
</oml:data_edit_parameters>


          data edit api

0587c72

sahithyaravi changed the base branch from master to develop

May 13, 2020 11:51

sahithyaravi requested a review from joaquinvanschoren

May 13, 2020 11:54

sahithyaravi self-assigned this

joaquinvanschoren mentioned this pull request

Edit (some) fields of flow after upload? openml/openml-python#896

Open

sahithyaravi requested a review from janvanrijn

July 6, 2020 12:26

sahithyaravi mentioned this pull request

Data edit api for new website openml/openml-python#929

Closed

janvanrijn requested changes

View reviewed changes

Member

janvanrijn left a comment

Code looking good @sahithyaravi1493, I could only find some small things that should be improved.

openml_OS/models/api/v1/Api_data.php

    
                 private function data_edit() {

                  // Get columns to be update from post data

                  $data_id = $this->input->post('data_id');

Member

janvanrijn Jul 7, 2020

For consistency, it would be great if we would solve this with a XML (and new XSD) as well.

openml_OS/models/api/v1/Api_data.php Outdated

    
                  // If data id is not given

                  if( $data_id == false ) {

                    $this->returnError( 110, $this->version );

Member

janvanrijn Jul 7, 2020

For consistency, the API error codes are setup in such a way that we have a "range" of error codes per error function. It would be good to claim the range 1060 - 1069 for this function, and duplicate all error messages that are now reused.

openml_OS/models/api/v1/Api_data.php Outdated

    
                  // where data id

                  $where_data = 'where did='. $data_id;

                  $this->Dataset->query('update dataset set '. $update_total . $where_data);

Member

janvanrijn Jul 7, 2020

please use Codeigniter official Query for this (it's $this->Dataset->update or something like that)

openml_OS/models/api/v1/Api_data.php Outdated

    
                  $where_data = 'where did='. $data_id;

                  $this->Dataset->query('update dataset set '. $update_total . $where_data);

Member

janvanrijn Jul 7, 2020

please also 'catch' the return value of that function (boolean) and handle it if there is an error

openml_OS/models/api/v1/Api_data.php Outdated

    
                  $this->Dataset->query('update dataset set '. $update_total . $where_data);

                  // Return edited dataset, for user to verify changes    

                  $this->xmlContents( 'data-get', $this->version, $dataset );

Member

janvanrijn Jul 7, 2020

For consistency (with upload/delete fns), I would suggest to create a 'data-edit' and to only show data id


          support edit parameters via xml

bd8a496

janvanrijn approved these changes

View reviewed changes

Member

janvanrijn left a comment

Thanks for making this PR! It looks great.

joaquinvanschoren merged commit bcc97b8 into develop

sahithyaravi deleted the data_edit_api branch

August 5, 2020 12:35

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet