Improve current documentation for SQAaaS API #16
Conversation
Signed-off-by: Samuel Bernardo <[email protected]>
…deployment Signed-off-by: Samuel Bernardo <[email protected]>
| @@ -107,7 +107,8 @@ A new Docker controller image has to be built to add the formerly modified | |||
| included in this template (njs module & `oauth2_token_introspection` folder). | |||
|
|
|||
| You just need to follow the instructions in the `ingress-nginx` repository and | |||
| run something similar to the following: | |||
| review the [development guidelines](https://kubernetes.github.io/ingress-nginx/development/). | |||
There was a problem hiding this comment.
https://kubernetes.github.io/ingress-nginx/development/
Just accessed this url and it opens with following page:
https://ibb.co/8z24JLY
| ### Testing the API | ||
| Get the refresh and access token from [EGI Check-in AAI dev](https://aai-dev.egi.eu/fedcloud/) using Fedcloud web interface. After the OIDC validation in web interface, the access token can be generated using the provided command that should appear there with the following syntax: | ||
| ``` | ||
| curl -X POST -u '<client id>':'<client secret>' -d 'client_id=<client id>&client_secret=<client secret>&grant_type=refresh_token&refresh_token=<refresh token>&scope=openid%20email%20profile' 'https://aai-dev.egi.eu/oidc/token' | python -m json.tool; |
There was a problem hiding this comment.
Here you need the <refresh-token>, but there is no hint about how to get it. If it is related to the outcome of the former "OIDC validation in the web interface" statement, we should indicate how to tackle this last action
There was a problem hiding this comment.
Yes, you're right is not explicit...
When using the web interface it lists multiple properties as the result and one of them is the . They also provide the complete oneliner with all fields already fulfilled.
@orviz Can you test the suggested procedure and see if any other detail is missing?
There was a problem hiding this comment.
Maybe it would be good to add a screenshot:
BTW didn't work with Chromium, only with Firefox. If you can reproduce this, it should be helpful to document the issue
| ``` | ||
|
|
||
| The curl command returns the JSON web token (JWT) that have the keys named `access_token` and `token_type` must have the value "Bearer". | ||
|
|
| The curl command returns the JSON web token (JWT) that have the keys named `access_token` and `token_type` must have the value "Bearer". | ||
|
|
||
|
|
||
| Finally, to test the API the following commands should return http 200 code for each deployed endpoint. The following examples are specific for current EOSC Synergy deployment. |
There was a problem hiding this comment.
maybe emphasize the last sentence?
| curl -X GET -IH 'Authorization: Bearer <access_token>' https://api-staging.sqaaas.eosc-synergy.eu/v1/ui/ | ||
| ``` | ||
|
|
||
| * Development (note that in this case v1 is surpressed since api-dev is only a mock server): |
Add some references and how to test the API.