API Stikis Resource
Stikis hold display information for pieces of Content in the context of a Page. Stikis have owners through their inclusion in a page, and only that person can update or delete them. The following table summarizes the attributes and constraints on Stikis resources.
| Attribute | Description | Constraints | Default | Read-only | Required on create |
|---|---|---|---|---|---|
| id | A unique numeric identifier for the stiki. | Positive integer. | nil | yes | no |
| page_id | The page that the stiki belongs to (and by extension the user). | Positive integer. Must refer to an existing page. | nil | no | yes (determined from nested url) |
| left_edge | A numeric value representing the left position of the stiki on the page (ems in html). | Float. | 2.0 | no | no |
| top_edge | A numeric value representing the top position of the stiki on the page (ems in html). | Float. | 2.0 | no | no |
| width | The width of the stiki (ems in html). | Positive float. | 12.0 | no | no |
| height | The height of the stiki (ems in html). | Positive float. | 12.0 | no | no |
| z-index | Where the stiki sits in the z-order. IE. whether a stiki is in front, or behind others. ’’’NOTE: This is currently not properly implemented’’’ | Signed integer | 0 | no | no |
| color | The color of the stiki. | Any valid CSS color string. | “#F0E68C” | no | no |
| created_at | The date and time that the stiki was created. | Datetime. | nil | yes | no |
| updated_at | The date and time that the stiki was last updated. | Datetime. | nil | yes | no |
Available actions
- Create: Create a new stiki on the site.
- Destroy: Delete a stiki from the site.
- Edit: Get a form for updating a stiki.
- Index: Get a list of all stikis belonging to a user.
- New: Get a form for creating a new stiki.
- Show: Retrieve a copy of a stiki.
- Update: Update the attributes of a stiki.
Likely changes
Once Pages resources become shareable, the ‘sharability’ of stikis will also change.