Merge pull request #234 from topcoder-platform/develop

Sync master with prod

Author: rootelement

README.md

@@ -1,5 +1,26 @@
 # Topcoder Submission API
 
+Topcoder's API that deals with submissions, reviews, review summations and review types on the Topcoder platform
+
+## Devlopment status
+
+[![Total alerts](https://img.shields.io/lgtm/alerts/g/topcoder-platform/submissions-api.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/topcoder-platform/submissions-api/alerts/)[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/topcoder-platform/submissions-api.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/topcoder-platform/submissions-api/context:javascript)
+
+### Deployment status
+
+Dev: [![CircleCI](https://circleci.com/gh/topcoder-platform/submissions-api/tree/develop.svg?style=svg)](https://circleci.com/gh/topcoder-platform/submissions-api/tree/develop) Prod: [![CircleCI](https://circleci.com/gh/topcoder-platform/submissions-api/tree/master.svg?style=svg)](https://circleci.com/gh/topcoder-platform/submissions-api/tree/master)
+
+## Swagger definition
+
+- [Swagger](https://api.topcoder.com/v5/submissions/docs)
+
+## Intended use
+
+- Production API
+
+## Related repos
+
+- [ES Processor](https://github.com/topcoder-platform/submission-processor-es) - Updates data in ElasticSearch
 
 ## Pre-requisites
 
@@ -191,10 +212,6 @@ and then run the following script
 npm run update-to-v5-challengeId
 ```
 
-#### Swagger UI
-
-Swagger UI will be served at `http://localhost:3000/docs`
-
 ## Postman verification
 
 1. Open Postman

app.js

@@ -134,12 +134,12 @@ _.each(routes, (verbs, url) => {
 })
 /* eslint-enable no-param-reassign */
 
+app.use('/v5/submissions/docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument))
 app.use('/', apiRouter)
 app.use(errorMiddleware())
 // Serve Swagger Docs after setting host and base path
 swaggerDocument.host = config.HOST
 swaggerDocument.basePath = config.API_VERSION
-app.use('/docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument))
 
 // Check if the route is not found or HTTP method is not supported
 app.use('*', (req, res) => {