Project

General

Profile

Download (7.06 KB) Statistics
| Revision:

dnet50/modules/dli-api/trunk/dli.yaml @ 49843

1 47298 sandro.lab 
---
2 
swagger: "2.0"
3 46734 sandro.lab 
info:
4 47298 sandro.lab 
  description: "API for Scholix Object"
5 46734 sandro.lab 
  version: "1.0.0"
6 47298 sandro.lab 
  title: "Scholix API"
7 
host: "api-dliservice-prototype-dli.d4science.org"
8 
basePath: "/v1"
9 46734 sandro.lab 
schemes:
10 47298 sandro.lab 
- "https"
11 46734 sandro.lab 
produces:
12 47298 sandro.lab 
- "application/json"
13 46734 sandro.lab 
paths:
14 47298 sandro.lab 
  /linksFromPid:
15 46734 sandro.lab 
    get:
16 47298 sandro.lab 
      tags:
17 
      - "Scholix"
18 
      summary: "Retrieve all scholix links from a persistent identifier"
19 
      description: "The linksFromPid endpoint returns a list of scholix object related\
20 
        \ from a specific persistent identifier\n"
21 
      operationId: "links_from_pid_get"
22 46734 sandro.lab 
      parameters:
23 47298 sandro.lab 
      - name: "pid"
24 
        in: "query"
25 
        description: "persistent Identifier"
26 
        required: true
27 
        type: "string"
28 
      - name: "pidType"
29 
        in: "query"
30 
        description: "Persistent Identifier Type"
31 
        required: false
32 
        type: "string"
33 
      - name: "typologyTarget"
34 
        in: "query"
35 
        description: "typology target filter should be  publication, dataset or unknown"
36 
        required: false
37 
        type: "string"
38 
      - name: "datasourceTarget"
39 
        in: "query"
40 
        description: "a datasource provenace filter of the target relation"
41 
        required: false
42 
        type: "string"
43 
      - name: "page"
44 
        in: "query"
45 
        description: "The page of results"
46 
        required: false
47 
        type: "integer"
48 
        format: "int32"
49 46734 sandro.lab 
      responses:
50 
        200:
51 47298 sandro.lab 
          description: "An array of scholix Object"
52 46734 sandro.lab 
          schema:
53 47298 sandro.lab 
            type: "array"
54 46734 sandro.lab 
            items:
55 47298 sandro.lab 
              $ref: "#/definitions/Scholix"
56 46734 sandro.lab 
        default:
57 47298 sandro.lab 
          description: "Unexpected error"
58 46734 sandro.lab 
          schema:
59 47298 sandro.lab 
            $ref: "#/definitions/Error"
60 
      x-swagger-router-controller: "swagger_server.controllers.scholix_controller"
61 
  /linksFromDatasource:
62 46734 sandro.lab 
    get:
63 47298 sandro.lab 
      tags:
64 
      - "Scholix"
65 
      summary: "Get all scholix relation collected from a datasource"
66 
      description: "The realtionFromDatasource endpoint returns a list of scholix\
67 
        \ object collected from\na specific datasource\n"
68 
      operationId: "links_from_datasource_get"
69 46734 sandro.lab 
      parameters:
70 47298 sandro.lab 
      - name: "datasource"
71 
        in: "query"
72 
        description: "the name of the datasource"
73 
        required: true
74 
        type: "string"
75 
      - name: "page"
76 
        in: "query"
77 
        description: "The page of results"
78 
        required: false
79 
        type: "integer"
80 
        format: "int32"
81 46734 sandro.lab 
      responses:
82 
        200:
83 47298 sandro.lab 
          description: "An array of scholix Object"
84 46734 sandro.lab 
          schema:
85 47298 sandro.lab 
            type: "array"
86 46734 sandro.lab 
            items:
87 47298 sandro.lab 
              $ref: "#/definitions/Scholix"
88 46734 sandro.lab 
        default:
89 47298 sandro.lab 
          description: "Unexpected error"
90 46734 sandro.lab 
          schema:
91 47298 sandro.lab 
            $ref: "#/definitions/Error"
92 
      x-swagger-router-controller: "swagger_server.controllers.scholix_controller"
93 
  /linksFromPublishers:
94 46734 sandro.lab 
    get:
95 47298 sandro.lab 
      tags:
96 
      - "Scholix"
97 
      summary: "Get all scholix relation collected from a publisher"
98 
      description: "The linksFromPublishers endpoint returns a list of scholix\
99 
        \ object collected from\na specific publisher\n"
100 
      operationId: "links_from_datasource_get"
101 46734 sandro.lab 
      parameters:
102 47298 sandro.lab 
      - name: "publisher"
103 
        in: "query"
104 
        description: "the name of the publisher"
105 
        required: true
106 
        type: "string"
107 
      - name: "page"
108 
        in: "query"
109 
        description: "The page of results"
110 
        required: false
111 
        type: "integer"
112 
        format: "int32"
113 46734 sandro.lab 
      responses:
114 
        200:
115 47298 sandro.lab 
          description: "An array of scholix Object"
116 46734 sandro.lab 
          schema:
117 47298 sandro.lab 
            type: "array"
118 46734 sandro.lab 
            items:
119 47298 sandro.lab 
              $ref: "#/definitions/Scholix"
120 46734 sandro.lab 
        default:
121 47298 sandro.lab 
          description: "Unexpected error"
122 46734 sandro.lab 
          schema:
123 47298 sandro.lab 
            $ref: "#/definitions/Error"
124 
      x-swagger-router-controller: "swagger_server.controllers.scholix_controller"
125 46734 sandro.lab 
  /listDatasources:
126 
    get:
127 47298 sandro.lab 
      tags:
128 
      - "Datasources"
129 
      summary: "Get the list of all Datasources"
