Base — shared resources#
Components used across modules. A comment on a product and on an article are the same resource.
Every resource offers the standard set of actions
get, get-by, get-all, save, update-columns, delete, delete-all —
unless stated otherwise. See the CRUD pattern.
Resources#
| Resource | Note |
|---|---|
comment |
comment — owner |
comment-thread |
comment thread |
rating |
rating — owner, no update-columns |
rating-thread |
rating thread — public reading |
poll |
poll — public reading |
poll-place |
poll placement |
advert |
advertising content — public, event |
advert-place |
ad placement |
newsletter |
mailing |
newsletter-address |
subscriber |
Comments#
A thread is created automatically on the first comment. A comment attaches to a thread, not directly to content.
A new comment may not be visible at once
Depending on the site it waits for approval. The write succeeds but a listing does not return it to others.
Ratings#
A rating thread carries computed summaries — the count, the average and the star breakdown.
The summaries are stored values
They are recalculated when a rating changes. A brief mismatch with individual reviews is normal.
Polls#
Voting has an internal action with no HTTP wrapper.
You cannot vote through the API
Reading a poll, yes; casting a vote, no.
Newsletter#
An address added through the API must still be confirmed
Adding an address is not consent to a mailing. An unconfirmed address is not mailed — and that is correct.