Recent changes to Publication API Structures

Publication API Structures modified by Eric Smith

Eric Smith — Wed, 19 Nov 2014 18:11:27 -0000

--- v12
+++ v13
@@ -14,20 +14,6 @@
 ### Publication ###

 The highest-level object within the publication API.  Represents the published form of an Edition.
-
-#### Short-form ####
-
-Used when POSTing to `/publications`.
-
-\{
-   "edition": ID of [Edition](Edition API Structures#edition),
-   "title": string,
-   "type": "PDF", "TEI", "DYNAMIC", "OAC", or "XML",
-}
-
-#### Long-form ####
-
-Returned by GETting from `/publication/`*pubID*.

 \{
    "id": ID,

Publication API Structures modified by Eric Smith

Eric Smith — Wed, 19 Nov 2014 18:10:04 -0000

--- v11
+++ v12
@@ -1,4 +1,4 @@
-Draft 2014-10-29
+Draft 2014-11-19

 ### Basic Types ###

Publication API Structures modified by Eric Smith

Eric Smith — Wed, 19 Nov 2014 18:08:58 -0000

--- v10
+++ v11
@@ -15,6 +15,20 @@

 The highest-level object within the publication API.  Represents the published form of an Edition.

+#### Short-form ####
+
+Used when POSTing to `/publications`.
+
+\{
+   "edition": ID of [Edition](Edition API Structures#edition),
+   "title": string,
+   "type": "PDF", "TEI", "DYNAMIC", "OAC", or "XML",
+}
+
+#### Long-form ####
+
+Returned by GETting from `/publication/`*pubID*.
+
 \{
    "id": ID,
    "edition": ID of [Edition](Edition API Structures#edition),
@@ -26,7 +40,6 @@
    "sections": array of [Section](Edition API Structures#section) IDs
    "permissions": array of long-form [Permissions](Edition API Structures#permission)
 }
-

 ### Section ###

Publication API Structures modified by Eric Smith

Eric Smith — Fri, 31 Oct 2014 18:03:09 -0000

--- v9
+++ v10
@@ -40,7 +40,7 @@
    "index": integer, index of Section within its Publication
    "decoration": array of [Rule](#rule) objects,
    "layout": array of [Rule](#rule) objects,
-   "outlines": array of [Outline](Edition API Structures#outline) IDs,
+   "sources": array of [Outline](Edition API Structures#outline) IDs,
    "template": string
 }

Publication API Structures modified by Eric Smith

Eric Smith — Wed, 29 Oct 2014 21:39:27 -0000

--- v8
+++ v9
@@ -23,6 +23,7 @@
    "creator": User ID,
    "creation": timestamp,
    "modification": timestamp,
+   "sections": array of [Section](Edition API Structures#section) IDs
    "permissions": array of long-form [Permissions](Edition API Structures#permission)
 }

Publication API Structures modified by Eric Smith

Eric Smith — Wed, 29 Oct 2014 18:51:34 -0000

--- v7
+++ v8
@@ -1,4 +1,4 @@
-Draft 2014-10-27
+Draft 2014-10-29

 ### Basic Types ###

@@ -19,6 +19,7 @@
    "id": ID,
    "edition": ID of [Edition](Edition API Structures#edition),
    "title": string,
+   "type": "PDF", "TEI", "DYNAMIC", "OAC", or "XML",
    "creator": User ID,
    "creation": timestamp,
    "modification": timestamp,

Publication API Structures modified by Eric Smith

Eric Smith — Tue, 28 Oct 2014 21:17:10 -0000

--- v6
+++ v7
@@ -35,6 +35,7 @@
    "publication": ID of Publication,
    "title": string,
    "type": "TEXT", "ENDNOTE", "FOOTNOTE", "INDEX", or "TABLE_OF_CONTENTS",
+   "index": integer, index of Section within its Publication
    "decoration": array of [Rule](#rule) objects,
    "layout": array of [Rule](#rule) objects,
    "outlines": array of [Outline](Edition API Structures#outline) IDs,

Publication API Structures modified by Eric Smith

Eric Smith — Mon, 27 Oct 2014 20:26:26 -0000

--- v5
+++ v6
@@ -1,4 +1,4 @@
-Draft 2014-10-08
+Draft 2014-10-27

 ### Basic Types ###

@@ -44,7 +44,7 @@

 ### Rule ###

-A transformation rule which includes a condition (typically a set of tags or annotation types), and an action which is performed on annotations which match said condition.  The simplest case of an action would be a CSS rule, but an action could be any sort of instruction which is meaningful to the front-end publication module.
+A transformation rule which includes a selector (typically a set of tags or annotation types), and an action which is performed on all annotations which match said condition.  The simplest case of an action would be a CSS rule, but an action could be any sort of instruction which is meaningful to the front-end publication module.

 \{
    "id": ID,

Publication API Structures modified by Eric Smith

Eric Smith — Wed, 08 Oct 2014 17:50:01 -0000

--- v4
+++ v5
@@ -22,7 +22,7 @@
    "creator": User ID,
    "creation": timestamp,
    "modification": timestamp,
-   "permissions": array of long-form [Permissions](Edition API Structures#permission),
+   "permissions": array of long-form [Permissions](Edition API Structures#permission)
 }

@@ -34,10 +34,10 @@
    "id": ID,
    "publication": ID of Publication,
    "title": string,
-   "type": "TEXT", "ENDNOTE", "FOOTNOTE", "INDEX", or "TABLE_OF_CONTENTS"
-   "decoration": array of [Rule](#rule) objects
-   "layout": array of [Rule](#rule) objects
-   "outlines": array of [Outline](Edition API Structures#outline) IDs
+   "type": "TEXT", "ENDNOTE", "FOOTNOTE", "INDEX", or "TABLE_OF_CONTENTS",
+   "decoration": array of [Rule](#rule) objects,
+   "layout": array of [Rule](#rule) objects,
+   "outlines": array of [Outline](Edition API Structures#outline) IDs,
    "template": string
 }

Publication API Structures modified by Eric Smith

Eric Smith — Wed, 08 Oct 2014 16:28:05 -0000

--- v3
+++ v4
@@ -1,3 +1,5 @@
+Draft 2014-10-08
+
 ### Basic Types ###

 #### ID ####
@@ -15,12 +17,12 @@

 \{
    "id": ID,
-   "edition": ID of [Edition](Edition API Structures#Edition),
+   "edition": ID of [Edition](Edition API Structures#edition),
    "title": string,
    "creator": User ID,
    "creation": timestamp,
    "modification": timestamp,
-   "permissions": array of long-form [Permissions](Edition API Structures#long-form),
+   "permissions": array of long-form [Permissions](Edition API Structures#permission),
 }

@@ -33,9 +35,9 @@
    "publication": ID of Publication,
    "title": string,
    "type": "TEXT", "ENDNOTE", "FOOTNOTE", "INDEX", or "TABLE_OF_CONTENTS"
-   "decoration": array of [Rule](#Rule) objects
-   "layout": array of [Rule](#Rule) objects
-   "outlines": array of [Outline](Edition API Structures#Outline) IDs
+   "decoration": array of [Rule](#rule) objects
+   "layout": array of [Rule](#rule) objects
+   "outlines": array of [Outline](Edition API Structures#outline) IDs
    "template": string
 }

@@ -46,7 +48,7 @@

 \{
    "id": ID,
-   "section": ID of [Section](#Section),
+   "section": ID of [Section](#section),
    "selector": string,
    "action": string
 }