openapi/nen-projects-openapi3.yaml at main · Netherlands-Standardization-Institute/openapi · 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
openapi: 3.0.0
servers:
  - url: 'https://2wderi5mvk.execute-api.eu-central-1.amazonaws.com/prod'
info:
  description: See [SDO Harmonized Interfaces](https://bitbucket.org/sdo-hapi/) for more information about this API
  version: 1.1.1
  title: NEN Projects API
tags:
  - name: Projects
    description: Projects API
paths:
  /search:
    get:
      tags:
        - Projects
      summary: Search projects
      operationId: searchProjectsUsingGET
      parameters:
        - name: q
          in: query
          description: the search query
          required: true
          allowEmptyValue: false
          schema:
            type: string
      responses:
        '200':
          description: OK
        '400':
          description: Bad request (parameters syntax or semantics)

  '/projects/{urn}':
    get:
      tags:
        - Projects
      summary: Retrieve a specific project by its URN
      operationId: getProjectUsingGET
      parameters:
        - name: urn
          in: path
          description: the project URN
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Project found
        '404':
          description: Project not found