freifunk / freifunk/api.freifunk.net

Reformat Contacts into list of contact items

Open
#36 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Makefile
Stars
51
Forks
24
PR merge metrics
No merged PRs in 30d

Description

Contact items (facebook, twitter, irc, mailing lists ...) should be restructured into a list/set of objects with following attributes:
- name (optional): human readable description
- type: type of contact (irc, facebook, mailinglist, twitter, mail, webform, wiki, ...)
- value: information to use this contact, in URI format, or user-name where no well-defined scheme exists (mailto:example-list@sample.freifunk.net, but @FreifunkSampleTown)
- display (optional): short, ready-for-display version of this item.
- priority (optional): positive, non-zero integer with lower numbers denoting higher priority

the format of the value attribute should be a consciece, maschine-readable representation of the information. If display is not given it may be assumed identical to value. Depending on the type additional, pre-parsed information may be present. e.g. type=irc may contain hostname, port, channel, flags while email may contain email, contactname, subject. Such fields, if defined are optional.

A basic set of such types should be defined as part of the specification and should be understood by clients adhering to this specification.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.