130 
      description: "The realtionFromDatasource endpoint returns a list of scholix\
131 
        \ object collected from\na specific datasource\n"
132 
      operationId: "list_datasources_get"
133 46734 sandro.lab 
      parameters:
134 47298 sandro.lab 
      - name: "page"
135 
        in: "query"
136 
        description: "The page of results"
137 
        required: false
138 
        type: "integer"
139 
        format: "int32"
140 46734 sandro.lab 
      responses:
141 
        200:
142 47298 sandro.lab 
          description: "An array of Datasource name"
143 46734 sandro.lab 
          schema:
144 47298 sandro.lab 
            type: "array"
145 46734 sandro.lab 
            items:
146 47298 sandro.lab 
              type: "string"
147 46734 sandro.lab 
        default:
148 47298 sandro.lab 
          description: "Unexpected error"
149 46734 sandro.lab 
          schema:
150 47298 sandro.lab 
            $ref: "#/definitions/Error"
151 
      x-swagger-router-controller: "swagger_server.controllers.datasources_controller"
152 46734 sandro.lab 
definitions:
153 
  Scholix:
154 47298 sandro.lab 
    type: "object"
155 46734 sandro.lab 
    properties:
156 
      publicationDate:
157 47298 sandro.lab 
        type: "string"
158 
        format: "date"
159 46734 sandro.lab 
      linkPublisher:
160 47298 sandro.lab 
        $ref: "#/definitions/DSType"
161 46734 sandro.lab 
      linkProvider:
162 47298 sandro.lab 
        type: "array"
163 46734 sandro.lab 
        items:
164 47298 sandro.lab 
          $ref: "#/definitions/DSType"
165 46734 sandro.lab 
      relationship:
166 47298 sandro.lab 
        $ref: "#/definitions/RelationshipType"
167 46734 sandro.lab 
      source:
168 47298 sandro.lab 
        $ref: "#/definitions/ObjectType"
169 46734 sandro.lab 
      target:
170 47298 sandro.lab 
        $ref: "#/definitions/ObjectType"
171 46734 sandro.lab 
  DSType:
172 47298 sandro.lab 
    type: "object"
173 46734 sandro.lab 
    properties:
174 
      name:
175 47298 sandro.lab 
        type: "string"
176 
        description: "The name of the Repository that provides the link"
177 46734 sandro.lab 
      identifiers:
178 47298 sandro.lab 
        type: "array"
179 
        description: "a List of Identifiers that identify the repository"
180 
        items:
181 
          $ref: "#/definitions/IdentifierType"
182 46734 sandro.lab 
  ObjectType:
183 47298 sandro.lab 
    type: "object"
184 46734 sandro.lab 
    properties:
185 
      identifiers:
186 47298 sandro.lab 
        type: "array"
187 
        description: "a List of Identifiers that identify the repository"
188 
        items:
189 
          $ref: "#/definitions/IdentifierType"
190 46734 sandro.lab 
      objectType:
191 47298 sandro.lab 
        $ref: "#/definitions/ObjectType_objectType"
192 46734 sandro.lab 
      title:
193 47298 sandro.lab 
        type: "string"
194 46734 sandro.lab 
      creators:
195 47298 sandro.lab 
        type: "array"
196 
        description: "a List of Identifiers that identify the repository"
197 
        items:
198 
          $ref: "#/definitions/CreatorType"
199 46734 sandro.lab 
      publication:
200 47298 sandro.lab 
        type: "string"
201 
        format: "date"
202 46734 sandro.lab 
      objectProvider:
203 47298 sandro.lab 
        type: "array"
204 46734 sandro.lab 
        items:
205 47298 sandro.lab 
          $ref: "#/definitions/DSType"
206 46734 sandro.lab 
      publisher:
207 47298 sandro.lab 
        $ref: "#/definitions/ObjectType_publisher"
208 46734 sandro.lab 
  CreatorType:
209 47298 sandro.lab 
    type: "object"
210 46734 sandro.lab 
    properties:
211 
      name:
212 47298 sandro.lab 
        type: "string"
213 46734 sandro.lab 
      identifiers:
214 47298 sandro.lab 
        type: "array"
215 
        description: "a List of Identifiers that identify the repository"
216 
        items:
217 
          $ref: "#/definitions/IdentifierType"
218 46734 sandro.lab 
  IdentifierType:
219 47298 sandro.lab 
    type: "object"
220 46734 sandro.lab 
    properties:
221 47298 sandro.lab 
      identifier:
222 
        type: "string"
223 46734 sandro.lab 
      schema:
224 47298 sandro.lab 
        type: "string"
225 46734 sandro.lab 
  RelationshipType:
226 47298 sandro.lab 
    type: "object"
227 46734 sandro.lab 
    properties:
228 
      name:
229 47298 sandro.lab 
        type: "string"
230 46734 sandro.lab 
      schema:
231 47298 sandro.lab 
        type: "string"
232 46734 sandro.lab 
      inverseRelationship:
233 47298 sandro.lab 
        type: "string"
234 46734 sandro.lab 
  Error:
235 47298 sandro.lab 
    type: "object"
236 46734 sandro.lab 
    properties:
237 
      code:
238 47298 sandro.lab 
        type: "integer"
239 
        format: "int32"
240 46734 sandro.lab 
      message:
241 47298 sandro.lab 
        type: "string"
242 
  ObjectType_objectType:
243 
    properties:
244 
      type:
245 
        type: "string"
246 
      subType:
247 
        type: "string"
248 
  ObjectType_publisher:
249 
    properties:
250 
      name:
251 
        type: "string"
252 
      identifiers:
253 
        type: "array"
254 
        description: "a List of Identifiers that identify the repository"
255 
        items:
256 
          $ref: "#/definitions/IdentifierType"