You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Configuring an API alias implies that API description is managed automatically by API discovery or by explicit spec_files setting. If an API description is not available, API is unusable (failing with could not detect API type: https://api.ovh.com/1.0/).
It may be useful to allow to configure an API alias without enabling API description management. It may be helpful to manage base url or authentication settings on a description-less API.
A proposal for implementation would be:
base setting is used as a base URL (and can be overridden by profile)
operationId argument is used as a path argument, concatenated to base
other arguments are managed like in a classic request command
Not sure if it should need a custom attribute on api node, or if it may be a default behavior when operationId is a path (starting with /) instead of an operationId. It may allow to easily write custom request when there is a problem with API description file (missing operationId, ...).
The text was updated successfully, but these errors were encountered:
Actually this is already possible today, so I'm going to close this issue. Note that there should not be a space between the API short name and the URL path. Example:
$ restish api configure goog https://google.com
Setting up a `default` profile
? Select option for profile `default` Finished with profile
? Select option Save and exit
$ restish goog/?q=test
HTTP/2.0 200 OK
...
$ restish goog/about
HTTP/2.0 200 OK
...
Configuring an API alias implies that API description is managed automatically by API discovery or by explicit
spec_files
setting. If an API description is not available, API is unusable (failing withcould not detect API type: https://api.ovh.com/1.0/
).It may be useful to allow to configure an API alias without enabling API description management. It may be helpful to manage base url or authentication settings on a description-less API.
A proposal for implementation would be:
base
setting is used as a base URL (and can be overridden by profile)operationId
argument is used as a path argument, concatenated tobase
Not sure if it should need a custom attribute on api node, or if it may be a default behavior when
operationId
is a path (starting with/
) instead of anoperationId
. It may allow to easily write custom request when there is a problem with API description file (missingoperationId
, ...).The text was updated successfully, but these errors were encountered: