apply changes made for the coordinator in marblerun.sh #21
Conversation
|
✔️ Deploy Preview for edgeless-docs ready! 🔨 Explore the source changes: 0b015fc 🔍 Inspect the deploy log: https://app.netlify.com/sites/edgeless-docs/deploys/611e1be247a7480007e8d060 😎 Browse the preview: https://deploy-preview-21--edgeless-docs.netlify.app |
|
This refers to edgelesssys/marblerun.sh@1a8180a, right? |
marblerun/reference/coordinator.md
Outdated
| ## Endpoints | ||
|
|
||
| The API currently contains the following endpoints. If an endpoint specifies *Returns* for either HTTP GET or HTTP POST, it means that the specified data can be found encoded inside the `data` block if the response was successful. If no returns are specified for a given endpoint, or in case all possible return values for an endpoint are declared as optional, `data` can just be `null`. | ||
| The API currently contains the following endpoints. If an endpoint specifies *Returns* for either HTTP GET or HTTP POST, it means that the specified data can be found encoded inside the `data` block if the response was successful. If no Returns are specified for a given endpoint, or in case all possible return values for an endpoint are declared as optional, `data` can just be `null`. |
There was a problem hiding this comment.
| The API currently contains the following endpoints. If an endpoint specifies *Returns* for either HTTP GET or HTTP POST, it means that the specified data can be found encoded inside the `data` block if the response was successful. If no Returns are specified for a given endpoint, or in case all possible return values for an endpoint are declared as optional, `data` can just be `null`. | |
| The API currently contains the following endpoints. If an endpoint specifies *Returns* for either HTTP GET or HTTP POST, it means that the specified data can be found encoded inside the `data` block if the response was successful. If no return values are specified for a given endpoint, or in case all possible return values for an endpoint are declared as optional, `data` can just be `null`. |
There was a problem hiding this comment.
The reason why I chose "Returns" was that the endpoints specify Returns, which in this context is a proper name and not a description. I think we should keep it that way.
There was a problem hiding this comment.
I would choose to go with @katexochen's suggestion. The capitalization implies that Returns are some kind of special object or action intended by us (given that capitalization usually implies the name of something). However, it's just a basic JSON response just as basically any other JSON REST API. It's a fairly easy one, even.
Also, I do not think that "endpoints specify Returns" is common terminology, at least I could not find this to be commonly used with a quick Google search.
Plus highlighting *Returns* looks weird: https://deploy-preview-21--edgeless-docs.netlify.app/marblerun/#/reference/coordinator
There was a problem hiding this comment.
It looks weird, indeed. Then let's change into your suggestion.
marblerun/reference/coordinator.md
Outdated
| ``` | ||
| Each GET request allows specifying one or more secrets in the form of a query string, where each parameter `s` specifies one secret. | ||
| A query string for the secrets `symmetric_key_shared` and `cert_shared` may look like this: | ||
| ```php |
There was a problem hiding this comment.
| ```php |
We do not use a php linter in the docs.
There was a problem hiding this comment.
I used it to highlight the request parameters, but if this is not uspported we can leave it out.
|
|
||
| ### GET | ||
| **Returns**: | ||
|
|
|
|
||
| ### GET | ||
| **Returns**: | ||
|
|
|
With #17, the |
No description provided.