CMSNAV-747: Update OAS Specification for Content API

.devcontainer/devcontainer.json

@@ -0,0 +1,31 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+	"name": "Python 3",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/python:1-3.10-bullseye",
+	"features": {
+		"ghcr.io/devcontainers/features/node:1": {
+			"nodeGypDependencies": true,
+			"installYarnUsingApt": true,
+			"version": "lts",
+			"pnpmVersion": "latest",
+			"nvmVersion": "latest"
+		}
+	},
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	 "forwardPorts": [5000, 32201],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "./.devcontainer/postCreateCommand.sh"
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.devcontainer/postCreateCommand.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# Install JVM
+
+sudo apt update
+sudo apt install -y default-jdk
+
+# Install poetry
+
+#!/bin/bash
+curl -sSL https://install.python-poetry.org | python3 -
+echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
+
+make install
+echo "..Now you can 'make lint', 'make publish', 'npm run serve'"

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for more information:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+# https://containers.dev/guide/dependabot
+
+version: 2
+updates:
+ - package-ecosystem: "devcontainers"
+   directory: "/"
+   schedule:
+     interval: weekly

Makefile

@@ -12,6 +12,7 @@ install-node:
 #Configures Git Hooks, which are scripts that run given a specified event.
 .git/hooks/pre-commit:
 	cp scripts/pre-commit .git/hooks/pre-commit
+	chmod +x .git/hooks/pre-commit
 
 #Condensed Target to run all targets above.
 install: install-node install-python .git/hooks/pre-commit
@@ -31,6 +32,10 @@ publish: clean
 	mkdir -p build
 	npm run publish 2> /dev/null
 
+#Serve the API description locally
+serve:
+	npm run serve
+
 #Runs build proxy script
 build-proxy:
 	scripts/build_proxy.sh

README.md

@@ -21,18 +21,31 @@ The contents of this repository are protected by Crown Copyright (C).
 
 ## Development
 
-### Requirements
+You can set up your development manually on your development machine, or :bulb: use the supplied devcontainer specification to set up
+the required environment automatically.
+
+### :bulb: Developing in a devcontainer
+
+If you are unfamiliar with the use of devcontainers, these resources may be helpful:
+- VSCode: https://code.visualstudio.com/docs/devcontainers/tutorial
+- JetBrains/pycharm: https://www.jetbrains.com/help/idea/prerequisites-for-dev-containers.html 
+
+The provided configuration in the .devcontainer folder will set up all the required tooling as detailed in the following section automatically.
+
+### Developing without a devcontainer
+
+#### Requirements
 * make
 * nodejs + npm/yarn
 * [poetry](https://github.com/python-poetry/poetry)
 * Java 8+
 
-### Install
+#### Install
 ```
 $ make install
 ```
 
-#### Updating hooks
+##### Updating hooks
 You can install some pre-commit hooks to ensure you can't commit invalid spec changes by accident. These are also run
 in CI, but it's useful to run them locally too.
 
@@ -49,7 +62,7 @@ Various scripts and commands rely on environment variables being set. These are
 There are `make` commands that alias some of this functionality:
  * `lint` -- Lints the spec and code
  * `publish` -- Outputs the specification as a **single file** into the `build/` directory
- * `serve` -- Serves a preview of the specification in human-readable format
+ * `serve` -- Serves a preview of the specification in human-readable format on http://127.0.0.1:5000
 
 ### Testing
 Each API and team is unique. We encourage you to use a `test/` folder in the root of the project, and use whatever testing frameworks or apps your team feels comfortable with. It is important that the URL your test points to be configurable. We have included some stubs in the Makefile for running tests.