Skip to content
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

Java SDK docs #172

Merged
merged 31 commits into from
Dec 13, 2023
Merged

Java SDK docs #172

merged 31 commits into from
Dec 13, 2023

Conversation

gvdongen
Copy link
Contributor

Documentation for Java SDK

@netlify
Copy link

netlify bot commented Oct 26, 2023

Deploy Preview for docsrestatedev failed.

Name Link
🔨 Latest commit 5a51d83
🔍 Latest deploy log https://app.netlify.com/sites/docsrestatedev/deploys/65607c1ca8824700083b1074

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Oct 26, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 73d2976
Status: ✅  Deploy successful!
Preview URL: https://218199d4.documentation-beg.pages.dev
Branch Preview URL: https://java-sdk-docs.documentation-beg.pages.dev

View logs

Copy link
Contributor

@slinkydeveloper slinkydeveloper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One thought I have is that maybe in the long term we might need some "SDK specific" pages, to add content specific to an sdk.

restate.config.json Outdated Show resolved Hide resolved
docs/services/sdk/awakeables.mdx Outdated Show resolved Hide resolved
docs/services/sdk/awakeables.mdx Outdated Show resolved Hide resolved
docs/services/sdk/awakeables.mdx Outdated Show resolved Hide resolved
docs/services/sdk/durable-timers.mdx Outdated Show resolved Hide resolved
docs/services/sdk/service-communication.md Outdated Show resolved Hide resolved
docs/services/sdk/service-communication.md Outdated Show resolved Hide resolved
docs/services/sdk/serving.mdx Outdated Show resolved Hide resolved
docs/services/sdk/side-effects.mdx Outdated Show resolved Hide resolved
docs/services/sdk/side-effects.mdx Outdated Show resolved Hide resolved
docs/services/sdk/serialization.mdx Outdated Show resolved Hide resolved
docs/services/sdk/serialization.mdx Outdated Show resolved Hide resolved
@slinkydeveloper slinkydeveloper linked an issue Dec 5, 2023 that may be closed by this pull request
Copy link
Contributor

@slinkydeveloper slinkydeveloper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some minor comments. LGTM

Comment on lines 37 to 57
## Discovery of services

To let Restate discover the services, execute the following curl command,
pointed at the Restate runtime and with the Lambda function endpoint as the URI in the data field.


```shell
curl -X POST http://<your-restate-runtime-endpoint>:9070/endpoints -H 'content-type: application/json' -d '{"uri": "https://<lambda-function-endpoint>/default/<my-service>"}'
```

If your Lambda function requires authentication via an API key,
then you can add this API key to the discovery request to the Restate runtime, as follows:

```shell
curl -X POST http://<your-restate-runtime-endpoint>:9070/endpoints -H 'content-type: application/json' -d '{"uri": "https://<lambda-function-endpoint>/default/<my-service>","additional_headers": {"x-api-key": "someapikey"} }'
```

Here, we added the API key as an additional header to the JSON data of the request.
Replace `someapikey` by your API key.
The Restate runtime will use this API key for all subsequent requests to the Lambda function.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unrelated to java: With the new lambda support (in runtime) this is different now, as you register using ARNs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will rebase and fix it

.github/workflows/pre-release.yml Show resolved Hide resolved
docs/services/sdk/awakeables.mdx Outdated Show resolved Hide resolved
docs/services/sdk/error-handling.mdx Show resolved Hide resolved
docs/services/sdk/kafka.mdx Outdated Show resolved Hide resolved
docs/services/sdk/logging.mdx Outdated Show resolved Hide resolved
@gvdongen gvdongen merged commit ee19246 into main Dec 13, 2023
3 checks passed
@gvdongen gvdongen deleted the java_sdk_docs branch December 14, 2023 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs for Java SDK
3 participants