Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Rename map identifiers to tileset identifiers #14551

Closed
1ec5 opened this issue Apr 30, 2019 · 5 comments
Closed

Rename map identifiers to tileset identifiers #14551

1ec5 opened this issue Apr 30, 2019 · 5 comments
Labels
bug documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS

Comments

@1ec5
Copy link
Contributor

1ec5 commented Apr 30, 2019

Map IDs are being renamed to tileset IDs across the board. We refer to map IDs in a couple places in the iOS/macOS map SDK’s header documentation:

Mapbox URL indicating a map identifier (`mapbox://<mapid>`). The URL should
Mapbox URL indicating a map identifier (`mapbox://<mapid>`). The URL should

There are also several occurrences of “a Mapbox URL indicating the style’s map ID”, which is inaccurate following #1561. These occurrences should be replaced by “a Mapbox URL identifying the style”:

map ID (`mapbox://styles/{user}/{style}`).
map ID (`mapbox://styles/<user>/<style>`), or a path to a local file
may be a full HTTP or HTTPS URL or a Mapbox URL indicating the style’s map
ID (`mapbox://styles/{user}/{style}`). Specify `nil` for the default style.
may be a full HTTP or HTTPS URL or a Mapbox URL indicating the style’s map
ID (`mapbox://styles/{user}/{style}`). Specify `nil` for the default style.
HTTPS URL, a Mapbox URL indicating the style’s map ID
HTTPS URL, a Mapbox URL indicating the style’s map ID
map ID (`mapbox://styles/<user>/<style>`), or a path to a local file relative
or HTTPS URL, a Mapbox URL indicating the style’s map ID
map ID (`mapbox://styles/{user}/{style}`), or a path to a local file

/cc @mapbox/maps-ios @brsbl

@1ec5 1ec5 added bug iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS documentation labels Apr 30, 2019
@zugaldia
Copy link
Member

zugaldia commented May 1, 2019

/cc: @tobrun for Android.

@tobrun
Copy link
Member

tobrun commented Jun 17, 2019

/cc: @tobrun for Android.

I believe nothing needs to be picked up from Android as we don't use the terms map ID

@HeyStenson
Copy link
Contributor

HeyStenson commented Jul 12, 2019

@1ec5 In looking at this, it seems that in several cases we're using the term style's map ID to refer to a style url (rather than a map ID/tileset ID).

I believe that in your OP, that's the case in the following files:

  • mapbox-gl-native/platform/darwin/src/MGLOfflineRegion.h
  • mapbox-gl-native/platform/macos/src/MGLMapView+IBAdditions.h
  • mapbox-gl-native/platform/darwin/src/MGLShapeOfflineRegion.h
  • mapbox-gl-native/platform/darwin/src/MGLTilePyramidOfflineRegion.h
  • mapbox-gl-native/platform/darwin/src/MGLMapSnapshotter.h
  • mapbox-gl-native/platform/macos/src/MGLMapView.h
  • mapbox-gl-native/platform/ios/src/MGLMapView.h

If that's correct, only the following need to have language changed from map ID to tileset ID:

  • mapbox-gl-native/platform/darwin/src/MGLRasterTileSource.h
  • mapbox-gl-native/platform/darwin/src/MGLVectorTileSource.h

and we should consider changing the rest of the instances you found to style URL instead. Does that sound right to you?

EDIT: Reading comprehension fail! Sorry, @1ec5, completely glossed over the fact that you already pointed out that we are referring incorrectly to map IDs in your original post 😬

@julianrex
Copy link
Contributor

Sounds good to me.

@julianrex
Copy link
Contributor

Fixed in #15116

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS
Projects
None yet
Development

No branches or pull requests

5 participants