view doc/libervia-cli/pubsub_node_schema.rst @ 3728:b15644cae50d

component AP gateway: JID/node ⟺ AP outbox conversion: - convert a combination of JID and optional pubsub node to AP actor handle (see `getJIDAndNode` for details) and vice versa - the gateway now provides a Pubsub service - retrieve pubsub node and convert it to AP collection, AP pagination is converted to RSM - do the opposite: convert AP collection to pubsub and handle RSM request. Due to ActivityStream collection pagination limitations, some RSM request produce inefficient requests, but caching should be used most of the time in the future and avoid the problem. - set specific name to HTTP Server - new `local_only` setting (`True` by default) to indicate if the gateway can request or not XMPP Pubsub nodes from other servers - disco info now specifies important features such as Pubsub RSM, and nodes metadata ticket 363
author Goffi <goffi@goffi.org>
date Tue, 25 Jan 2022 17:54:06 +0100
parents 267e4987b58b
children
line wrap: on
line source

.. _libervia-cli_pubsub_node_schema:

=========================================
pubsub/node/schema: nodes schema handling
=========================================

``node schema`` is an experimental feature to associate a data form with a PubSub node, and
reject items not following this form. This feature is currently only available with Libervia
PubSub.

Those commands can only be used by an owner of the node.

set
===

Set the schema of a node. The raw schema is written directly as positional argument.

example
-------

Set the schema for tickets node using the file ``tickets_schema.xml`` from ``$HOME``
directory. Shell substition is used here to put the content of the file in the positional
argument::

  $ li pubsub node schema set -n org.salut-a-toi.tickets:0 -s pubsub.example.org "$(<~/test_schema.xml)"


edit
====

Edit the schema of a node using your local editor (the one set in ``$EDITOR``).

If you don't change anything or publish an empty schema, the edition will be cancelled.

:ref:`draft_common` commands can be used.

example
-------

Edit the tickets node schema::

  $ li pubsub node schema edit -n org.salut-a-toi.tickets:0 -s pubsub.example.org


example
-------

get
===

Retrieve schema of a node.

example
-------

Get schema of tickets and save it to a file named ``tickets_schema.xml`` in ``$HOME``
directory::

  $ li pubsub node schema get -n org.salut-a-toi.tickets:0 -s pubsub.example.org > ~/tickets_schema.xml