feat: edit extensions documentation to include outbound/internal calls #1878
Conversation
|
|
||
|  | ||
| <!-- TODO: Do we have here a link with a comprehensible list of these APIs? --> | ||
| It is also possible to configure the extension to communicate with other external APIs, as well with the Mia-Platform supported APIs. |
There was a problem hiding this comment.
I wish to add a link to a comprehensible list of APIs here. I don't know if there's one yet, any suggestion on how better rephrase this to emphasize the concept of internal APIs would be greatly appreciated.
|
|
||
| In the configuration page there will also be an URL next to the _Base URL to contact your APIs_ label. This URL is the one to be used to access the APIs from your endpoint. | ||
| <!-- TODO: Are security reasons? Should I be more specific? --> | ||
| In fact, for security reasons, the URL to be called is not the destination URL itself, but a different one that is the one that will be used to access the APIs |
There was a problem hiding this comment.
How can I rephrase this to better explain the security reasons behind the choice to use a Proxy instead of using the Destination URL itself?
| @@ -68,35 +71,110 @@ On this page, you can: | |||
|
|
|||
| ## Extension Detail | |||
There was a problem hiding this comment.
I wonder if it is ok to remove the sections Extension Info, Extension Location and Extension Visibility, given the little amount of information included in these paragraphs, and group them in just one section.
The UI however includes a link to each of the three cards related to the aforementioned sections of the documentation. These card are in the same page.
I wonder if it is better to maintain the previous approach (multiple paragraph) in order to have a more consistent UI, or to keep going with the approach suggested in this PR.
Co-authored-by: Marco Filippi <[email protected]>
Description
This pull request includes updates on the Manage Extensions page, trimming a little the part dedicated to the detail (too many images, I'd say) and include a new section dedicated to the Outbound Calls and the Internal Calls.
The new updates are mostly based on what is available on the Mia-Platform Console frontend, thus might require some polishing and better explanations on the why some choices have been made and give some use cases.
Pull Request Type
PR Checklist
Other information