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

Design API for @esri/arcgis-rest-portal module #67

Closed
dbouwman opened this issue Nov 29, 2017 · 4 comments
Closed

Design API for @esri/arcgis-rest-portal module #67

dbouwman opened this issue Nov 29, 2017 · 4 comments

Comments

@dbouwman
Copy link
Member

Module that will encapsulate CRUD methods for the portal resource.

Initially, has getPortal and getSelf

@jgravois
Copy link
Contributor

jgravois commented Nov 29, 2017

putting on my outside developer 🎩

this is the first module that to me feels slightly intangible, or at least difficult to explain.

  • is there a useful way for us to distinguish (or explain the convergence) of organizations and portals in this lib?
  • riffing on @tomwayson's https://github.com/ArcGIS/arcgis-rest-js/issues/46#issuecomment-347360957, will we ultimately need to divide up concerns between portal operations and portal-admin operations?
  • perhaps the current design and name are fine and maybe we just need to flag packages like this as advanced to try not to scare off new devs when they look at our API reference for the first time?

@patrickarlt and others are currently in the process of reorganizing and porting our raw REST documentation to try and come up with a more digestible hierarchy, so perhaps we can benefit by inheriting from that new design here.

@dbouwman
Copy link
Member Author

@jgravois agreed - but it's something I need in this other app now - so if we have a better name now, I can change it.

I guess if there is going to be a pattern for "comsuming" vs "admin" modules, we can go that route as well - i.e. feature service query/edit vs service create/modify etc. But, the "portal/self" call seems ubiquitous - so much that maybe we put this in the request module itself?

@jgravois
Copy link
Contributor

jgravois commented Nov 29, 2017

the "portal/self" call seems ubiquitous - so much that maybe we put this in the request module itself?

i could definitely live with that. i actually already turned my head sideways when i realized that the new methods weren't in the same place as getPortalUrl anyway.

if anyone else is worried about bloat (presumably because ES6 imports and tree shaking aren't doing their job) that will act as an incentive to take a harder look at designing an architecture everyone can get behind.

@dbouwman
Copy link
Member Author

cool - I'll push the portal/self in #68 into the -request module, and we can decide what lands in -portal or -org or -admin-wat.

Hub does a mess of stuff w/ portalProperties so we'll need some place to have get/update fn's for the portal

@jgravois jgravois closed this as completed Nov 9, 2018
@jgravois jgravois mentioned this issue Apr 17, 2019
35 tasks
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

2 participants