Chunlei Wu

Update SmartAPI API metadata

2

SmartAPI API metadata is hosted here: https://github.com/SmartAPI/smartapi_registry/blob/master/SmartAPI/smartapi_openapi.yml. Let's update it to match the current implementation. related: #92

The current logic in `src/utils/monitor.py` is to pick the first entry from the `servers` block of API metadata: https://github.com/SmartAPI/smartAPI/blob/9d2079135bed7ef57e2d55d6f8f79bd0e2e92104/src/utils/monitor.py#L113 We should implement a more flexible logic to pick the "preferred"...

Currently an invalid URL like https://dev.smart-api.info/somepage return correct customized 404 page, but the status code is still 200, ideally, status code should be 404 instead.

Improve document on metadata fields required for status check

1

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](https://smart-api.info/faq#api-monitor) and...

the slug.smart-api.info link adds extra string to the URL at load time

1

The API page like: https://api.smart-api.info/ or https://mygene.smart-api.info/ should be rendered without adding the extra "/ui/" to the URL, like this one below: https://api.smart-api.info/ui/27a5b60716c3a401f2c021a5b718c5b1

Update to use OAS 3.0.3 recently released

2

https://github.com/OAI/OpenAPI-Specification/releases/tag/3.0.3 We should check the places on our side need to be updated.

Notification for duplicated API entries or other issues require user actions

6

The registered API entry in [SmartAPI](http://smart-api.info) is differential from each other based on the URL of its API metadata. If you register an URL which exists already, you will see...

The SmartAPI registry entry is here: http://smart-api.info/registry?q=c806f9a29e61e08a333260ee27a7d7e4 The registered metadata URL: https://raw.githubusercontent.com/NCATS-Tangerine/translator-api-registry/master/ebi_ontology_lookup_service_api/openapi.yml The OLS API Doc: https://www.ebi.ac.uk/ols/docs/api