Restructure repository

supertokens · Aug 20, 2021 · cdbd411 · cdbd411
1 parent 4c467c8
commit cdbd411
Show file tree

Hide file tree

Showing 12 changed files with 13 additions and 3,060 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,9 +1,18 @@
 We use [swaggerhub](https://app.swaggerhub.com/apis/supertokens/CDI) to host the API spec.
 
-It is written in a `.yaml` (starting from >= v2.8.0). To edit it:
+### Overview
+- The api spec is written in a `.yaml` file
+- When releasing a new CDI version, add the spec to swaggerhub from this repo
+
+### Branching
+- Each version has its own branch
+- When making changes, create a sub-branch of the appropriate version. For example if the changes are meant to reflect in version `2.8.2` you would create a branch from `2.8` (Your final Pull Request should also target `2.8` as the base branch)
+- Changes are not made to the `master` branch directly
+- The master branch will be synchronised with the latest spec when a new version is release
+
+### Making changes
+When making changes to the `api_spec.yaml` file
 - 1) Go to [the swagger editor](https://editor.swagger.io/)
 - 2) Copy / paste the contents of the `.yaml` file into the editor, and then you should see the API docs on the right of the screen.
 - 3) Make changes to the online editor and then copy / paste the content back into the `.yaml` file
-- 4) Issue a PR
-
-When releasing a new CDI version, add the spec to swaggerhub from this repo.
+- 4) Issue a PR to the appropriate branch (refer to the branching section above)
diff --git a/v2.8.0.yaml → api_spec.yaml b/v2.8.0.yaml → api_spec.yaml
diff --git a/v1.0.0.txt b/v1.0.0.txt
diff --git a/v2.0.0.txt b/v2.0.0.txt
diff --git a/v2.1.0.txt b/v2.1.0.txt
diff --git a/v2.2.0.txt b/v2.2.0.txt
diff --git a/v2.3.0.txt b/v2.3.0.txt