DocumentReader-web-openapi/p-doclist.yml at develop · regulaforensics/DocumentReader-web-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
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
openapi: 3.0.4
paths:
  /doclist:
    get:
      summary: "Returns the list of documents stored in the database that the Web Service API is running with."
      operationId: doclist
      tags:
        - resources
      responses:
        200:
          description: "The list of documents stored in the database."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DatabaseDocumentList"

components:
  schemas:
    DatabaseDocumentList:
      title: "DatabaseDocumentList"
      type: object
      required:
        - items
      properties:
        items:
          description: "The list of documents stored in the database."
          type: array
          items:
            $ref: "#/components/schemas/DatabaseDocument"

    DatabaseDocument:
      title: "DatabaseDocument"
      type: object
      required:
        - barcode_fields
        - country
        - created
        - doc_type
        - document
        - graphic_fields
        - id
        - mrz
        - rfid_chip
        - text_fields
        - updated
      properties:
        barcode_fields:
          description: "Whether the document has a barcode."
          type: boolean
        country:
          description: "Country name."
          type: string
        created:
          description: "Date when the document description was created in the database."
          type: string
        doc_type:
          $ref: "./e-document-type.yml#/components/schemas/DocumentType"
        document:
          description: "Document name."
          type: string
        graphic_fields:
          description: "The presence of graphic fields in the document."
          type: boolean
        id:
          description: "Document code."
          type: integer
        mrz:
          description: "The document has an MRZ."
          type: boolean
        region:
          description: "Country region."
          type: string
        rfid_chip:
          description: "The document has an RFID chip."
          type: boolean
        text_fields:
          description: "The presence of text fields in the document."
          type: boolean
        updated:
          description: "Date when the document description was updated in the database."
          type: string
        year:
          description: "The year when the document was issued."
          type: string
        sovereignty:
          description: "Guardian country."
          type: string
        deprecated:
          description: "Whether the document is no longer in circulation."
          type: boolean
        icao_code:
          description: "ICAO country code."
          type: string
        doc_codes:
          description: "Document codes."
          type: string