Merge branch 'release-6.0.0'

Author: eduardoboucas

.editorconfig

@@ -0,0 +1,10 @@
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

.eslintignore

@@ -0,0 +1 @@
+workspace/

.eslintrc

@@ -0,0 +1,6 @@
+{
+  "extends": "@dadi",
+  "rules": {
+    "require-atomic-updates": "off"
+  }
+}

.gitignore

@@ -16,5 +16,6 @@ config/config.production.json
 workspace/media/*
 
 test/acceptance/temp-workspace
+test/data.apisnapshot
 
 scripts/coverage.svg

.prettierignore

@@ -0,0 +1 @@
+workspace/

.prettierrc

@@ -0,0 +1 @@
+"@dadi/prettier-config"

CHANGELOG.md

@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 

CODE_OF_CONDUCT.md

@@ -6,90 +6,94 @@ We'd love for you to contribute to our source code and to make DADI API even bet
 
 Here are the guidelines we'd like you to follow:
 
- - [Question or Problem?](#question)
- - [Issues and Bugs](#issue)
- - [Feature Requests](#feature)
- - [Submission Guidelines](#submit)
- - [Coding Rules](#rules)
- - [Git Commit Guidelines](#commit)
+- [Question or Problem?](#question)
+- [Issues and Bugs](#issue)
+- [Feature Requests](#feature)
+- [Submission Guidelines](#submit)
+- [Coding Rules](#rules)
+- [Git Commit Guidelines](#commit)
 
 ## <a name="question"></a> Got a Question or Problem?
 
-Documentation can be found at the [docs.dadi.tech](https://docs.dadi.tech/api) site.
+Documentation can be found at the [docs.dadi.cloud](https://docs.dadi.cloud/api) site.
 
-If the documentation doesn't answer your problem please feel free to email the
-DADI team directly on: team@dadi.tech, or join us on [Slack](http://dadi-chat.herokuapp.com).
+If the documentation doesn't answer your problem please feel free to email the DADI team directly on team@dadi.cloud.
 
 ## <a name="issue"></a> Found an Issue?
+
 If you find a bug in the source code or a mistake in the documentation, you can help us by
 submitting an issue to our [GitHub Repository][github]. But we'd love it if you
 submitted a Pull Request with a fix instead!
 
 **Please see the Submission Guidelines below**.
 
 ## <a name="feature"></a> Want a Feature?
+
 You can request a new feature by submitting an issue to our [GitHub][issues] issue tracker.
 If you would like to implement a new feature then consider what kind of change it is:
 
-* **Major Changes** that you wish to contribute to the project should be added as
-a Feature Request in the [GitHub][issues] issue tracker. This will get the conversation
-started.
-* **Small Changes** can be crafted and submitted to the [GitHub Repository][github] as a Pull Request.
+- **Major Changes** that you wish to contribute to the project should be added as
+  a Feature Request in the [GitHub][issues] issue tracker. This will get the conversation
+  started.
+- **Small Changes** can be crafted and submitted to the [GitHub Repository][github] as a Pull Request.
 
 ## <a name="submit"></a> Submission Guidelines
 
 ### Submitting an Issue
+
 Before you submit your issue [search the archive][issues], maybe your question was already answered.
 
 If your issue appears to be a bug, and hasn't been reported, open a new issue.
 Help us to maximize the effort we can spend fixing issues and adding new
-features, by not reporting duplicate issues.  Providing the following information will increase the
+features, by not reporting duplicate issues. Providing the following information will increase the
 chances of your issue being dealt with quickly:
 
-* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
-* **Motivation for or Use Case** - explain why this is a bug for you
-* **DADI API Version**
-* **Operating System**
-* **Steps to Reproduce** - provide a set of steps to follow to reproduce the error.
-* **Related Issues** - has a similar issue been reported before?
-* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
+- **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
+- **Motivation for or Use Case** - explain why this is a bug for you
+- **DADI API Version**
+- **Operating System**
+- **Steps to Reproduce** - provide a set of steps to follow to reproduce the error.
+- **Related Issues** - has a similar issue been reported before?
+- **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
   causing the problem (e.g. a line of code or a commit)
 
 ### Submitting a Pull Request
+
 Before you submit your pull request consider the following guidelines:
 
-* Search [GitHub][pulls] for an open or closed Pull Request
+- Search [GitHub][pulls] for an open or closed Pull Request
   that relates to your submission. You don't want to duplicate effort.
-* Fork the original repository and clone your fork ([see this GitHub article](https://help.github.com/articles/fork-a-repo/)).
-* Add the original repository as an upstream remote: `git remote add upstream https://github.com/dadi/api.git`
-
-* Make your changes in a new git branch. Name your branch using the format `topic/branch_name`.
-Use `fix` for fixes and `feature` for features:
-
- ```shell
- git checkout -b fix/my-fix-branch master
- ```
- ```shell
- git checkout -b feature/my-new-feature-branch master
- ```
-
-* Create your patch, **including appropriate test cases**.
-* Follow our [Coding Rules](#rules).
-* Run the full test suite using `npm test` and ensure that all tests pass.
-* Commit your changes using a descriptive commit message that follows our
+- Fork the original repository and clone your fork ([see this GitHub article](https://help.github.com/articles/fork-a-repo/)).
+- Add the original repository as an upstream remote: `git remote add upstream https://github.com/dadi/api.git`
+
+- Make your changes in a new git branch. Name your branch using the format `topic/branch_name`.
+  Use `fix` for fixes and `feature` for features:
+
+```shell
+git checkout -b fix/my-fix-branch master
+```
+
+```shell
+git checkout -b feature/my-new-feature-branch master
+```
+
+- Create your patch, **including appropriate test cases**.
+- Follow our [Coding Rules](#rules).
+- Run the full test suite using `npm test` and ensure that all tests pass.
+- Commit your changes using a descriptive commit message that follows our
   [commit message conventions](#commit-message-format) and passes our commit message presubmit hook. Adherence to the [commit message conventions](#commit-message-format) is required because release notes are automatically generated from these messages.
-* Push your branch to GitHub:
+- Push your branch to GitHub:
 
   ```shell
   git push origin fix/my-fix-branch
   ```
 
-* In GitHub, send a pull request to `dadi/api:master`.
-* If we suggest changes then:
-  * Make the required updates.
-  * Re-run the full test suite to ensure tests are still passing.
-  * Commit your changes to your branch (e.g. `fix/my-fix-branch`).
-  * Push the changes to GitHub (this will update your Pull Request).
+- In GitHub, send a pull request to `dadi/api:master`.
+- If we suggest changes then:
+  - Make the required updates.
+  - Re-run the full test suite to ensure tests are still passing.
+  - Commit your changes to your branch (e.g. `fix/my-fix-branch`).
+  - Push the changes to GitHub (this will update your Pull Request).
 
 If the pull request gets too outdated we may ask you to rebase and force push to update the pull request:
 
@@ -98,50 +102,51 @@ git rebase master -i
 git push origin fix/my-fix-branch -f
 ```
 
-*WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits.*
+_WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits._
 
-* Documentation! Please add relevant documentation to the pull request. If this is a new feature then
-please document it fully within the pull request. If you're making changes to an existing feature, please
-give us a link to the existing [documentation][docs] along with your documentation changes. If you need
-an example of excellent pull request documentation, have a look at the [effort put in here](https://github.com/dadi/api/pull/27).
+- Documentation! Please add relevant documentation to the pull request. If this is a new feature then
+  please document it fully within the pull request. If you're making changes to an existing feature, please
+  give us a link to the existing [documentation][docs] along with your documentation changes. If you need
+  an example of excellent pull request documentation, have a look at the [effort put in here](https://github.com/dadi/api/pull/27).
 
 > That's it! Thank you for your contribution!
 
 #### After your pull request is merged
 
 After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
 
-* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
+- Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
 
   ```shell
   git push origin --delete my-fix-branch
   ```
 
-* Check out the master branch:
+- Check out the master branch:
 
   ```shell
   git checkout master -f
   ```
 
-* Delete the local branch:
+- Delete the local branch:
 
   ```shell
   git branch -D my-fix-branch
   ```
 
-* Update your master with the latest upstream version:
+- Update your master with the latest upstream version:
 
   ```shell
   git pull --ff upstream master
   ```
 
 ## <a name="rules"></a> Coding Rules
+
 To ensure consistency throughout the source code, keep these rules in mind as you are working:
 
-* Please use **two-space indentation**, as used in Node.JS itself.
-* All features or bug fixes **must be tested** by one or more tests. Browse the [test
-suite][tests] for examples.
-* All public API methods **must be documented** with [JSDoc](http://usejsdoc.org/).
+- Please use **two-space indentation**, as used in Node.JS itself.
+- All features or bug fixes **must be tested** by one or more tests. Browse the [test
+  suite][tests] for examples.
+- All public API methods **must be documented** with [JSDoc](http://usejsdoc.org/).
 
 ## <a name="commit"></a> Git Commit Guidelines
 
@@ -153,7 +158,7 @@ Please don't include more than one change in each patch. If your commit message
 
 ### Commit Message Format
 
-We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**.  We also use the git commit messages to **generate the change log**.
+We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**. We also use the git commit messages to **generate the change log**.
 
 We use [husky](https://www.npmjs.com/package/husky) and [validate-commit-msg](https://github.com/kentcdodds/validate-commit-msg) to perform the commit message validation. Commit messages will be validated when you commit. When validation fails, you'll see a message similar to the following:
 
@@ -169,7 +174,7 @@ Any line of the commit message cannot be longer 100 characters. This allows the
 
 #### Message Format
 
-Each commit message consists of a **header**, a **body** and a **footer**.  The header has a special format that includes a **type** and a **subject**:
+Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type** and a **subject**:
 
 ```
 type: subject
@@ -181,43 +186,47 @@ Close #yyy
 Ref #zzz
 ```
 
-* Use `Fix #xxx` when the commit fixes an open issue.
-* Use `Close #xxx` when the commit closes an open pull request.
-* Use `Ref #xxx` when referencing an issue or pull request that is already closed or should remain open. Examples include partial fixes and commits that add a test but not a fix.
+- Use `Fix #xxx` when the commit fixes an open issue.
+- Use `Close #xxx` when the commit closes an open pull request.
+- Use `Ref #xxx` when referencing an issue or pull request that is already closed or should remain open. Examples include partial fixes and commits that add a test but not a fix.
 
 ### Reverting
-If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+
+If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
 
 ### Type
+
 Must be one of the following:
 
-* **feat**: A new feature
-* **fix**: A bug fix
-* **docs**: Documentation only changes
-* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
-* **refactor**: A code change that neither fixes a bug nor adds a feature
-* **perf**: A code change that improves performance
-* **test**: Adding missing tests
-* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
+- **feat**: A new feature
+- **fix**: A bug fix
+- **docs**: Documentation only changes
+- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **perf**: A code change that improves performance
+- **test**: Adding missing tests
+- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
 
 ### Subject
+
 The subject contains a succinct description of the change:
 
-* use the imperative, present tense: "fix" not "fixed" nor "fixes"
-* don't capitalize first letter
-* no dot (.) at the end
+- use the imperative, present tense: "fix" not "fixed" nor "fixes"
+- don't capitalize first letter
+- no dot (.) at the end
 
 ### Body
+
 Just as in the **subject**, write your commit message in the imperative: "Fix bug" and not "Fixed bug" or "Fixes bug". This convention matches up with commit messages generated by commands like `git merge` and `git revert`.
 
 The body should include the motivation for the change and contrast this with previous behavior.
 
 ### Footer
+
 The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**.
 
 **Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
 
-
 [github]: https://github.com/dadi/api
 [issues]: https://github.com/dadi/api/issues
 [pulls]: https://github.com/dadi/api/pulls