mod-audit/ramls/audit-data.raml at master · folio-org/mod-audit · 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
#%RAML 1.0

title: Audit API
baseUri: https://github.com/folio-org/mod-audit
version: v1

documentation:
  - title: mod-audit API
    content: This documents the API calls that can be made to query and manage audit records

types:
  audit: !include audit.json
  auditCollection: !include auditCollection.json
  logRecordCollection: !include logRecordCollection.json
  errors: !include raml-util/schemas/errors.schema
  error: !include raml-util/schemas/error.schema
  parameters: !include raml-util/schemas/parameters.schema
  metadata: !include raml-util/schemas/metadata.schema
traits:
  validate: !include raml-util/traits/validation.raml
  language: !include raml-util/traits/language.raml
  pageable:  !include raml-util/traits/pageable.raml
  searchable: !include raml-util/traits/searchable.raml

resourceTypes:
  collection: !include raml-util/rtypes/collection.raml
  collection-item: !include raml-util/rtypes/item-collection.raml
  collection-get: !include raml-util/rtypes/collection-get.raml

/audit-data:
  displayName: Audit data
  description: Get existing audit records or Create a new audit record
  type:
    collection:
      schemaCollection: auditCollection
      schemaItem: audit
      exampleCollection:
        strict: false
        value: !include examples/auditCollection.sample.json
      exampleItem:
        strict: false
        value: !include examples/audit.sample.json

  post:
    is: [
      validate
    ]
  get:
    is: [
      searchable: {description: "with valid searchable fields: for example link = 1234", example: "link=/users/1234"},
      pageable,
      validate
    ]
    responses:
  /{id}:
    displayName: Audit data by id
    description: Get, Delete or Update a specific audit record
    type:
      collection-item:
        schema: audit
        exampleItem:
          strict: false
          value: !include examples/audit.sample.json
    get:
      responses:
        400:
          description: "Bad request"
          body:
            text/plain:
        401:
          description: "Not authorized to perform requested action"
          body:
            text/plain:
    put:
      is: [validate]
      responses:
        400:
          description: "Bad request"
          body:
            text/plain:
        401:
          description: "Not authorized to perform requested action"
          body:
            text/plain:
    delete:
      responses:
        400:
          description: "Bad request"
          body:
            text/plain:
        401:
          description: "Not authorized to perform requested action"
          body:
            text/plain: