NHMDenmark / DaSSCo-asset-service

DaSSCo asset service is part of DaSSCo storage system
0 stars 0 forks source link

Document access control incorpartion in existing end points #101

Open bhsi-snm opened 2 weeks ago

bhsi-snm commented 2 weeks ago

Template for isues/tickets

What is the issue ?

It should also be documented how to update the relevant end points like create asset, open share etc to incorporate access control in Integration Server.

# Detailed description of the issue. 
# It could include examples,reference to similar issue and clear boundaries of the issue.
Access control was incorporated into some existing functionality, like creating asset, 
open share etc and it is a bit unclear, how should the API be called to use acces control. 
There are other endpoints like update institution, collection and we would like documented
 examples on how to use these within our workflow. FOr example: if we want to give someone
 access to a collection, or remove access to it. 

Why is it needed/relevant ?

# Explain the need, relevance.
# Give scenario(s) of why and when this could be relevant. 
Document the usage of end point to use access control 

Estimate level of effort required.

# easy
# difficult
# hard

What is the expected acceptable result.

#  How to approach it?
#  Give a clear approach/potential solution on how to resolve it.
#  What steps would be required to do this ?
#  It might also be an idea to put some pseudocode if relevant.

What could be the challenges ?

Is there a potential risk to this. 
Could it affect another part of the project. 

What test are required ?

New tests/Could include reference to the existing test

What documentation required?

Could refer to existing documentation and changes in relevant doc files.

Remarks

bhsi-snm commented 2 weeks ago

documented by christoffer and posted by @bhsi-snm at #100 Testing will be done by @bhsi-snm