Migrate from orignal repo

Author: Juliya Smith

Dockerfile

@@ -0,0 +1,4 @@
+FROM stoplight/prism
+
+RUN apk update
+COPY docs docs

Makefile

@@ -0,0 +1,9 @@
+IMAGE_TAG = c42/mock-microservice-endpoints:1.0
+
+all:: start
+
+start::
+	@docker-compose up --build
+
+stop::
+	@docker-compose down --rmi all

README.md

@@ -0,0 +1,168 @@
+# Mock Microservice Endpoints
+
+To start the servers:
+
+```bash
+make
+```
+
+To stop the servers:
+```bash
+make stop
+```
+
+## Adding a new service
+
+Since we are currently controlling the OpenAPI documentation that powers the mock server,
+the format we are using is OpenAPI version 3 as yml.
+
+You can convert existing JSON Swagger v2 swagger using https://editor.swagger.io/.
+
+Some minor editing might be required to get the conversion to work. For example, warnings may appears on the left
+margin of the Swagger editor. Address all the warnings before re-attempting the conversion.
+A common problem from our docs is that the conversion tool does not like having `descriptions` 
+(or any additional properties) next a `ref`.
+
+For example, replace:
+
+```yml
+            description: Indicates setting of how to interact with user list.
+            $ref: '#/definitions/UsersToAlertOn-alert-rules'
+```
+
+with just:
+
+```yml
+            $ref: '#/definitions/UsersToAlertOn-alert-rules'
+```
+
+You may also have issues with enum values. See the section below.
+
+## Endpoint Enums
+
+Another common problem is that our Code42 docs often declare enums as having a type of `integer`.
+This will cause failures in Prism. Change the enum type to `string`. This is also needed for the conversion 
+to OpenAPI 3 to work properly.
+
+Prism is case-sensitive when it comes to enum values whereas typically Code42 servers are not.
+To allow case-insensitivity, convert the request enum to use a Pattern.
+
+Let's say you have an OpenAPI yml file containing this enum:
+
+```yml
+      enum:
+      - HIGH
+      - MEDIUM
+      - LOW
+      x-enumNames:
+      - Low
+      - Medium
+      - High
+```
+
+To use a Pattern instead, replace it with:
+
+```yml
+        pattern: '^(?i)LOW|MEDIUM|HIGH$'
+```
+
+Now, all casings are supported in the mock.  `Low`, `low`, `LOW`, etc, are all valid.
+
+## Examples
+
+We have to often control the output of the mocked endpoints. To do this, set examples.
+
+Convert
+
+```yml
+              archiveBytes:
+                type: integer
+                format: int64
+```
+
+to
+
+
+```yml
+              archiveBytes:
+                type: integer
+                format: int64
+                example: 10000
+```
+
+It is not necessary to do this for every response property. Here are reasons you may need to:
+
+* Prism complains about the type returned.  If ths happens, setting the example will control the output so Prism can't generate faulty 
+	examples by mistake.
+* You are expecting a specific response value in a test.  This is how the Key-Value mock endpoints work: they return localhost with 
+	different ports (see section below).
+* You want to constrain the response value. Prism likes to use negative integers when the type is an integer, but you might not want that,
+	especially for IDs like the `userId`.
+
+## docker-compose and the Mock Key-Value Store
+
+Each microservice gets its own port that gets returned from the mock Key-Value Store found in `core.yml`. To add a new service, include 
+the mocked endpoint for getting your microservice's URL.
+
+Example:
+
+```yml
+  /v1/KEY_VALUE_FOR_SERVICE_URL:
+    get:
+      tags:
+      - keyvaluestore
+      summary: Get the microservice URL
+      operationId: ServiceNameUrl_Get
+      responses:
+        200:
+          description: A successful response
+          content:
+            '*/*':
+              schema:
+               type: string
+               example: http://127.0.0.1:4220
+```
+
+Then, in the `docker-compose.yml` file, add another entry using your service's mock `.yml` file and an incremented port (the same one you used in 
+the mock key-value store endpoint).
+
+```yml
+  service:
+    image: c42/mock-microservice-endpoints:1.0
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: mock_service
+    restart: always
+    ports:
+      - "4220:4220"
+    command: mock docs/service.yml -p 4220 -h 0.0.0.0
+```
+
+Notice the port number appears in three places in the `yml` for the docker-compose file.
+
+## Returning empty JSON responses
+
+If your endpoint claims to return application/json but you are returning an empty response, 
+you might have your service's yml (after conversion from JSON) looking like this:
+
+```yml
+        200:
+          description: 'Success: Given alerts are updated to the indicated status.'
+          content: {}
+```
+
+Instead, to return an empty response in a way that Prism understands, do this:
+
+```yml
+        200:
+          description: 'Success: Given alerts are updated to the indicated status.'
+          content:
+					  application/json:
+              schema:
+                type: object
+```
+
+## Optional Request Parameters
+
+If you don't explitly mark your required request parameters, Prism assumes they are all required.

docker-compose.yml

@@ -0,0 +1,112 @@
+version: '3'
+services:
+
+  core:
+    image: c42/mock-microservice-endpoints:1.0
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: mock_core
+    restart: always
+    ports:
+      - "4200:4200"
+    command: mock docs/core.yml -p 4200 -h 0.0.0.0
+
+  alerts:
+    image: c42/mock-microservice-endpoints:1.0
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: mock_alerts
+    restart: always
+    ports:
+      - "4201:4201"
+    command: mock docs/alerts.yml -p 4201 -h 0.0.0.0
+
+  alert_rules:
+    image: c42/mock-microservice-endpoints:1.0
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: mock_alert_rules
+    restart: always
+    ports:
+      - "4202:4202"
+    command: mock docs/alert_rules.yml -p 4202 -h 0.0.0.0
+
+  detection_lists:
+    image: c42/mock-microservice-endpoints:1.0
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: mock_detection_lists
+    restart: always
+    ports:
+      - "4203:4203"
+    command: mock docs/detection_lists.yml -p 4203 -h 0.0.0.0
+
+  cases:
+    image: c42/mock-microservice-endpoints:1.0
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: mock_cases
+    restart: always
+    ports:
+      - "4204:4204"
+    command: mock docs/cases.yml -p 4204 -h 0.0.0.0
+
+  storage:
+    image: c42/mock-microservice-endpoints:1.0
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: mock_storage
+    restart: always
+    ports:
+      - "4205:4205"
+    command: mock docs/storage.yml -p 4205 -h 0.0.0.0
+
+  connected_server:
+    image: c42/mock-microservice-endpoints:1.0
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: mock_connected_server
+    restart: always
+    ports:
+      - "4206:4206"
+    command: mock docs/connected_server.yml -p 4206 -h 0.0.0.0
+  
+  audit_logs:
+    image: c42/mock-microservice-endpoints:1.0
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: mock_audit_logs
+    restart: always
+    ports:
+      - "4207:4207"
+    command: mock docs/audit_logs.yml -p 4207 -h 0.0.0.0
+
+  file-events:
+    image: c42/mock-microservice-endpoints:1.0
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: mock_file_events
+    restart: always
+    ports:
+      - "4208:4208"
+    command: mock docs/file-events.yml -p 4208 -h 0.0.0.0
+
+  preservation-data-service:
+    image: c42/mock-microservice-endpoints:1.0
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: mock_preservation_data_service
+    restart: always
+    ports:
+      - "4209:4209"
+    command: mock docs/preservation-data-service.yml -p 4209 -h 0.0.0.0