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

For each SDK, add a minimal example application #198

Closed
5 tasks done
rhamzeh opened this issue Aug 31, 2023 · 0 comments
Closed
5 tasks done

For each SDK, add a minimal example application #198

rhamzeh opened this issue Aug 31, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation dotnet-sdk Affects the C#/DotNet SDK go-sdk Affects the Go SDK good first issue Good for newcomers java-sdk Affects the Java/Kotlin SDK js-sdk Affects the JavaScript SDK python-sdk Affects the Python SDK

Comments

@rhamzeh
Copy link
Member

rhamzeh commented Aug 31, 2023

The example application would be minimal, just enough to show how one might use the SDK.

It would be sort of a cross between the README and the tests.

It would:

  1. Create a store
  2. Create another store
  3. List Stores (page size 1, paginating)
  4. Delete one of the stores
  5. Write two example authorization models
  6. Read the models, with page size 1, and paginating between them
  7. Read the latest model
  8. Write some tuples
  9. Run some checks
  10. Run ListObjects and ListRelations
  11. Delete some tuples
  12. Run ReadChanges

An added benefit is that it can act as a sort of manual integration test that we can run before releasing the SDK to ensure that nothing broke.

@rhamzeh rhamzeh added documentation Improvements or additions to documentation good first issue Good for newcomers go-sdk Affects the Go SDK dotnet-sdk Affects the C#/DotNet SDK js-sdk Affects the JavaScript SDK python-sdk Affects the Python SDK java-sdk Affects the Java/Kotlin SDK labels Aug 31, 2023
@rhamzeh rhamzeh moved this to In progress in SDKs and Tooling Jan 22, 2024
@rhamzeh rhamzeh moved this from In progress to Ready in SDKs and Tooling Jan 23, 2024
@ewanharris ewanharris self-assigned this Jan 31, 2024
@rhamzeh rhamzeh moved this from Ready to Done in SDKs and Tooling Feb 9, 2024
@rhamzeh rhamzeh closed this as completed Feb 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation dotnet-sdk Affects the C#/DotNet SDK go-sdk Affects the Go SDK good first issue Good for newcomers java-sdk Affects the Java/Kotlin SDK js-sdk Affects the JavaScript SDK python-sdk Affects the Python SDK
Projects
Archived in project
Development

No branches or pull requests

2 participants