web-swiss-geometa-validator/openapi.yaml at main · geoadmin/web-swiss-geometa-validator · 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
openapi: 3.0.3
info:
  title: Swiss geometa validator API
  description: >-
    A RESTful API implementation to validate XML metadata in iso19115-3.2018.che (eCH-0271) against the swiss
    geospatial metadata profile.

  version: 1.0.0
servers:
  - url: https://localhost:8000
paths:
  /api/validate:
    post:
      tags:
        - validate
      summary: Upload metadata and start validation
      description: >-
        Upload metadata in XML (following the iso19115-3.2018.che profile) and start a
        validation process. Returns the metadata uuid, title, validation status and errors if any.
      requestBody:
        description: Upload metadata and create validation task
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    format: binary
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              examples:
                validation Successful:
                  value:
                      [
                        {
                        uuid: metadata UUID,
                        title: metadata title,
                        valid: yes,
                        errors: []
                        },
                        {
                        uuid: metadata UUID,
                        title: metadata title,
                        valid: no,
                        errors: [
                          {
                          message: message error 1,
                          location: location error 1
                          },
                          {
                          message: message error 2,
                          location: location error 2
                          }
                          ]
                        }
                      ]