gchq / gchq/sleeper

REST API to configure Sleeper tables

Open
#6,749 0 comments 0 reactions 0 assignees View on GitHub
enhancement needs-refinement parent-issue
Dominant language
Java
Stars
107
Forks
29
Avg merge
19h 46m
Merged PRs (30d)
141

Description

### User Story

As a user of Sleeper, I want to be able to configure tables by making REST API calls, so that I can adjust the configuration programmatically in any language.

### Description / Background

Under epic:
- https://github.com/gchq/sleeper/issues/1786

We'd like a REST API to adjust the configuration of tables in a Sleeper instance.

### Acceptance Criteria

**Given** I create a configuration for a Sleeper table as JSON
**When** I submit that to the REST API as a new table
**Then** the table is created in that Sleeper instance

**When** I request the REST API to list Sleeper tables
**Then** a list of table names is returned

**Given** I create a Sleeper table
**When** I request that table's configuration from the REST API
**Then** the configuration is returned as JSON

**Given** I create a Sleeper table
**When** I request to update that table's configuration in the REST API as JSON
**Then** the configuration is updated

### Technical Notes / Implementation Details

Here are sub-issues:
- https://github.com/gchq/sleeper/issues/6748
- https://github.com/gchq/sleeper/issues/7098

To do next:
- https://github.com/gchq/sleeper/issues/7347
- https://github.com/gchq/sleeper/issues/7446

We also need to create issues for the remaining endpoints.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.