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 integration documentation #59

Open
ainmosni opened this issue Sep 11, 2024 · 0 comments
Open

Add integration documentation #59

ainmosni opened this issue Sep 11, 2024 · 0 comments

Comments

@ainmosni
Copy link
Contributor

People who want to join a dataspace using RUN-DSP need to have a guide to follow on how to do so.

This document should be a high level guide on how to use RUN-DSP to join a dataspace, and it should contain:

  • A description of what a dataspace is and what joining it entails.
  • A small description of RUN-DSP and how it can facilitate the dataspace interaction.
  • A small description of RUN-DSP and how it uses providers to interact with the readers infrastructure.
  • A link to the GRPC binding repository
  • A description of what the functions in the GRPC functions should expect in arguments and what they should return.
  • A description of how to test their provider.
  • A link to the reference provider as an example of a working provider.
  • A word highlighting how RUN-DSP passes through authentication, and how the provider has to handle that.
  • A word how the current state is under rapid development and that there's no promise of APIs remaining stable until later.

This documentation is probably best written after #58 has been completed.

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

No branches or pull requests

1 participant