@tillhub/schemas 6.118.1 → 6.119.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [6.119.0](https://github.com/tillhub/schemas/compare/v6.118.1...v6.119.0) (2022-02-15)
+
+
+### Features
+
+* **audits:** add audit logs response schema #API-1331 ([#668](https://github.com/tillhub/schemas/issues/668)) ([057c73e](https://github.com/tillhub/schemas/commit/057c73e)), closes [#API-1331](https://github.com/tillhub/schemas/issues/API-1331) [#API-1331](https://github.com/tillhub/schemas/issues/API-1331)
+
 ## [6.118.1](https://github.com/tillhub/schemas/compare/v6.118.0...v6.118.1) (2022-02-14)
 
 

package/lib/common/response.js

@@ -84,7 +84,7 @@ function commonResponse ({ resultItems, results, additionals } = {}, { hasCursor
     }
   }
 
-  if (hasCursor) response.cursor = cursor
+  if (hasCursor) response.properties.cursor = cursor
 
   return response
 }

package/lib/v0/audits/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  logs: require('./logs')
+}

package/lib/v0/audits/logs/base.js

@@ -0,0 +1,81 @@
+const { oneOf } = require('../../../helpers/payload-or-null')
+
+const changeEntry = {
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    op: {
+      description: 'Operation type',
+      type: 'string',
+      enum: [
+        'add',
+        'replace',
+        'remove'
+      ]
+    },
+    path: {
+      description: 'Changed property path (with dot as separator)',
+      type: 'string',
+      example: 'images.0.url'
+    },
+    value: {
+      description: 'Changed value',
+      type: 'string',
+      example: 'This is it'
+    }
+  }
+}
+
+module.exports = {
+  type: {
+    description: 'Log type (entity type and action type)',
+    type: 'string',
+    example: 'product.update'
+  },
+  old: oneOf({
+    description: 'Old data',
+    type: 'object',
+    example: {}
+  }),
+  new: oneOf({
+    description: 'New data',
+    type: 'object',
+    example: {
+      id: '0f91b67b-b1eb-4aba-827a-3a83ff967c5e',
+      name: 'Foo bar'
+    }
+  }),
+  change: oneOf({
+    description: 'Changes between old and new',
+    type: 'array',
+    items: changeEntry
+  }),
+  description: oneOf({
+    description: 'Description',
+    type: 'string',
+    example: 'Login attempt from service account'
+  }),
+  issuer: oneOf({
+    description: 'Issuer data',
+    type: 'object',
+    properties: {
+      sub_user: {
+        description: 'Sub-user (person authorized under organization account) UUID',
+        type: 'string',
+        format: 'uuid',
+        example: '8ddb94bf-98cf-4832-9833-c118ebf04675'
+      }
+    }
+  }),
+  metadata: oneOf({
+    description: 'Metadata',
+    type: 'object',
+    properties: {
+      user_agent: {
+        description: 'User-agent data',
+        type: 'string',
+        example: 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.99 Safari/537.36'
+      }
+    }
+  })
+}

package/lib/v0/audits/logs/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  read: require('./read')
+}

package/lib/v0/audits/logs/read.js

@@ -0,0 +1,30 @@
+const commonBase = { ...require('../../../common/base') }
+const commonResponse = require('../../../common/response')
+const { oneOf } = require('../../../helpers/payload-or-null')
+
+const base = require('./base')
+
+// Logs are read-only
+delete commonBase.updated_at
+
+module.exports.response = {
+  $id: 'https://schemas.tillhub.com/v0/audits.logs.read.response.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  additionalProperties: false,
+  ...commonResponse({
+    resultItems: {
+      type: 'object',
+      required: ['id', 'created_at', 'insert_id', 'type'],
+      additionalProperties: false,
+      properties: {
+        ...commonBase,
+        insert_id: oneOf({
+          description: 'Sequential counter',
+          type: 'integer',
+          example: 16259
+        }),
+        ...base
+      }
+    }
+  }, { hasCursor: true })
+}

package/lib/v0/index.js

@@ -1,3 +1,4 @@
+module.exports.audits = require('./audits')
 module.exports.products = require('./products')
 module.exports.product_groups = require('./product_groups')
 module.exports.product_templates = require('./product_templates')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tillhub/schemas",
-  "version": "6.118.1",
+  "version": "6.119.0",
   "private": false,
   "description": "All Tillhub API OpenAPI 3 compatible JSON Schemas.",
   "main": "./lib/index.js",

package/test/audits/logs/logs.spec.js

@@ -0,0 +1,11 @@
+const test = require('tape')
+const validate = require('../../helpers/validate-schema')
+
+test('Audits:logs: read.response schema validation', function (t) {
+  t.plan(2)
+  const readResponse = require('../../../lib/v0/audits/logs').read.response
+  const { valid, error } = validate(readResponse)
+  t.ok(valid, 'create schema is valid')
+  t.error(error, 'should not get any error')
+  t.end()
+})