Issue 6748: Rest API shell by rtjd6554 · Pull Request #6788 · gchq/sleeper

rtjd6554 · 2026-03-10T07:42:15Z

Make sure you have checked all steps below.

Issue

My PR fully resolves the following issues. I've referenced an issue in the PR title, for example "Issue 1234 - My
Feature". Note that before an issue is finished, you can still make a pull request by raising a separate issue
for your progress.
- Resolves REST API lambda shell #6748

Tests

My PR adds the following tests based on our test strategy OR does not need testing for this extremely good reason:
- Existing build process

Documentation

In case of new functionality, my PR adds documentation that describes how to use it, or I have linked to a
separate issue for that below.
If I have added new Java code, I have added Javadoc that explains it following our conventions and style.
If I have added or removed any dependencies from the project, I have updated the NOTICES file.

patchwork01

I think the idea of a basic endpoint to get the version number makes sense, but you need to decide what you want to implement to start with. You could start with the CDK code or the lambda code.

If you start with the CDK you'll need to focus on the CDK code to deploy API Gateway and hook it up to a lambda, and look up how to do that. You could add it to the cdk module as a new optional stack. The most similar existing code would be WebSocketQueryStack, which does use API Gateway but for a web socket.

If you start with the lambda you'll need to work out how to use the AWS libraries to write a handler that consumes the invocations from API Gateway. You'll need to work out whether it should be a single lambda per endpoint or a lambda that can serve multiple endpoints. The closest code that we've got already would be WebSocketQueryProcessorLambda, but that uses the events for web socket invocations, which is not what you want.

The configuration for how the lambda is invoked by API Gateway will be done in the CDK. I'd consider starting with that.

java/rest-api/pom.xml

java/rest-api/src/main/java/sleeper/restapi/SleeperRest.java

java/deployment/cdk/src/test/java/sleeper/cdk/stack/RestApiStack.java

rtjd6554 · 2026-03-30T13:22:14Z

Stack deployed and queried via curl

curl -X POST https://{unique_id}.execute-api.eu-west-2.amazonaws.com/sleeper

ca61688

1 small comment otherwise looks good to me. It would be great to get a knowledge share on this showing it off

ca61688 · 2026-03-31T07:25:02Z

java/deployment/cdk/src/main/java/sleeper/cdk/stack/SleeperOptionalStacks.java

            new IngestBatcherStack(scope, "IngestBatcher", props, coreStacks, ingestStacks);
        }

+        // Stack to allow provide a Rest API


I'm not sure what this comment means

Adjust comment for better context

patchwork01

This is looking good now, thanks. The following old comments are unresolved:

#6788 (comment)
#6788 (comment)
#6788 (comment)

java/deployment/rest-api/src/main/java/sleeper/restapi/RestApiLambda.java

java/deployment/cdk/src/main/java/sleeper/cdk/stack/RestApiStack.java

patchwork01

The following old comments are unresolved:

#6788 (comment)
#6788 (comment)

java/deployment/rest-api/src/main/java/sleeper/restapi/RestApiLambda.java

java/deployment/cdk/src/main/java/sleeper/cdk/stack/RestApiStack.java

patchwork01 · 2026-03-31T13:48:26Z

java/core/src/main/java/sleeper/core/properties/instance/InstancePropertyGroup.java

+    public static final PropertyGroup REST_API = instanceGroup("REST API")
+            .description("The following instance properties relate to the REST API.")
+            .build();


Apologies for not catching this earlier, but I'm not sure there's a reason to make a separate property group just for this? I don't think we anticipate adding a lot of properties for this. We could put it in the common group, at least for now?

patchwork01 · 2026-03-31T13:50:26Z

java/deployment/rest-api/pom.xml

+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-shade-plugin</artifactId>


It doesn't look like this new fat jar is included in the distribution module. Doesn't that mean the jar won't be copied out to the scripts/jars directory, so it won't be available to be deployed? What did you do when you tested it?

It looks like this needs updating in java/distribution/src/main/assembly/zip.xml?

rtjd6554 and others added 4 commits March 5, 2026 11:33

6749: Initial maven commit

bd08907

6749: Rest api design framework

4175a4c

Merge branch 'develop' into 6749-rest-api-shell

6cd1287

