mapbox / mapbox/vector-tile-spec

Private-use messages

Open
#107 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.0 Specification
Dominant language
No language data
Stars
1k
Forks
213
PR merge metrics
No merged PRs in 30d

Description

Creators and users of vector tiles should be able to include private messages within tiles, layers, and features, by mutual agreement. Other software that doesn't know how to interpret these messages should pass them through as opaque blobs to the extent that is possible.

Something like:

```
message private {
required string = 1;
extensions 20 to max;
}
```

and then in each of `tile`, `layer`, and `feature`,
```
repeated private = 6;
```

(or some other number).

One of the options for `value` could also be an object of this type if there is a need for opaque feature attributes.

The `string` in the `private` message would be the URL for the specification for the private message type. There is no need for software to actually download a file from the URL; it just serves to distinguish one type of private message from another.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test entry point is named. Review the vector-tile specification and the existing tile, layer, and feature definitions, then determine whether the proposed private-message extension is accepted and how opaque pass-through should be specified; done would be an agreed schema and documented behavior.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.