-
Notifications
You must be signed in to change notification settings - Fork 1
/
ldp.raml
105 lines (101 loc) · 3.33 KB
/
ldp.raml
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
#%RAML 1.0
title: Library Data Platform API
version: v1
protocols: [ HTTP, HTTPS ]
baseUri: https://github.com/library-data-platform/mod-ldp
documentation:
- title: Library Data Platform API
content: API calls to obtain information generated by the LDP
- title: Overview
content: !include overview.md
/ldp:
/config:
description: "Configuration items"
get:
description: "Return a list of configuration items"
responses:
200:
body:
application/json:
type: !include configuration-list.json
example: !include examples/configuration-list.json
/{key}:
get:
description: "Retrieve a single configuration by key"
responses:
200:
body:
application/json:
type: !include configuration.json
example: !include examples/configuration.json
put:
description: "Modify or add a configuration by key"
body:
application/json:
type: !include configuration.json
example: !include examples/configuration.json
responses:
200:
body:
application/json:
type: !include configuration.json
example: !include examples/configuration.json
/db:
/tables:
description: "Tables in their respective schemas"
get:
description: "Return a list of all tables in all schemas"
responses:
200:
body:
application/json:
type: !include tables-schema.json
example: !include examples/tables-example.json
/columns:
description: "Columns in their table"
get:
description: "Return a list of all columns in a table. Example: /ldp/db/columns?schema=public&table=user_users"
queryParameters:
schema:
description: The name of the schema containing the specified table
type: string
required: true
example: public
table:
description: The name of the table within the specified schema
type: string
required: true
example: user_users
responses:
200:
body:
application/json:
type: !include columns-schema.json
example: !include examples/columns-example.json
/query:
description: "Query the LDP service"
post:
description: "Send a query to the LDP server and obtain results"
body:
application/json:
type: !include query-schema.json
example: !include examples/query-example.json
responses:
200:
body:
application/json:
type: !include results-schema.json
example: !include examples/results-example.json
/reports:
description: "Run a parameterized report against the LDP server"
post:
body:
application/json:
type: !include template-query-schema.json
example: !include examples/template-query-example.json
responses:
200:
body:
application/json:
type: !include template-results-schema.json
example: !include examples/template-results-example.json