Events emitted and subscribed to by Product Opener 0.0.1 documentation

Events emitted and subscribed to by Product Opener 0.0.1

Servers

redis://redis:6379/redisredis

Operations

SEND
Operation IDproduct_updated
Available only on servers:
- redis
Accepts the following message:
Details of the product that has been updatedproduct_updated
Message IDproduct_updated
object
timestamp
integer
The Unix epoch time when this update took place

Examples values:
1234567890
code
string
The code of the product that was updated

Examples values:
"3017620420009"
rev
integer
The revision number for the change

Examples values:
194
product_type
string
The high-level type product, e.g. "food", "beauty", "petfood"

Allowed values:
"food"
"beauty"
"petfood"
"product"
flavor
deprecated
string
DEPRECATED: The product_type field should be used to identify the kind of product this event relates to. The Product Opener application type that generated the message, e.g. off, opff, off-pro

Allowed values:
"off"
"opff"
"obf"
"opf"
"off-pro"
user_id
string
The public facing user id of the user that made the edit

action
string
The nature of the change, e.g. "created", "deleted"

Allowed values:
"updated"
"created"
"deleted"
"archived"
"unarchived"
"reprocessed"
comment
string
Overview of the change, provided by the user

object
Lists of field names that were changed

Examples values:
{"fields":{"change":["categories"]}}
object
array<string>
Items:
string
array<string>
Items:
string
array<string>
Items:
string
Additional properties are allowed.
object
array<string>
Items:
string
array<string>
Items:
string
array<string>
Items:
string
Additional properties are allowed.
object
array<string>
Items:
string
array<string>
Items:
string
array<string>
Items:
string
Additional properties are allowed.
object
array<string>
Items:
string
array<string>
Items:
string
array<string>
Items:
string
Additional properties are allowed.
object
array<string>
Items:
string
array<string>
Items:
string
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
ip
string
The IP address of the client device that made the change

client_id
string
The OIDC client_id of an application that made the change on behalf of a user

Additional properties are allowed.
Examples
{ "timestamp": 1234567890, "code": "3017620420009", "rev": 194, "product_type": "food", "flavor": "off", "user_id": "string", "action": "updated", "comment": "string", "diffs": { "fields": { "change": [ "categories" ] } }, "ip": "string", "client_id": "string" }

This example has been generated automatically.
RECEIVE
Operation IDuser-registered
Available only on servers:
- redis
Accepts the following message:
Details of a new user that has registered with the appuser-registered
Message IDuser-registered
object
id
string
The internal Keycloak id of the new user

email
string
The user's email address

userName
string
The user's public facing user name

realm
string
The Keycloak realm in which the user was created

Const:"openfoodfacts"
clientId
string
The client_id of the application that initiated the new user registration process

Examples values:
"OFF"
newsletter
string
Present if the user subscribed to the newsletter

Const:"subscribe"
requestedOrg
string
The producer organization the user has requested to join

Additional properties are allowed.
Examples
{ "id": "string", "email": "string", "userName": "string", "realm": "openfoodfacts", "clientId": "OFF", "newsletter": "subscribe", "requestedOrg": "string" }

This example has been generated automatically.
RECEIVE
Operation IDuser-deleted
Available only on servers:
- redis
Accepts the following message:
Generated when a user requests to be forgottenuser-deleted
Message IDuser-deleted
object
id
string
The internal Keycloak id of the user

email
string
The user's email address

userName
string
The user's public facing user name

realm
string
The Keycloak realm

Const:"openfoodfacts"
newUserName
string
A randomly generated alias for the user that will be associated with their historic contributions

Examples values:
"anonymous-1234"
Additional properties are allowed.
Examples
{ "id": "string", "email": "string", "userName": "string", "realm": "openfoodfacts", "newUserName": "anonymous-1234" }

This example has been generated automatically.

Events emitted and subscribed to by Product Opener 0.0.1

Servers

Operations

SEND

Examples

This example has been generated automatically.

RECEIVE

Examples

This example has been generated automatically.

RECEIVE

Examples

This example has been generated automatically.