Uploaded image for project: 'Kite SDK'
  1. Kite SDK
  2. KITE-128

Implement proposed API changes from cdk-dev discussion

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 0.6.0
    • Fix Version/s: 0.7.0
    • Component/s: Data Module
    • Labels:
      None

      Description

      We should implement the proposed API changes from the CDK group discussion:

      • Change MetadataProvider#save(name, descriptor) to MetadataProvider#create and MetadataProvider#update
      • Change DatasetRepository#get to DatasetRepository#load
      • Change DatasetRepository#drop to DatasetRepository#delete
      • Add Collection<String> DatasetRepository#list() that lists the available Dataset names
      • Add boolean DatasetRepository#exists(String name) and boolean MetadataRepository#exists (see comment below)
      • Add DatasetDescriptor.Builder(DatasetDescriptor) constructor to help copy @Immutable objects.

      This is going to require updating docs and other artifacts. If something specific needs to be done, please note it in a comment! Current list:

      • Add AbstractDatasetRepository and AbstractMetadataProvider to the SPI to handle compatibility changes
      • Deprecate old methods in the API and update javadoc
      • Add tests for new API methods: list and exists
      • Update the site docs with the new references
      • Update the cdk-examples repo

        Attachments

          Activity

            People

            • Assignee:
              blue Ryan Blue
              Reporter:
              blue Ryan Blue
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: