reshaping the content (+readme.md update) #13
Conversation
|
404 is because I changed the path of md files - I'll update it immediately! |
There was a problem hiding this comment.
Sorry I'm commenting late. I was away during last week. I just put my comments here in order to be more clear and for the changes we can open a new PR.
The idea of having the README file is great but I think with the way the files were moved, we're not aligned with other CAMARA projects anymore. As my understanding, we have to include them like this:
Documentation files --> repository/documentation/xxx.md files (we can still have two subfolders like you did in repository/code/API_definitions). So I think these files (xxx.md files):
https://github.com/camaraproject/NumberVerification/blob/main/code/API_definitions/CAMARA/NUMBER_VERIFICATION_API.md
https://github.com/camaraproject/NumberVerification/blob/main/code/API_definitions/MobileConnect/MC_VERIFIED_MSISDN.md
should be moved back to documentation folder, including or not another subfolder.
I also added some other comments about the resources and versioning.
| |Flavour|Endpoint type|Endpoint path| | ||
| |---|---|---| | ||
| |CAMARA|AuthN/AuthZ|| | ||
| ||resource|/verify| |
There was a problem hiding this comment.
/device-phone-number is missing here.
|
|
||
| |No|Version|Changelog| | ||
| |:---:|---:|:---| | ||
| |1|0.5.0|Camara & Mobile Connect flavours available| |
There was a problem hiding this comment.
Why version 0.5.0? To which document version does this refer?
fine tuning the content of repos