lumen-cms-api/apiary.apib at master · commadore/lumen-cms-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
FORMAT: 1A
HOST: http://content.apiblueprint.org/

# Content API

Content is a simple API allowing consumers to CRUD content.

# /pages
## GET
    + Headers

        sitecode: slotto

+ Response 200 (application/json)

        [
            {
                "id": 1,
                "route": "blog/hello",
                "layout": "single-column",
                "contents" : [{
                    "header" : "html",
                    "main" : "html",
                    "footer" :"html"
                }]
            }
        ]
+ Response 403
+ Response 404

# /pages/{id}
## GET
    + Parameters
        + id (int) the id of the page
        + Headers

            sitecode: slotto

+ Response 200 (application/json)

        {
            "id": 1,
            "route": "blog/hello",
            "layout": "single-column",
            "contents" : [{
                "header" : "html",
                "main" : "html",
                "footer" :"html"
            }],
            "published" : true
        }

+ Response 403
+ Response 404

## PUT
    + Parameters
        + id (int) the id of the page
        + Headers

            sitecode: slotto
    + Body
        {
                "id" : 1,
                "route": "blog/goodbye",
                "name" : "Blog Page 2",
                "layout": 2,
                "published" : true
        }
+ Response 200 (application/json)

            {
                "id": 1,
                "route": "blog/hello",
                "name" : "Blog Page",
                "layout": "single-column",
                "contents" : [{
                    "header" : "html",
                    "main" : "html",
                    "footer" :"html"
                }],
                "published" : true
            }
+ Response 403
+ Response 404

## POST
    + Parameters
        + id (int) the id of the page
        + Headers

            sitecode: slotto
    + Body
        {
                "route": "blog/hello",
                "name" : "Blog Page",
                "layout": 1,
                "published" : false
        }
+ Response 201
    + Headers

            Location: pages/1

+ Response 403
+ Response 404

## DELETE
    + Parameters
        + id (int) the id of the page
        + Headers

            sitecode: slotto
+ Response 204
+ Response 403
+ Response 404