Skip to content
This repository has been archived by the owner on Jul 24, 2024. It is now read-only.

API Client Connector #43

Open
dongniwang opened this issue Sep 29, 2017 · 5 comments
Open

API Client Connector #43

dongniwang opened this issue Sep 29, 2017 · 5 comments
Assignees
Milestone

Comments

@dongniwang
Copy link
Contributor

dongniwang commented Sep 29, 2017

API client connectors will show up in first step of Create Connection flow as available connectors.

api connector

image

@amysueg
Copy link
Contributor

amysueg commented Sep 29, 2017

20170927_110043

whiteboard steps for API connector POC (dev & UX)

@sjcox-rh
Copy link
Contributor

Designs for issue found here:

#49

Please review!
@dongniwang @amysueg @rhuss @gashcrumb @kahboom @kcbabo

@kcbabo
Copy link

kcbabo commented Oct 30, 2017

Thanks for sharing, SJ. A couple comments ...

I thought we discussed providing a Swagger UI-like view of the resource paths and verbs instead of the traditional action list? If we go with a traditional action view, then we need to be prepared for:

  • Large number of actions (# or resource paths * # of verbs supported).
  • How will we generate unique action names for the above (e.g. HTTP GET for /pets)?
  • Quite possible the Swagger will not have documentation on individual resource path + verb entries, so action description could be blank for most/all in some cases.
  • How will a user find the action they want in a potentially large list?

I can't remember if we thought there was a need for action configuration for API connector. If so, we might need to discuss designs around that part as well.

@sjcox-rh
Copy link
Contributor

@kcbabo Thanks for the feedback! I will update the review page to reflect more of a swagger ui with resource paths as the categories and actions/verbs listed under, like so:

screen shot 2017-10-31 at 10 41 54 am

That's what you're referring to correct? We would still want to possibly consider a large list. Perhaps just enable scrolling and utilize the filter tool we use throughout the app.

As for configuration for actions, I had that in the original design but we discussed to remove that functionality for the time being and just list everything to serve more as a review step. No action needed for this step in the workflow. Since this step is more of a review, would we still need the ability to search/filter at this time?

@dongniwang @amysueg thoughts?

@sjcox-rh
Copy link
Contributor

@zregvart Sorry forgot to tag you in the PR! Please provide feedback on the designs for API client connector:

#49

I will be updating the review page to reflect a more swagger-like UI.

Thanks!

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

No branches or pull requests

5 participants