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

docs: add api collection and update readme for data exchange tutorial #155

Merged
merged 38 commits into from
Nov 7, 2024

Conversation

mgarciaLKS
Copy link
Contributor

Description

Issue #151
This PR contains the updates in the README file concerning the Data Exchange Tutorial using the SSI DIM WALLET STUB.
Also created some folders related to the docs, that contains both the Postman Collection and the Curl tutorial.

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

Copy link
Contributor

@evegufy evegufy left a comment

Choose a reason for hiding this comment

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

Looks really good! Just some comments.

Could you please remove this warning, it's obsolete since the stub has been integrated.

docs/api/curl/UmbrellaConectorDataExchange.md Outdated Show resolved Hide resolved
charts/umbrella/README.md Outdated Show resolved Hide resolved
charts/umbrella/README.md Outdated Show resolved Hide resolved
charts/umbrella/README.md Outdated Show resolved Hide resolved
charts/umbrella/README.md Outdated Show resolved Hide resolved
docs/api/curl/UmbrellaConectorDataExchange.md Outdated Show resolved Hide resolved
docs/api/curl/UmbrellaConectorDataExchange.md Outdated Show resolved Hide resolved
docs/api/curl/UmbrellaConectorDataExchange.md Outdated Show resolved Hide resolved
docs/api/curl/UmbrellaConectorDataExchange.md Outdated Show resolved Hide resolved
charts/umbrella/README.md Outdated Show resolved Hide resolved
@evegufy evegufy changed the title Add files and update README for the Data Exchange Tutorial docs: add api collection and update readme for data exchange tutorial Nov 5, 2024
@evegufy evegufy mentioned this pull request Nov 5, 2024
2 tasks
@mgarciaLKS
Copy link
Contributor Author

@evegufy As always, thank you for the time invested in this immersive correction, I have fixed the bugs and answered the ones where I had some doubts, thank you. 💪

charts/umbrella/README.md Outdated Show resolved Hide resolved
charts/umbrella/README.md Outdated Show resolved Hide resolved
charts/umbrella/README.md Outdated Show resolved Hide resolved
charts/umbrella/README.md Outdated Show resolved Hide resolved
charts/umbrella/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/api/API_Doc.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/api/API_Doc.md Outdated Show resolved Hide resolved
docs/api/curl/UmbrellaConectorDataExchange.md Outdated Show resolved Hide resolved
Copy link
Contributor

@CDiezRodriguez CDiezRodriguez left a comment

Choose a reason for hiding this comment

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

To get the simple-data-backend ingress up and running, you’ll need to do two things:

  1. Add this to your values.yaml:
  simple-data-backend:
    nameOverride: dataprovider-submodelserver
    ingress:
      enabled: true
      className: "nginx"
      hosts:
        - host: "dataprovider-submodelserver.tx.test"
          paths:
            - path: "/"
              pathType: "Prefix"
  1. Add this line to your /etc/hosts file:
192.168.49.2    dataprovider-submodelserver.tx.test

@mgarciaLKS
Copy link
Contributor Author

mgarciaLKS commented Nov 7, 2024

Thanks, @evegufy for the response.
Sorry for all the commits, thought it worked differently when accepting a change, Will do different in the next PR.
I have tested the data exchange with the new Backend and values and worked fine for me. However, the new service is not fully functional, e.g. these calls are not available, it might be interesting to add them in the future:

   "privateProperties": {
      "receiverHttpEndpoint": "{{BACKEND_SERVICE_PROTOCOL}}/api/v1/transfers"
   },

@evegufy
Copy link
Contributor

evegufy commented Nov 7, 2024

Thanks, @evegufy for the response. Sorry for all the commits, thought it worked differently when accepting a change, Will do different in the next PR. I have tested the data exchange with the new Backend and values and worked fine for me. However, the new service is not fully functional, e.g. these calls are not available, it might be interesting to add them in the future:

   "privateProperties": {
      "receiverHttpEndpoint": "{{BACKEND_SERVICE_PROTOCOL}}/api/v1/transfers"
   },

Hi @mgarciaLKS thank you! I can't really judge the impact of the simple data backend not being fully functional. Is it still possible to go through all steps of the tutorial?

docs/api/API_Doc.md Outdated Show resolved Hide resolved
Copy link
Contributor

@evegufy evegufy left a comment

Choose a reason for hiding this comment

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

Hi @mgarciaLKS looks very good! I just did some final adjustments. Thank you!

@evegufy evegufy merged commit ce71558 into eclipse-tractusx:main Nov 7, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants