screwdriver-data-schema 21.28.4 → 22.0.0

package/core/scm.js

@@ -12,15 +12,9 @@ const SCHEMA_USER = Joi.object()
             .label('Link to Profile')
             .example('https://github.com/stjohnjohnson'),
 
-        name: Joi.string()
-            .required()
-            .label('Display Name')
-            .example('Dao Lam'),
+        name: Joi.string().required().label('Display Name').example('Dao Lam'),
 
-        username: Joi.string()
-            .required()
-            .label('Username')
-            .example('d2lam'),
+        username: Joi.string().required().label('Username').example('d2lam'),
 
         avatar: Joi.string()
             .uri()
@@ -47,10 +41,7 @@ const SCHEMA_REPO = Joi.object()
     .keys({
         name: REPO_NAME,
 
-        branch: Joi.string()
-            .required()
-            .label('Branch of the repository')
-            .example('master'),
+        branch: Joi.string().required().label('Branch of the repository').example('master'),
 
         url: Joi.string()
             .uri()
@@ -58,9 +49,7 @@ const SCHEMA_REPO = Joi.object()
             .label('Link to Repository')
             .example('https://github.com/screwdriver-cd/screwdriver/tree/master'),
 
-        private: Joi.boolean()
-            .optional()
-            .label('Whether or not the pipeline is private'),
+        private: Joi.boolean().optional().label('Whether or not the pipeline is private'),
 
         rootDir: ROOT_DIR
     })
@@ -68,23 +57,15 @@ const SCHEMA_REPO = Joi.object()
 
 const SCHEMA_COMMAND = Joi.object()
     .keys({
-        name: Joi.equal('sd-checkout-code')
-            .required()
-            .label('Command name')
-            .example('sd-checkout-code'),
+        name: Joi.equal('sd-checkout-code').required().label('Command name').example('sd-checkout-code'),
 
-        command: Joi.string()
-            .required()
-            .label('Checkout command to run')
+        command: Joi.string().required().label('Checkout command to run')
     })
     .label('SCM Command');
 
 const SCHEMA_COMMIT = Joi.object()
     .keys({
-        message: Joi.string()
-            .required()
-            .label('Commit message')
-            .example('Fixing a bug with signing'),
+        message: Joi.string().required().label('Commit message').example('Fixing a bug with signing'),
 
         author: SCHEMA_USER.required().label('Author of the commit'),
 
@@ -100,39 +81,15 @@ const SCHEMA_COMMIT = Joi.object()
 
 const SCHEMA_PR = Joi.object()
     .keys({
-        url: Joi.string()
-            .uri()
-            .label('Link to PR')
-            .example('https://github.com/screwdriver-cd/screwdriver/pull/1'),
-        title: Joi.string()
-            .max(512)
-            .label('Title of the pull request'),
-        ref: Joi.string()
-            .allow('')
-            .optional()
-            .label('Ref of the pull request'),
-        prSource: Joi.string()
-            .allow('')
-            .optional()
-            .label('Origin of the pull request'),
-        prBranchName: Joi.string()
-            .allow('')
-            .optional()
-            .label('Branch name of the pull request'),
-        createTime: Joi.date()
-            .iso()
-            .label('Creation Time of the pull request')
-            .example('2018-10-10T21:35:31Z'),
-        username: Joi.string()
-            .label('Username')
-            .example('d2lam'),
-        userProfile: Joi.string()
-            .uri()
-            .label('Link to Profile')
-            .example('https://github.com/anonymous'),
-        baseBranch: Joi.string()
-            .label('Base branch of the pull request')
-            .example('master')
+        url: Joi.string().uri().label('Link to PR').example('https://github.com/screwdriver-cd/screwdriver/pull/1'),
+        title: Joi.string().max(512).label('Title of the pull request'),
+        ref: Joi.string().allow('').optional().label('Ref of the pull request'),
+        prSource: Joi.string().allow('').optional().label('Origin of the pull request'),
+        prBranchName: Joi.string().allow('').optional().label('Branch name of the pull request'),
+        createTime: Joi.date().iso().label('Creation Time of the pull request').example('2018-10-10T21:35:31Z'),
+        username: Joi.string().label('Username').example('d2lam'),
+        userProfile: Joi.string().uri().label('Link to Profile').example('https://github.com/anonymous'),
+        baseBranch: Joi.string().label('Base branch of the pull request').example('master')
     })
     .label('SCM Pull Request');
 
@@ -158,26 +115,13 @@ const SCHEMA_HOOK = Joi.object()
             .example('git@github.com:screwdriver-cd/data-schema.git#master')
             .example('https://github.com/screwdriver-cd/data-schema.git#master'),
 
-        hookId: Joi.string()
-            .allow('')
-            .optional()
-            .label('Uuid of the event'),
+        hookId: Joi.string().allow('').optional().label('Uuid of the event'),
 
-        lastCommitMessage: Joi.string()
-            .allow('')
-            .optional()
-            .label('Last commit message'),
+        lastCommitMessage: Joi.string().allow('').optional().label('Last commit message'),
 
-        prNum: Joi.number()
-            .integer()
-            .positive()
-            .optional()
-            .label('PR number'),
+        prNum: Joi.number().integer().positive().optional().label('PR number'),
 
-        prRef: Joi.string()
-            .allow('')
-            .optional()
-            .label('PR reference of the repository'),
+        prRef: Joi.string().allow('').optional().label('PR reference of the repository'),
 
         ref: Joi.string()
             .when('action', {
@@ -196,10 +140,7 @@ const SCHEMA_HOOK = Joi.object()
             .optional()
             .label('PR original source'),
 
-        prTitle: Joi.string()
-            .allow('')
-            .optional()
-            .label('PR title'),
+        prTitle: Joi.string().allow('').optional().label('PR title'),
 
         scmContext: Joi.string()
             .regex(Regex.SCM_CONTEXT)
@@ -226,47 +167,23 @@ const SCHEMA_HOOK = Joi.object()
             .label('Commit SHA')
             .example('ccc49349d3cffbd12ea9e3d41521480b4aa5de5f'),
 
-        type: Joi.string()
-            .valid('pr', 'repo', 'ping')
-            .required()
-            .label('Type of the event'),
+        type: Joi.string().valid('pr', 'repo', 'ping').required().label('Type of the event'),
 
         username: SCHEMA_USER.extract('username'),
 
-        commitAuthors: Joi.array()
-            .items(Joi.string().allow(''))
-            .optional()
-            .label('Commit authors'),
+        commitAuthors: Joi.array().items(Joi.string().allow('')).optional().label('Commit authors'),
 
-        releaseId: Joi.string()
-            .allow('')
-            .optional()
-            .label('Release id'),
+        releaseId: Joi.string().allow('').optional().label('Release id'),
 
-        releaseName: Joi.string()
-            .allow('')
-            .optional()
-            .label('Name of the event'),
+        releaseName: Joi.string().allow('').optional().label('Name of the event'),
 
-        releaseAuthor: Joi.string()
-            .allow('')
-            .optional()
-            .label('Author of the event'),
+        releaseAuthor: Joi.string().allow('').optional().label('Author of the event'),
 
-        addedFiles: Joi.array()
-            .items(Joi.string().allow(''))
-            .optional()
-            .label('Added files of head commit'),
+        addedFiles: Joi.array().items(Joi.string().allow('')).optional().label('Added files of head commit'),
 
-        modifiedFiles: Joi.array()
-            .items(Joi.string().allow(''))
-            .optional()
-            .label('Modified files of head commit'),
+        modifiedFiles: Joi.array().items(Joi.string().allow('')).optional().label('Modified files of head commit'),
 
-        removedFiles: Joi.array()
-            .items(Joi.string().allow(''))
-            .optional()
-            .label('Removed files of head commit')
+        removedFiles: Joi.array().items(Joi.string().allow('')).optional().label('Removed files of head commit')
     })
     .label('SCM Hook');
 

package/models/banner.js

@@ -4,18 +4,14 @@ const Joi = require('joi');
 const mutate = require('../lib/mutate');
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive(),
+    id: Joi.number().integer().positive(),
 
     message: Joi.string()
         .max(512)
         .description('Body of banner to display')
         .example('Due to planned upgrade of Kubernetes, Screwdriver will be down'),
 
-    isActive: Joi.boolean()
-        .description('Flag if the banner is active')
-        .example(true),
+    isActive: Joi.boolean().description('Flag if the banner is active').example(true),
 
     createTime: Joi.string()
         .max(32)
@@ -23,16 +19,9 @@ const MODEL = {
         .description('When this banner was created')
         .example('2017-01-06T01:49:50.384359267Z'),
 
-    createdBy: Joi.string()
-        .max(128)
-        .description('Username of user creating the banner')
-        .example('batman123'),
+    createdBy: Joi.string().max(128).description('Username of user creating the banner').example('batman123'),
 
-    type: Joi.string()
-        .valid('info', 'warn')
-        .max(32)
-        .description('Type/Severity of the banner message')
-        .example('info')
+    type: Joi.string().valid('info', 'warn').max(32).description('Type/Severity of the banner message').example('info')
 };
 
 module.exports = {

package/models/build.js

@@ -6,9 +6,7 @@ const Scm = require('../core/scm');
 const Regex = require('../config/regex');
 const Job = require('../config/job');
 const Step = require('./step');
-const ID = Joi.number()
-    .integer()
-    .positive();
+const ID = Joi.number().integer().positive();
 const PARENT_BUILD_ID = ID;
 const PARENT_BUILDS_ID = Joi.alternatives().try(ID, Joi.valid(null));
 const buildClusterSchema = require('./buildCluster');
@@ -27,25 +25,13 @@ const STATUSES = [
 ];
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of this build')
-        .example(123345),
+    id: Joi.number().integer().positive().description('Identifier of this build').example(123345),
 
     environment: Job.environment,
 
-    eventId: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of the parent event')
-        .example(123345),
+    eventId: Joi.number().integer().positive().description('Identifier of the parent event').example(123345),
 
-    jobId: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of the parent job')
-        .example(123345),
+    jobId: Joi.number().integer().positive().description('Identifier of the parent job').example(123345),
 
     parentBuildId: Joi.array()
         .items(PARENT_BUILD_ID)
@@ -65,18 +51,11 @@ const MODEL = {
             222: { eventId: 3, jobs: { jobC: 555 } }
         }),
 
-    number: Joi.number()
-        .positive()
-        .description('Timestamp of create time')
-        .example(1473900790309),
+    number: Joi.number().positive().description('Timestamp of create time').example(1473900790309),
 
-    container: Joi.string()
-        .description('Container this build is running in')
-        .example('node:4'),
+    container: Joi.string().description('Container this build is running in').example('node:4'),
 
-    cause: Joi.string()
-        .description('Reason why this build started')
-        .example('pull request opened'),
+    cause: Joi.string().description('Reason why this build started').example('pull request opened'),
 
     sha: Joi.string()
         .hex()
@@ -90,24 +69,15 @@ const MODEL = {
 
     commit: Scm.commit,
 
-    createTime: Joi.string()
-        .isoDate()
-        .max(32)
-        .description('When this build was created'),
+    createTime: Joi.string().isoDate().max(32).description('When this build was created'),
 
-    startTime: Joi.string()
-        .isoDate()
-        .description('When this build started on a build machine'),
+    startTime: Joi.string().isoDate().description('When this build started on a build machine'),
 
-    endTime: Joi.string()
-        .isoDate()
-        .description('When this build stopped running'),
+    endTime: Joi.string().isoDate().description('When this build stopped running'),
 
     parameters: Joi.object().description('Input parameters that defined this build'),
 
-    meta: Joi.object()
-        .default({})
-        .description('Key=>Value information from the build itself'),
+    meta: Joi.object().default({}).description('Key=>Value information from the build itself'),
 
     status: Joi.string()
         .valid(...STATUSES)
@@ -120,25 +90,15 @@ const MODEL = {
 
     stats: Joi.object()
         .keys({
-            queueEnterTime: Joi.string()
-                .isoDate()
-                .description('When this build enters queue'),
-            blockedStartTime: Joi.string()
-                .isoDate()
-                .description('When this build is blocked'),
-            imagePullStartTime: Joi.string()
-                .isoDate()
-                .description('When this build starts pulling image'),
+            queueEnterTime: Joi.string().isoDate().description('When this build enters queue'),
+            blockedStartTime: Joi.string().isoDate().description('When this build is blocked'),
+            imagePullStartTime: Joi.string().isoDate().description('When this build starts pulling image'),
             hostname: Joi.string().description('Where this build is run')
         })
         .unknown(true) // allow other fields
         .description('Stats for this build'),
 
-    templateId: Joi.number()
-        .integer()
-        .positive()
-        .description("Identifier for this job's template")
-        .example(123345),
+    templateId: Joi.number().integer().positive().description("Identifier for this job's template").example(123345),
 
     buildClusterName
 };
@@ -150,9 +110,7 @@ const parentBuildIdSchema = Joi.alternatives()
 
 const environmentSchema = Joi.alternatives().try(Joi.array().items(Job.environment), Job.environment);
 
-const stepsSchema = Joi.array()
-    .items(Step.get)
-    .description('List of steps');
+const stepsSchema = Joi.array().items(Step.get).description('List of steps');
 
 const GET_MODEL = { ...MODEL, parentBuildId: parentBuildIdSchema, environment: environmentSchema, steps: stepsSchema };
 

package/models/buildCluster.js

@@ -5,17 +5,10 @@ const mutate = require('../lib/mutate');
 const Command = require('../config/command');
 const pipelineBaseSchema = require('./pipeline').base;
 const scmContext = pipelineBaseSchema.extract('scmContext');
-const scmOrganization = Joi.string()
-    .max(100)
-    .description('SCM organization name')
-    .example('screwdriver-cd');
+const scmOrganization = Joi.string().max(100).description('SCM organization name').example('screwdriver-cd');
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of this Job')
-        .example(123345),
+    id: Joi.number().integer().positive().description('Identifier of this Job').example(123345),
 
     name: Joi.string()
         .regex(/^[\w-]+$/)
@@ -32,21 +25,13 @@ const MODEL = {
 
     scmOrganizations: Joi.array().items(scmOrganization),
 
-    isActive: Joi.boolean()
-        .description('Flag if the the build cluster is active')
-        .example(true),
+    isActive: Joi.boolean().description('Flag if the the build cluster is active').example(true),
 
-    managedByScrewdriver: Joi.boolean()
-        .description('Flag if the cluster is managed by screwdriver team')
-        .example(true),
+    managedByScrewdriver: Joi.boolean().description('Flag if the cluster is managed by screwdriver team').example(true),
 
     maintainer: Command.maintainer,
 
-    weightage: Joi.number()
-        .min(0)
-        .max(100)
-        .description('Weight percentage for build cluster')
-        .example(20)
+    weightage: Joi.number().min(0).max(100).description('Weight percentage for build cluster').example(20)
 };
 
 module.exports = {

package/models/collection.js

@@ -6,34 +6,20 @@ const mutate = require('../lib/mutate');
 const BUILD_MODEL = require('./build').get;
 const PIPELINE_MODEL = require('./pipeline').get;
 const PRS = {
-    open: Joi.number()
-        .integer()
-        .min(0),
-    failing: Joi.number()
-        .integer()
-        .min(0)
+    open: Joi.number().integer().min(0),
+    failing: Joi.number().integer().min(0)
 };
 const PIPELINE_OBJECT = PIPELINE_MODEL.keys({
-    lastBuilds: Joi.array()
-        .items(BUILD_MODEL)
-        .optional(),
+    lastBuilds: Joi.array().items(BUILD_MODEL).optional(),
     prs: Joi.object(PRS).optional()
 });
 const PIPELINES_MODEL = Joi.array().items(PIPELINE_OBJECT);
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive(),
+    id: Joi.number().integer().positive(),
 
-    userId: Joi.number()
-        .integer()
-        .positive()
-        .description('User ID'),
+    userId: Joi.number().integer().positive().description('User ID'),
 
-    name: Joi.string()
-        .max(128)
-        .description('Collection name')
-        .example('Favorites'),
+    name: Joi.string().max(128).description('Collection name').example('Favorites'),
 
     description: Joi.string()
         .max(256)
@@ -41,26 +27,14 @@ const MODEL = {
         .description('Collection description')
         .example('List of my favorite pipelines'),
 
-    pipelineIds: Joi.array().items(
-        Joi.number()
-            .integer()
-            .positive()
-    ),
-
-    type: Joi.string()
-        .max(32)
-        .valid('', 'default', 'normal')
-        .description('Collection type')
-        .example('default')
+    pipelineIds: Joi.array().items(Joi.number().integer().positive()),
+
+    type: Joi.string().max(32).valid('', 'default', 'normal').description('Collection type').example('default')
 };
 const GET_MODEL = {
     ...MODEL,
     pipelines: PIPELINES_MODEL,
-    type: Joi.string()
-        .max(32)
-        .valid('default', 'normal', 'shared')
-        .description('Collection type')
-        .example('default')
+    type: Joi.string().max(32).valid('default', 'normal', 'shared').description('Collection type').example('default')
 };
 
 module.exports = {

package/models/command.js

@@ -6,11 +6,7 @@ const Command = require('../config/command');
 const pipelineId = require('./pipeline').base.extract('id');
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of this command')
-        .example(123345),
+    id: Joi.number().integer().positive().description('Identifier of this command').example(123345),
     namespace: Command.namespace,
     version: Command.version,
     description: Command.description,

package/models/commandTag.js

@@ -4,11 +4,7 @@ const Joi = require('joi');
 const Command = require('../config/command');
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of this command tag')
-        .example(123345),
+    id: Joi.number().integer().positive().description('Identifier of this command tag').example(123345),
     createTime: Joi.string()
         .isoDate()
         .max(32)

package/models/event.js

@@ -12,21 +12,13 @@ const buildId = require('./build').get.extract('id');
 const prNum = Scm.hook.extract('prNum');
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of this event')
-        .example(123345),
+    id: Joi.number().integer().positive().description('Identifier of this event').example(123345),
     parentEventId: Joi.number()
         .integer()
         .positive()
         .description('Identifier of the direct parent event')
         .example(123344),
-    groupEventId: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of the group parent event')
-        .example(123344),
+    groupEventId: Joi.number().integer().positive().description('Identifier of the group parent event').example(123344),
     causeMessage: Joi.string()
         .max(512)
         .truncate()
@@ -40,14 +32,8 @@ const MODEL = {
         .description('When this event was created')
         .example('2038-01-19T03:14:08.131Z'),
     creator: Scm.user.description('Creator of the event'),
-    meta: Joi.object()
-        .default({})
-        .description('Key=>Value information from the event itself'),
-    pipelineId: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of this pipeline')
-        .example(123345),
+    meta: Joi.object().default({}).description('Key=>Value information from the event itself'),
+    pipelineId: Joi.number().integer().positive().description('Identifier of this pipeline').example(123345),
     sha: Joi.string()
         .hex()
         .length(40)
@@ -62,11 +48,7 @@ const MODEL = {
         .try(trigger, jobName)
         .description('Event start point - a job name or trigger name (~commit/~pr)')
         .example('~commit'),
-    type: Joi.string()
-        .valid('pr', 'pipeline')
-        .max(10)
-        .description('Type of the event')
-        .example('pr'),
+    type: Joi.string().valid('pr', 'pipeline').max(10).description('Type of the event').example('pr'),
     workflowGraph: WorkflowGraph.workflowGraph.description('Graph representation of the workflow').example({
         nodes: [{ name: '~commit' }, { name: 'main' }, { name: 'publish' }],
         edges: [
@@ -76,9 +58,7 @@ const MODEL = {
     }),
     pr: Scm.pr.description('Pull request object that holds information about the pull request'),
     prNum: prNum.description('Pull request number if it is a PR event'),
-    baseBranch: Joi.string()
-        .description('build base branch')
-        .example('develop')
+    baseBranch: Joi.string().description('build base branch').example('develop')
 };
 
 const CREATE_MODEL = { ...MODEL, buildId, parentBuildId, parentBuilds, prNum };

package/models/job.js

@@ -6,11 +6,7 @@ const validator = require('../api/validator');
 const SCM_PR_SCHEMA = require('../core/scm').pr;
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of this Job')
-        .example(123345),
+    id: Joi.number().integer().positive().description('Identifier of this Job').example(123345),
 
     name: Joi.string()
         .regex(/^(PR-[0-9]+:)?[\w-]+$/)
@@ -26,16 +22,9 @@ const MODEL = {
 
     permutations: validator.jobPermutations,
 
-    description: Joi.string()
-        .max(100)
-        .description('Description of the Job')
-        .example('builds and tests the code'),
+    description: Joi.string().max(100).description('Description of the Job').example('builds and tests the code'),
 
-    pipelineId: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of this Pipeline')
-        .example(123345),
+    pipelineId: Joi.number().integer().positive().description('Identifier of this Pipeline').example(123345),
 
     state: Joi.string()
         .valid('ENABLED', 'DISABLED')
@@ -44,29 +33,18 @@ const MODEL = {
         .example('ENABLED')
         .default('ENABLED'),
 
-    stateChanger: Joi.string()
-        .max(128)
-        .description('Username for who changed the state'),
+    stateChanger: Joi.string().max(128).description('Username for who changed the state'),
 
-    stateChangeTime: Joi.string()
-        .isoDate()
-        .description('When the state of the job was changed'),
+    stateChangeTime: Joi.string().isoDate().description('When the state of the job was changed'),
 
     stateChangeMessage: Joi.string()
         .max(512)
         .description('Reason why disabling or enabling job')
         .example('Testing out new feature change in beta only'),
 
-    archived: Joi.boolean()
-        .description('Flag if the job is archived')
-        .example(true)
-        .default(false),
+    archived: Joi.boolean().description('Flag if the job is archived').example(true).default(false),
 
-    templateId: Joi.number()
-        .integer()
-        .positive()
-        .description("Identifier for this job's template")
-        .example(123345)
+    templateId: Joi.number().integer().positive().description("Identifier for this job's template").example(123345)
 };
 
 const EXTENDED_MODEL = {