Merge branch 'develop'

Author: rootelement

README.md

@@ -34,6 +34,7 @@ Dev: [![CircleCI](https://circleci.com/gh/topcoder-platform/challenge-api/tree/d
 Configuration for the application is at `config/default.js`.
 The following parameters can be set in config files or in env variables:
 
+- READONLY: sets the API in read-only mode. POST/PUT/PATCH/DELETE operations will return 403 Forbidden
 - LOG_LEVEL: the log level, default is 'debug'
 - PORT: the server port, default is 3000
 - AUTH_SECRET: The authorization secret used during token verification.

app.js

@@ -16,10 +16,19 @@ const fileUpload = require('express-fileupload')
 const YAML = require('yamljs')
 const swaggerUi = require('swagger-ui-express')
 const challengeAPISwaggerDoc = YAML.load('./docs/swagger.yaml')
+const { ForbiddenError } = require('./src/common/errors')
 
 // setup express app
 const app = express()
 
+// Disable POST, PUT, PATCH, DELETE operations if READONLY is set to true
+app.use((req, res, next) => {
+  if (config.READONLY && ['POST', 'PUT', 'PATCH', 'DELETE'].includes(req.method)) {
+    throw new ForbiddenError('Action is temporarely not allowed!')
+  }
+  next()
+})
+
 // serve challenge V5 API swagger definition
 app.use('/v5/challenges/docs', swaggerUi.serve, swaggerUi.setup(challengeAPISwaggerDoc))
 

config/default.js

@@ -3,6 +3,7 @@
  */
 
 module.exports = {
+  READONLY: process.env.READONLY || false,
   LOG_LEVEL: process.env.LOG_LEVEL || 'debug',
   PORT: process.env.PORT || 3000,
   API_VERSION: process.env.API_VERSION || 'v5',

docs/swagger.yaml

@@ -397,7 +397,7 @@ paths:
           description: Server error
           schema:
             $ref: '#/definitions/ErrorModel'
-  /challengeTypes:
+  /challenge-types:
     get:
       tags:
         - ChallengeTypes
@@ -513,7 +513,7 @@ paths:
           description: Server error
           schema:
             $ref: '#/definitions/ErrorModel'
-  '/challengeTypes/:challengeTypeId':
+  '/challenge-types/:challengeTypeId':
     get:
       tags:
         - ChallengeTypes
@@ -650,7 +650,7 @@ paths:
           description: Server error
           schema:
             $ref: '#/definitions/ErrorModel'
-  /challengeSettings:
+  /challenge-settings:
     get:
       tags:
         - ChallengeSettings
@@ -758,7 +758,7 @@ paths:
           description: Server error
           schema:
             $ref: '#/definitions/ErrorModel'
-  '/challengeSettings/:challengeSettingId':
+  '/challenge-settings/:challengeSettingId':
     get:
       tags:
         - ChallengeSettings
@@ -853,7 +853,7 @@ paths:
           description: Server error
           schema:
             $ref: '#/definitions/ErrorModel'
-  /challengePhases:
+  /challenge-phases:
     get:
       tags:
         - ChallengePhases
@@ -961,7 +961,7 @@ paths:
           description: Server error
           schema:
             $ref: '#/definitions/ErrorModel'
-  /challengePhases/:challengePhaseId:
+  /challenge-phases/:challengePhaseId:
     get:
       tags:
         - ChallengePhases
@@ -1152,7 +1152,7 @@ paths:
           description: Server error
           schema:
             $ref: '#/definitions/ErrorModel'
-  /timelineTemplates:
+  /timeline-templates:
     get:
       tags:
         - TimelineTemplates
@@ -1260,7 +1260,7 @@ paths:
           description: Server error
           schema:
             $ref: '#/definitions/ErrorModel'
-  /timelineTemplates/:timelineTemplateId:
+  /timeline-templates/:timelineTemplateId:
     get:
       tags:
         - TimelineTemplates
@@ -1451,7 +1451,7 @@ paths:
           description: Server error
           schema:
             $ref: '#/definitions/ErrorModel'
-  /challengeTimelines:
+  /challenge-timelines:
     get:
       tags:
         - ChallengeTypeTimelineTemplates
@@ -1540,7 +1540,7 @@ paths:
           description: Server error
           schema:
             $ref: '#/definitions/ErrorModel'
-  /challengeTimelines/:challengeTypeTimelineTemplateId:
+  /challenge-timelines/:challengeTypeTimelineTemplateId:
     get:
       tags:
         - ChallengeTypeTimelineTemplates
@@ -1677,7 +1677,7 @@ paths:
           description: Server error
           schema:
             $ref: '#/definitions/ErrorModel'
-  /challengeAuditLogs:
+  /challenge-auditLogs:
     get:
       tags:
         - AuditLog