Esri/arcgis-rest-js

decorate feature service attachment responses w/ full urls?

Open

#371 opened on Oct 19, 2018

View on GitHubContributor guide
 (4 comments) (0 reactions) (0 assignees)TypeScript (126 forks)auto 404
good first issue

Repository metrics

Stars
 (389 stars)
PR merge metrics
 (PR metrics pending)

Description

@jPurush was going to add this code that we use in the Hub to Hub.js:

https://github.com/Esri/hub.js/blob/2ada2dfe36253e3fa5b75d4993ff28c41198d45f/packages/events/src/get.ts#L45-L60

I wonder if instead of adding it there if rest-js should be decorating the getAttachments() responses w/ the full url similar to the the suggestion for thumbnail urls #323?

As w/ that issue, I'm a bit wary of appending the token. Also it looks like the ?v= parameter is not necessarily supported by the API, but is something we added in the Hub for cache busting. Not sure if we should add that in all cases.

Alternatively, we could provide a getAttachmentUrl(featureServiceUrl: string, attachmentId: number, authentication?: IAuthenticationManager) util fn and let people .map() over the attachment infos to get the URLs themselves?

Contributor guide

Research direction
Study how attachment responses are structured and how thumbnail URLs are handled in issue #323. Examine the Hub.js code linked in the issue for URL building and token usage, then evaluate options for adding a URL helper or decorating responses.
Tech stack
typescript
Domain
api
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70