Mercurial > prosody-modules

annotate mod_http_xep227/README.md @ 5551:8bfcedd93a72

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_rest: List all error conditions in OpenAPI spec These are not handled by datamanager but by util.stanza and util.error, so they are not represented in the JSON schema file.
author Kim Alvefur <zash@zash.se>
date Sat, 17 Jun 2023 16:26:33 +0200
parents bd0a1f917d98
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4865
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 ---
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2 labels:
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3 - 'Stage-Alpha'
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
4 summary: 'HTTP-based account data import/export using XEP-0227'
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
5 ...
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
6
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
7 Introduction
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
8 ============
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
9
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
10 This module allows a user to import or export account data using a simple
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11 HTTP API. The data is expected to be in the format described by [XEP-0227:
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
12 Portable Import/Export Format for XMPP-IM Servers](https://xmpp.org/extensions/xep-0227.html).
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
14 Note that this module does not provide any UI for direct interaction from
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
15 users - it is expected that any UI will be provided elsewhere. For example,
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16 this module is used by the [Snikket web portal](https://github.com/snikket-im/snikket-web-portal/).
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
17
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
18 For Developers
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
19 ==========
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
20
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
21 TBD.
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
22
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
23 Compatibility
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
24 =============
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
25
bd0a1f917d98 mod_http_xep227: New module providing HTTP API for account data import/export
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
26 Requires Prosody trunk (270047afa6af).