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

add JavaScript sdk #399

Merged
merged 2 commits into from
Mar 29, 2023
Merged

add JavaScript sdk #399

merged 2 commits into from
Mar 29, 2023

Conversation

svozza
Copy link
Contributor

@svozza svozza commented Mar 14, 2023

Issue #, if available:
Implements #11

Description of changes:

This PR implements the JavaScript API detailed in the following design doc. Of the choices outlined in this doc, we have chosen the following:

  1. Configuration will be explicit, so users must provide the AppSync URL and cross account discovery mode when creating the client.
  2. The client will only support a subset of operations:
    • All mutations that write to Neptune and OpenSearch are not supported
    • In AWS_ORGANIZATIONS mode, all operations relating to importing accounts are not supported

The package name @aws/workload-discovery-sdk referenced in the documentation is only a placeholder, we will change this to reflect the name and organization we ultimately choose to use when publishing to NPM.

As the package has not been published to NPM yet, this means we are still free to make changes to how the SDK works so this may not be the final version that we eventually ship.

@svozza svozza marked this pull request as draft March 14, 2023 16:17
@svozza svozza force-pushed the create-sdk branch 10 times, most recently from 33a58c9 to 4073139 Compare March 15, 2023 12:00
@svozza svozza marked this pull request as ready for review March 15, 2023 12:16
@svozza svozza force-pushed the create-sdk branch 6 times, most recently from afefd05 to e911551 Compare March 16, 2023 10:40
source/sdk/js/README.md Outdated Show resolved Hide resolved
Co-authored-by: Connor Kirkpatrick <[email protected]>
Copy link
Contributor

@ConnorKirk ConnorKirk left a comment

Choose a reason for hiding this comment

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

Looks good. Nice work Stefano

@svozza svozza merged commit 7762d13 into dev Mar 29, 2023
@svozza svozza deleted the create-sdk branch March 29, 2023 10:55
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.

2 participants