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: improve permissions documentation #2314

Merged
merged 5 commits into from Nov 30, 2022

Conversation

BalduinLandolt
Copy link
Collaborator

@BalduinLandolt BalduinLandolt commented Nov 29, 2022

Pull Request Checklist

Task Description/Number

Adds a tabular overview of all routes of the endpoint. Could serve as a first step towards an improved structure of documentation that eventually should be applied to all documented endpoints.

Basic Requirements

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix: represents bug fixes
  • Refactor: represents production code refactoring
  • Feature: represents a new feature
  • Documentation: documentation changes (no production code change)
  • Chore: maintenance tasks (no production code change)
  • Style: styles updates (no production code change)
  • Test: all about tests: adding, refactoring tests (no production code change)
  • Other... Please describe:

Does this PR introduce a breaking change?

  • Yes
  • No

Does this PR change client-test-data?

  • Yes (don't forget to update the JS-LIB team about the change)
  • No

@codecov
Copy link

codecov bot commented Nov 29, 2022

Codecov Report

Base: 86.95% // Head: 86.68% // Decreases project coverage by -0.27% ⚠️

Coverage data is based on head (0aa0af0) compared to base (bfe578a).
Patch coverage: 44.19% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2314      +/-   ##
==========================================
- Coverage   86.95%   86.68%   -0.28%     
==========================================
  Files         242      251       +9     
  Lines       28102    28253     +151     
==========================================
+ Hits        24435    24490      +55     
- Misses       3667     3763      +96     
Impacted Files Coverage Δ
...ain/scala/dsp/project/handler/ProjectHandler.scala 100.00% <ø> (ø)
.../src/main/scala/dsp/role/handler/RoleHandler.scala 88.00% <ø> (ø)
...c/main/scala/dsp/role/repo/impl/RoleRepoLive.scala 100.00% <ø> (ø)
...shared/src/main/scala/dsp/util/UuidGenerator.scala 0.00% <0.00%> (ø)
...erface/src/main/scala/dsp/user/route/GetUser.scala 0.00% <0.00%> (ø)
...ce/src/main/scala/dsp/user/route/MigrateUser.scala 0.00% <0.00%> (ø)
...ace/src/main/scala/dsp/user/route/UserRoutes.scala 0.00% <0.00%> (ø)
...c/main/scala/dsp/user/repo/impl/UserRepoLive.scala 100.00% <ø> (ø)
webapi/src/main/scala/org/knora/webapi/Main.scala 0.00% <0.00%> (ø)
...main/scala/org/knora/webapi/config/AppConfig.scala 81.63% <ø> (ø)
... and 20 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link

@irinaschubert irinaschubert left a comment

Choose a reason for hiding this comment

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

LGTM

@BalduinLandolt BalduinLandolt merged commit f4004b2 into main Nov 30, 2022
@BalduinLandolt BalduinLandolt deleted the wip/improve-permissions-documentation branch November 30, 2022 13: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.

None yet

4 participants