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

samples: update documentation #1224

Merged
merged 2 commits into from
Apr 28, 2022
Merged

samples: update documentation #1224

merged 2 commits into from
Apr 28, 2022

Conversation

ndr-brt
Copy link
Member

@ndr-brt ndr-brt commented Apr 27, 2022

What this PR changes/adds

Update sample-03 documentation

Why it does that

It was out of date.

Further notes

Linked Issue(s)

Closes #1218

Checklist

  • added appropriate tests?
  • performed checkstyle check locally?
  • added/updated copyright headers?
  • documented public classes/methods?
  • added/updated relevant documentation?
  • added relevant details to the changelog? (skip with label no-changelog)
  • formatted title correctly? (take a look at the CONTRIBUTING and styleguide for details)

Copy link
Contributor

@ronjaquensel ronjaquensel left a comment

Choose a reason for hiding this comment

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

I think it would make sense to either add a few sentences about the token-based API authentication or remove it from the build file. Currently it's there, but is never mentioned in the README. Therefore, when someone runs this sample and tries to call the health endpoint again to see the new log prefix, they'll get a 403.

@ndr-brt
Copy link
Member Author

ndr-brt commented Apr 27, 2022

@ronjaquensel yeah, you're right, removed it from the build file and from the readme

@florianrusch-zf
Copy link
Contributor

florianrusch-zf commented Apr 27, 2022

@ronjaquensel yeah, you're right, removed it from the build file and from the readme

@ndr-brt The other samples that build on this one also use token based. Here you should possibly also take this out.

@ndr-brt
Copy link
Member Author

ndr-brt commented Apr 27, 2022

@florianrusch-zf I don't know, in sample-04.0 the "auth key" stuff is explained in the README, maybe removing it will remove value from the sample?

@florianrusch-zf
Copy link
Contributor

@ndr-brt Ahhhh sorry, of course! Then everything is fine for me so far. Thank you! :-)

@bscholtes1A bscholtes1A merged commit b0308db into eclipse-edc:main Apr 28, 2022
@ndr-brt ndr-brt deleted the bugfix/1218-update-readme branch April 28, 2022 15:13
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.

Documentation and implementation not in sync
4 participants