smartAPI icon indicating copy to clipboard operation
smartAPI copied to clipboard

Improve document on metadata fields required for status check

Open newgene opened this issue 4 years ago • 1 comments

SmartAPI status check does requires servers and paths fields, in addition to the example values for the required parameter(s):

https://github.com/SmartAPI/smartAPI/blob/90f45105613d5d1d6cd6bf2181e4ba0b1e24647b/src/utils/monitor.py#L58-L64

Let's state these requirements cleanly in the faq item and update the wording in the status popup dialog.

newgene avatar Jul 22 '21 20:07 newgene

servers and paths are not required by the OpenAPI specs, so it may be missing from the registered API. We can potentially add a warning msg for these "recommended" but not required fields.

newgene avatar Jul 22 '21 20:07 newgene