Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve document on metadata fields required for status check #130

Open
newgene opened this issue Jul 22, 2021 · 1 comment
Open

Improve document on metadata fields required for status check #130

newgene opened this issue Jul 22, 2021 · 1 comment
Assignees

Comments

@newgene
Copy link
Contributor

newgene commented Jul 22, 2021

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

try:
self.api_server = api_doc['servers'][0]['url']
except KeyError:
self.api_server = None
self.api_status = 'incompatible'
if 'paths' not in api_doc:
self.api_status = 'incompatible'

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

@newgene
Copy link
Contributor Author

newgene commented Jul 22, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants