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

api list to api get #185

Open
sarahxxu opened this issue Jul 22, 2020 · 5 comments
Open

api list to api get #185

sarahxxu opened this issue Jul 22, 2020 · 5 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@sarahxxu
Copy link

Is your feature request related to a problem? Please describe.
Currently, aio rt api list requires a base path of the api to return results. The behavior of the list command is inconsistant with other lists (like action list). We think get may be the better verb here as all other gets do expect arg to return results.

aio rt api list --help
list route/apis for Adobe I/O Runtime

USAGE
  $ aio runtime:route:list [BASEPATH] [RELPATH] [APIVERB]

ARGUMENTS
  BASEPATH  The base path of the api
  RELPATH   The path of the api relative to the base path
  APIVERB   (get|post|put|patch|delete|head|options) The http verb

Describe the solution you'd like
Instead of api list, change the default to api get and retain list as an alias for openwhisk users

Additional context
related to #184

@meryllblanchet meryllblanchet added enhancement New feature or request good first issue Good for newcomers labels Jul 22, 2020
@aiojbot
Copy link
Collaborator

aiojbot commented Jul 22, 2020

JIRA issue created: https://jira.corp.adobe.com/browse/ACNA-873

@Himavanth
Copy link
Contributor

Agreed list should not take any args but we already have a aio api get. I see this is coming from wsk cli which behaves the same.

openwhisk api does not have a list api. So both list and get use the same openwhisk get api but list command just shows the list instead of the whole api metadata.

Question in openwhisk slack about this. https://openwhisk-team.slack.com/archives/C3TPCAQG1/p1602570856060800

@meryllblanchet
Copy link

@sarahxxu see @Himavanth 's comment here. Our current behavior has feature parity with wsk and adapting the commands as suggested would break this feature parity.

How do you feel with that?

@rabbah
Copy link
Contributor

rabbah commented Nov 4, 2020

I like the idea of using list to list all APIs - if the feature is possible to implement. My point of view is that it's ok to break with wsk parity where it makes sense to improve the experience for the developer. I will help in looking to see if it's possible to even implement this (and would consider then making it a feature request for the wsk cli too).

@meryllblanchet
Copy link

Thanks for the feedback @rabbah ! @Himavanth can you follow-up with Rodric and look whether there would be a way to implement the new approach for list (and eventually contribute the changes back to wsk cli)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

6 participants