Merge branch 'develop' into 6749-rest-api-shell

2142f36

patchwork01 reviewed Mar 10, 2026

View reviewed changes

java/rest-api/pom.xml Outdated Show resolved Hide resolved

java/rest-api/src/main/java/sleeper/restapi/SleeperRest.java Outdated Show resolved Hide resolved

java/deployment/cdk/src/test/java/sleeper/cdk/stack/RestApiStack.java Outdated Show resolved Hide resolved

rtjd6554 and others added 25 commits March 10, 2026 11:59

6749: Refactor location of restapi code

744490d

6749: Update config for chunks and names

89168d9

6749: Update poms

b6a99ec

6749: Update chunk-config

3b90ef4

6749: Optional stack option

83ea654

6749: Refactor restapi stack

ed4fd08

6749: Update dependency to fix build

d29df6f

6749: Update documentation

2a6f90a

6749: Update versioning number for testing

6fc8cbe

Merge branch 'develop' into 6749-rest-api-shell

7841ae4

6749: Update documentation

b7380ed

6749: Commented out section

d9e1221

Merge branch 'develop' into 6749-rest-api-shell

06e9f10

6749: Remove extra module and relocate into cdk

ab33692

Merge branch 'develop' into 6749-rest-api-shell

9d8b904

6749: CfnApi variant

143a24f

6749: Add integration

e27f8cc

Merge branch 'develop' into 6749-rest-api-shell

808de8b

6749: Add route

febe991

Merge branch 'develop' into 6749-rest-api-shell

5ff81f3

6749: Update default properties for apigateway creation

28b9505

6749: Update cfnOutput

09a1e7c

6749: Update for url details

f3a652b

6749: Update method signature

54e60b2

6749: Tidy up changes

f2aabdb

rtjd6554 and others added 3 commits March 30, 2026 07:11

Merge branch 'develop' into 6749-rest-api-shell

265a53f

6749: Update stub method to provide simple response

cffed96

6749: Replace core dependency with slf4j due to maven warning

8de1b83

rtjd6554 added the needs-reviewer Pull requests that need a reviewer to be assigned label Mar 30, 2026

6749: Update system test properties

c56b498

ca61688 approved these changes Mar 31, 2026

View reviewed changes

patchwork01 reviewed Mar 31, 2026

View reviewed changes

patchwork01 removed the needs-reviewer Pull requests that need a reviewer to be assigned label Mar 31, 2026

rtjd6554 and others added 3 commits March 31, 2026 09:26

6749: Adjusted based on review comments

00024b7

6749: Adjust lambda ID

e72b951

Merge branch 'develop' into 6749-rest-api-shell

b59edcf

rtjd6554 added the needs-reviewer Pull requests that need a reviewer to be assigned label Mar 31, 2026

patchwork01 assigned patchwork01 and unassigned rtjd6554 Mar 31, 2026

patchwork01 reviewed Mar 31, 2026

View reviewed changes

patchwork01 assigned rtjd6554 and unassigned patchwork01 Mar 31, 2026

patchwork01 removed the needs-reviewer Pull requests that need a reviewer to be assigned label Mar 31, 2026

rtjd6554 added 2 commits March 31, 2026 11:07

6749: Update based on review comments

b9725b6

6749: Method simplification

df41d33

rtjd6554 removed their assignment Mar 31, 2026

patchwork01 reviewed Mar 31, 2026

View reviewed changes

patchwork01 assigned rtjd6554 Mar 31, 2026

rtjd6554 and others added 6 commits March 31, 2026 14:21

6749: Update property group for REST APJ url

f862e5a

6749: Update zip.xml

ca51ce4

Merge branch 'develop' into 6749-rest-api-shell

58b5e7c

6749: Update LambdaJar with RestAPI

4fe1236

6749: Update documentation

f20acfc

6749: Update handler

f4ca67b

Conversation

rtjd6554 commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue

Tests

Documentation

Uh oh!

patchwork01 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rtjd6554 commented Mar 30, 2026

Uh oh!

ca61688 left a comment

Choose a reason for hiding this comment

Uh oh!

ca61688 Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

rtjd6554 Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

patchwork01 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

patchwork01 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

patchwork01 Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

patchwork01 Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rtjd6554 commented Mar 10, 2026 •

edited

Loading