-
Notifications
You must be signed in to change notification settings - Fork 2
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
Create spec for service API v2 #4
Comments
FTR (requires further investigation): POST might cause issues with shibbolized services, while URL-encoded GET parameters should be passed through transparently. |
I assume this issue entails a redesign/extension of the registry format. You may want to look into the related work done in CLAM and also in the OpenAPI Initiative (formerly known as swagger), both are a lot more expressive than the current switchboard registry and support things like multiple inputs (and full parametrisation, but you may not want to go that far for the switchboard). For generic tool metadata, I'd also recommend taking a look at codemeta, which maps various metadata schemes to a common vocabulary. |
done now, documented in clarin-eric/switchboard-doc#15 |
Currently planned are multiple inputs and for each input a more detailed description:
A general reorganization of the tasks/endopoints is needed: A tool should have multiple tasks with possibly different endpoints and parameters. For example Weblicht should be described by a single file with multiple entries for tasks and parameters, not by multiple files, each one for one task.
Other questions/requirements:
The text was updated successfully, but these errors were encountered: