diff --git a/README.md b/README.md
index 8157cff2..f7f65dd2 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,6 @@
Cloud-based programming interface
-![Review](https://github.com/STEM-C/CaSMM/workflows/Review/badge.svg)
![Deploy Staging](https://github.com/STEM-C/CaSMM/workflows/Deploy%20Staging/badge.svg)
![Deploy Production](https://github.com/STEM-C/CaSMM/workflows/Deploy%20Production/badge.svg)
@@ -17,7 +16,7 @@ Cloud-based programming interface
### `server`
-[server](/server#server) is the web server and application server. It is powered by [Node](https://nodejs.org/en/) and [Strapi](https://strapi.io/documentation/v3.x/getting-started/introduction.html).
+[server](/server#server) is the web server and application server. It is powered by [Node](https://nodejs.org/en/) and [Strapi](https://docs-v3.strapi.io/developer-docs/latest/getting-started/introduction.html).
### `compile`
@@ -57,9 +56,7 @@ The development environment is composed of five servers. The first one is run wi
1. Install [docker](https://docs.docker.com/get-docker/)
- > If you do not meet these [requirements](https://docs.docker.com/toolbox/toolbox_install_windows/) docker desktop will not initialize properly. There are some unofficial modifications, however, we recommend installing the docker [toolbox](https://docs.docker.com/toolbox/toolbox_install_windows/)
-
-3. Run `docker-compose up` from `/`
+2. Run `docker-compose up` from `/`
> Grant permission to the **scripts** and **server** directories if you are prompted
@@ -100,7 +97,7 @@ All three components of the application have their own dependencies managed in t
### Strapi
-This is by far the largest and most important dependency we have. Staying up to date with its [releases](https://github.com/strapi/strapi/releases) is important for bug/security fixes and new features. When it comes to actually upgrading Strapi make sure to follow the [migration guides](https://strapi.io/documentation/developer-docs/latest/migration-guide/#instructions)!
+This is by far the largest and most important dependency we have. Staying up to date with its [releases](https://github.com/strapi/strapi/releases) is important for bug/security fixes and new features. When it comes to actually upgrading Strapi make sure to follow the [migration guides](https://docs-v3.strapi.io/developer-docs/latest/update-migration-guides/migration-guides.html#v3-guides)!
diff --git a/scripts/development_db.dump b/scripts/development_db.dump
index 43097563..ab157b2a 100644
--- a/scripts/development_db.dump
+++ b/scripts/development_db.dump
@@ -4174,6 +4174,20 @@ SELECT pg_catalog.setval('public.teacher_workspaces__blocks_id_seq', 1, false);
SELECT pg_catalog.setval('public.teacher_workspaces_id_seq', 1, false);
+--
+-- Name: teacher_workspaces__blocks_id_seq; Type: SEQUENCE SET; Schema: public; Owner: postgres
+--
+
+SELECT pg_catalog.setval('public.teacher_workspaces__blocks_id_seq', 1, false);
+
+
+--
+-- Name: teacher_workspaces_id_seq; Type: SEQUENCE SET; Schema: public; Owner: postgres
+--
+
+SELECT pg_catalog.setval('public.teacher_workspaces_id_seq', 1, false);
+
+
--
-- Name: teachers_id_seq; Type: SEQUENCE SET; Schema: public; Owner: postgres
--
diff --git a/server/README.md b/server/README.md
index d772259c..268d533b 100644
--- a/server/README.md
+++ b/server/README.md
@@ -1,6 +1,6 @@
# Server
-> Web server and application server that will serve static content and dynamic content over HTTP. It is powered by [Node](https://nodejs.org/en/), [Strapi](https://strapi.io/documentation/v3.x/getting-started/introduction.html), and [PostgreSQL](https://www.postgresql.org/). The file structure is defined by Strapi and is documented [here](https://strapi.io/documentation/3.0.0-beta.x/concepts/file-structure.html#files-structure).
+> Web server and application server that will serve static content and dynamic content over HTTP. It is powered by [Node](https://nodejs.org/en/), [Strapi](https://strapi.io/documentation/v3.x/getting-started/introduction.html), and [PostgreSQL](https://www.postgresql.org/). The file structure is defined by Strapi and is documented [here](https://docs-v3.strapi.io/developer-docs/latest/setup-deployment-guides/file-structure.html).
@@ -19,7 +19,7 @@
## Static Assets
-All assets in the **public** directory will be served. The specifics are defined [here](https://strapi.io/documentation/v3.x/concepts/public-assets.html).
+All assets in the **public** directory will be served. The specifics are defined [here](https://docs-v3.strapi.io/developer-docs/latest/setup-deployment-guides/configurations.html#public-assets).
### Client
@@ -35,39 +35,22 @@ The [proxy](/server/middlewares/proxy/index.js) middleware handles serving **cli
### Documentation
-The latest API documentation is available on [Postman](https://documenter.getpostman.com/view/3570478/SztBboUJ). You can view example request/responses and even save the collection to your local Postman workspace.
+The latest API documentation is available on [Strapi Documentation](http://localhost:1337/documentation/v1.0.0) after you started your local development. You can view example request/responses and test it with your jwt token.
### Authentication
-Mentors use the `local` provider routes, `/auth/local` and `/auth/local/register`, to login and register. Students login by joining a session with the route `/sessions/join/:code`. In both cases, a JWT will be issued on a successful response. Subsequent requests will need to send this JWT as a `Bearer` token. Read more about that [here](https://strapi.io/documentation/v3.x/plugins/users-permissions.html#authentication).
+Mentors use the `local` provider routes, `/auth/local` and `/auth/local/register`, to login and register. Students login by joining a session with the route `/sessions/join/:code`. In both cases, a JWT will be issued on a successful response. Subsequent requests will need to send this JWT as a `Bearer` token. Read more about that [here](https://docs-v3.strapi.io/developer-docs/latest/development/plugins/users-permissions.html#concept).
-> The [permissions](/cms/extensions/users-permissions/config/policies/permissions.js) policy is run as a middleware on all requests. It will pull the user and their role, which will be executed against the respective policy. Custom logic has been added to handle student JWTs as student auth is not apart of the `/auth` controller group.
+> The [permissions](./extensions/users-permissions/config/policies/permissions.js) policy is run as a middleware on all requests. It will pull the user and their role, which will be executed against the respective policy. Custom logic has been added to handle student JWTs as student auth is not apart of the `/auth` controller group.
### Entity Relationships
-![ER Digram](er_diagram.png)
+![ER Digram](er_diagram.PNG)
### Endpoints
Each endpoint corresponds to an entity from the ER digram, a content type in the admin panel, a folder in the `./api` directory, and a database table.
-| Endpoint |
-| ------------------- |
-| activities |
-| blocks |
-| blocks-categories |
-| classrooms |
-| complexities |
-| difficulties |
-| learning-categories |
-| mentors |
-| models |
-| schools |
-| sessions |
-| students |
-| topics |
-| types |
-
Each and every endpoint can be interacted with by using the following method and path combinations.
| Method | Path | Description |
@@ -79,7 +62,15 @@ Each and every endpoint can be interacted with by using the following method and
| DELETE | /{endpoint}/:id | Delete an entry |
| PUT | /{endpoint}/:id | Update an entry |
-Read the full [documentation](https://strapi.io/documentation/3.0.0-beta.x/content-api/api-endpoints.html#api-endpoints) on the api endpoints.
+Read the full [documentation](https://docs-v3.strapi.io/developer-docs/latest/development/backend-customization.html#routing) on the api endpoints.
+
+
+
+## Strapi Plugins
+
+We intergrated the Stapi [Email](https://docs-v3.strapi.io/developer-docs/latest/development/plugins/email.html#programmatic-usage) Plugin with [SendInBlue](https://www.sendinblue.com/) to send Bug report and forgot password emails.
+
+We also uses Strapi [Documentation](https://docs-v3.strapi.io/developer-docs/latest/development/plugins/documentation.html) Plugin to document our backend api end point as well as testing it on the fly.
@@ -89,5 +80,5 @@ Built with [React](https://reactjs.org/) and served by [Node](https://nodejs.org
> In some cases /admin may be blank, in this case `yarn build` needs to be run from the docker container
-Read the full [documentation](https://strapi.io/documentation/v3.x/admin-panel/customization.html) on the admin panel.
+Read the full [documentation](https://docs-v3.strapi.io/developer-docs/latest/development/admin-customization.html) on the admin panel.
diff --git a/server/api/block/documentation/1.0.0/block.json b/server/api/block/documentation/1.0.0/block.json
new file mode 100644
index 00000000..cd6710e9
--- /dev/null
+++ b/server/api/block/documentation/1.0.0/block.json
@@ -0,0 +1,594 @@
+{
+ "paths": {
+ "/blocks": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Block"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Block"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Block"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Block"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewBlock"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/blocks/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Block"
+ ],
+ "parameters": []
+ }
+ },
+ "/blocks/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Block"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Block"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Block"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Block"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewBlock"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Block"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Block": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "blocks_category": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "image_url": {
+ "type": "string"
+ }
+ }
+ },
+ "NewBlock": {
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "blocks_category": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Block"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/server/api/blocks-category/documentation/1.0.0/blocks-category.json b/server/api/blocks-category/documentation/1.0.0/blocks-category.json
new file mode 100644
index 00000000..e51d7042
--- /dev/null
+++ b/server/api/blocks-category/documentation/1.0.0/blocks-category.json
@@ -0,0 +1,597 @@
+{
+ "paths": {
+ "/blocks-categories": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Blocks-category"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Blocks-category"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewBlocks-category"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/blocks-categories/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Blocks-category"
+ ],
+ "parameters": []
+ }
+ },
+ "/blocks-categories/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Blocks-category"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Blocks-category"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewBlocks-category"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Blocks-category"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Blocks-category": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "blocks_category": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "NewBlocks-category": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": []
+}
\ No newline at end of file
diff --git a/server/api/cc-workspace/documentation/1.0.0/cc-workspace.json b/server/api/cc-workspace/documentation/1.0.0/cc-workspace.json
new file mode 100644
index 00000000..90888197
--- /dev/null
+++ b/server/api/cc-workspace/documentation/1.0.0/cc-workspace.json
@@ -0,0 +1,662 @@
+{
+ "paths": {
+ "/cc-workspaces": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Cc-workspace"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Cc-workspace"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewCc-workspace"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cc-workspaces/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Cc-workspace"
+ ],
+ "parameters": []
+ }
+ },
+ "/cc-workspaces/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Cc-workspace"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Cc-workspace"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewCc-workspace"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Cc-workspace"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/cc-workspaces/toolbox/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Cc-workspace"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Cc-workspace": {
+ "required": [
+ "id",
+ "name",
+ "template"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "template": {
+ "type": "string"
+ },
+ "published_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "NewCc-workspace": {
+ "required": [
+ "name",
+ "template"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "template": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "published_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": []
+}
\ No newline at end of file
diff --git a/server/api/classroom-manager/documentation/1.0.0/classroom-manager.json b/server/api/classroom-manager/documentation/1.0.0/classroom-manager.json
new file mode 100644
index 00000000..667b8faf
--- /dev/null
+++ b/server/api/classroom-manager/documentation/1.0.0/classroom-manager.json
@@ -0,0 +1,62 @@
+{
+ "paths": {
+ "/classroom-managers/me": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom-manager"
+ ],
+ "parameters": []
+ }
+ }
+ },
+ "tags": []
+}
\ No newline at end of file
diff --git a/server/api/classroom/documentation/1.0.0/classroom.json b/server/api/classroom/documentation/1.0.0/classroom.json
new file mode 100644
index 00000000..cd5a63dc
--- /dev/null
+++ b/server/api/classroom/documentation/1.0.0/classroom.json
@@ -0,0 +1,1083 @@
+{
+ "paths": {
+ "/classrooms": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Classroom"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Classroom"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewClassroom"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/classrooms/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "parameters": []
+ }
+ },
+ "/classrooms/student": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "parameters": []
+ }
+ },
+ "/classrooms/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Classroom"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Classroom"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewClassroom"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/classroom/workspaces/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "Retrieve classroom document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/classrooms/join/{code}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "parameters": [
+ {
+ "name": "code",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Classroom": {
+ "required": [
+ "id",
+ "code"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "county": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "submissions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "saves": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "first_name": {
+ "type": "string"
+ },
+ "last_name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "user": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "enrolled"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "character": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "enrolled": {
+ "type": "boolean"
+ },
+ "last_logged_in": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "units": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "current"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "current": {
+ "type": "boolean"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "NewClassroom": {
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cc_workspaces": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Classroom"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/server/api/day/documentation/1.0.0/day.json b/server/api/day/documentation/1.0.0/day.json
new file mode 100644
index 00000000..14d11fb2
--- /dev/null
+++ b/server/api/day/documentation/1.0.0/day.json
@@ -0,0 +1,943 @@
+{
+ "paths": {
+ "/days": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Day"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Day"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewDay"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/days/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "parameters": []
+ }
+ },
+ "/days/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Day"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Day"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewDay"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/days/toolbox/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/days/template/{id}": {
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/days/activity_template/{id}": {
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Day": {
+ "required": [
+ "id",
+ "number",
+ "template"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "required": [
+ "id",
+ "number",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "number"
+ },
+ "name": {
+ "type": "string"
+ },
+ "expectations": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "teks": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "number": {
+ "type": "integer"
+ },
+ "template": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "blocks_category": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "TekS": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "learning_component_type": {
+ "type": "string"
+ },
+ "published_at": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "activity_template": {
+ "type": "string"
+ }
+ }
+ },
+ "NewDay": {
+ "required": [
+ "number",
+ "template"
+ ],
+ "properties": {
+ "learning_standard": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "template": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "TekS": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "activity_template": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Day"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/server/api/email/documentation/1.0.0/email.json b/server/api/email/documentation/1.0.0/email.json
new file mode 100644
index 00000000..ec339621
--- /dev/null
+++ b/server/api/email/documentation/1.0.0/email.json
@@ -0,0 +1,80 @@
+{
+ "paths": {
+ "/bug-report": {
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Email"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Email"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/server/api/grade/documentation/1.0.0/grade.json b/server/api/grade/documentation/1.0.0/grade.json
new file mode 100644
index 00000000..5b4be086
--- /dev/null
+++ b/server/api/grade/documentation/1.0.0/grade.json
@@ -0,0 +1,670 @@
+{
+ "paths": {
+ "/grades": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Grade"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Grade"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Grade"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Grade"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewGrade"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/grades/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Grade"
+ ],
+ "parameters": []
+ }
+ },
+ "/grades/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Grade"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Grade"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Grade"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Grade"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewGrade"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Grade"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Grade": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "code"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cc_workspaces": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "units": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "name",
+ "number"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "teks_id": {
+ "type": "string"
+ },
+ "teks_description": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "learning_standards": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "NewGrade": {
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "units": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Grade"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/server/api/learning-component-types/documentation/1.0.0/learning-component-types.json b/server/api/learning-component-types/documentation/1.0.0/learning-component-types.json
new file mode 100644
index 00000000..61b0d870
--- /dev/null
+++ b/server/api/learning-component-types/documentation/1.0.0/learning-component-types.json
@@ -0,0 +1,607 @@
+{
+ "paths": {
+ "/learning-component-types": {
+ "get": {
+ "deprecated": false,
+ "description": "Find all the learning-component-types's records",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-component-types document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-component-types"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new learning-component-types record",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-component-types document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-component-types"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewLearning-component-types"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/learning-component-types/count": {
+ "get": {
+ "deprecated": false,
+ "description": "Retrieve the number of learning-component-types documents",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-component-types document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-component-types"
+ ],
+ "parameters": []
+ }
+ },
+ "/learning-component-types/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "Find one learning-component-types record",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-component-types document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-component-types"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a single learning-component-types record",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-component-types document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-component-types"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewLearning-component-types"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a single learning-component-types record",
+ "responses": {
+ "200": {
+ "description": "deletes a single learning-component-types based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-component-types"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Learning-component-types": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "learning_component_type": {
+ "type": "string"
+ },
+ "published_at": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "published_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "NewLearning-component-types": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "published_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": []
+}
\ No newline at end of file
diff --git a/server/api/learning-components/documentation/1.0.0/learning-components.json b/server/api/learning-components/documentation/1.0.0/learning-components.json
new file mode 100644
index 00000000..09ebfa2f
--- /dev/null
+++ b/server/api/learning-components/documentation/1.0.0/learning-components.json
@@ -0,0 +1,658 @@
+{
+ "paths": {
+ "/learning-components": {
+ "get": {
+ "deprecated": false,
+ "description": "Find all the learning-components's records",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-components document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-components"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new learning-components record",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-components document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-components"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewLearning-components"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/learning-components/count": {
+ "get": {
+ "deprecated": false,
+ "description": "Retrieve the number of learning-components documents",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-components document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-components"
+ ],
+ "parameters": []
+ }
+ },
+ "/learning-components/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "Find one learning-components record",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-components document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-components"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a single learning-components record",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-components document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-components"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewLearning-components"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a single learning-components record",
+ "responses": {
+ "200": {
+ "description": "deletes a single learning-components based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-components"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Learning-components": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "number",
+ "template"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "template": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "TekS": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "activity_template": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "learning_component_type": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "published_at": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "published_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "NewLearning-components": {
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "learning_component_type": {
+ "type": "string"
+ },
+ "published_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": []
+}
\ No newline at end of file
diff --git a/server/api/learning-standard/documentation/1.0.0/learning-standard.json b/server/api/learning-standard/documentation/1.0.0/learning-standard.json
new file mode 100644
index 00000000..6e00b4b3
--- /dev/null
+++ b/server/api/learning-standard/documentation/1.0.0/learning-standard.json
@@ -0,0 +1,691 @@
+{
+ "paths": {
+ "/learning-standards": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-standard"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-standard"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewLearning-standard"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/learning-standards/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-standard"
+ ],
+ "parameters": []
+ }
+ },
+ "/learning-standards/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-standard"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-standard"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewLearning-standard"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-standard"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Learning-standard": {
+ "required": [
+ "id",
+ "number",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "number"
+ },
+ "name": {
+ "type": "string"
+ },
+ "expectations": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "number",
+ "template"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "template": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "TekS": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "activity_template": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "unit": {
+ "required": [
+ "id",
+ "name",
+ "number"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "teks_id": {
+ "type": "string"
+ },
+ "teks_description": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "learning_standards": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "teks": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ }
+ }
+ },
+ "NewLearning-standard": {
+ "required": [
+ "number",
+ "name"
+ ],
+ "properties": {
+ "number": {
+ "type": "number"
+ },
+ "name": {
+ "type": "string"
+ },
+ "expectations": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "teks": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": []
+}
\ No newline at end of file
diff --git a/server/api/mentor/documentation/1.0.0/mentor.json b/server/api/mentor/documentation/1.0.0/mentor.json
new file mode 100644
index 00000000..07c7bf88
--- /dev/null
+++ b/server/api/mentor/documentation/1.0.0/mentor.json
@@ -0,0 +1,712 @@
+{
+ "paths": {
+ "/mentors": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Mentor"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Mentor"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Mentor"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Mentor"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewMentor"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/mentors/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Mentor"
+ ],
+ "parameters": []
+ }
+ },
+ "/mentors/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Mentor"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Mentor"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Mentor"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Mentor"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewMentor"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Mentor"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Mentor": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "first_name": {
+ "type": "string"
+ },
+ "last_name": {
+ "type": "string"
+ },
+ "school": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "county": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "code"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cc_workspaces": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "user": {
+ "required": [
+ "id",
+ "username",
+ "email"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "password": {
+ "type": "string"
+ },
+ "resetPasswordToken": {
+ "type": "string"
+ },
+ "confirmationToken": {
+ "type": "string"
+ },
+ "confirmed": {
+ "type": "boolean"
+ },
+ "blocked": {
+ "type": "boolean"
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "NewMentor": {
+ "properties": {
+ "first_name": {
+ "type": "string"
+ },
+ "last_name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "user": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Mentor"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/server/api/sandbox/documentation/1.0.0/sandbox.json b/server/api/sandbox/documentation/1.0.0/sandbox.json
new file mode 100644
index 00000000..46e47354
--- /dev/null
+++ b/server/api/sandbox/documentation/1.0.0/sandbox.json
@@ -0,0 +1,205 @@
+{
+ "paths": {
+ "/sandbox/toolbox": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Sandbox"
+ ],
+ "parameters": []
+ }
+ },
+ "/sandbox/submission/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Sandbox"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/sandbox/submission": {
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Sandbox"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Sandbox"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/server/api/save/documentation/1.0.0/save.json b/server/api/save/documentation/1.0.0/save.json
new file mode 100644
index 00000000..8fb3563a
--- /dev/null
+++ b/server/api/save/documentation/1.0.0/save.json
@@ -0,0 +1,772 @@
+{
+ "paths": {
+ "/saves": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Save"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Save"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Save"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Save"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSave"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/saves/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Save"
+ ],
+ "parameters": []
+ }
+ },
+ "/saves/day/{day}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Save"
+ ],
+ "parameters": [
+ {
+ "name": "day",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/saves/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Save"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Save"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Save"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Save"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSave"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Save"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Save": {
+ "required": [
+ "id",
+ "workspace"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "day": {
+ "required": [
+ "id",
+ "number",
+ "template"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "template": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "TekS": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "activity_template": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "student": {
+ "required": [
+ "id",
+ "enrolled"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "character": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "enrolled": {
+ "type": "boolean"
+ },
+ "last_logged_in": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "workspace": {
+ "type": "string"
+ },
+ "replay": {
+ "type": "object"
+ },
+ "session": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "submissions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "saves": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "NewSave": {
+ "required": [
+ "workspace"
+ ],
+ "properties": {
+ "day": {
+ "type": "string"
+ },
+ "student": {
+ "type": "string"
+ },
+ "workspace": {
+ "type": "string"
+ },
+ "replay": {
+ "type": "object"
+ },
+ "session": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Save"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/server/api/school/documentation/1.0.0/school.json b/server/api/school/documentation/1.0.0/school.json
new file mode 100644
index 00000000..493f0186
--- /dev/null
+++ b/server/api/school/documentation/1.0.0/school.json
@@ -0,0 +1,673 @@
+{
+ "paths": {
+ "/schools": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/School"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "School"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/School"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "School"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSchool"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/schools/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "School"
+ ],
+ "parameters": []
+ }
+ },
+ "/schools/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/School"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "School"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/School"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "School"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSchool"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "School"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "School": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "county": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "code"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cc_workspaces": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "first_name": {
+ "type": "string"
+ },
+ "last_name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "user": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "NewSchool": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "county": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "School"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/server/api/selection/documentation/1.0.0/selection.json b/server/api/selection/documentation/1.0.0/selection.json
new file mode 100644
index 00000000..d11d2a8f
--- /dev/null
+++ b/server/api/selection/documentation/1.0.0/selection.json
@@ -0,0 +1,663 @@
+{
+ "paths": {
+ "/selections": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Selection"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Selection"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Selection"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Selection"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSelection"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/selections/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Selection"
+ ],
+ "parameters": []
+ }
+ },
+ "/selections/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Selection"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Selection"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Selection"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Selection"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSelection"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Selection"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Selection": {
+ "required": [
+ "id",
+ "current"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "classroom": {
+ "required": [
+ "id",
+ "code"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cc_workspaces": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "learning_standard": {
+ "required": [
+ "id",
+ "number",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "number"
+ },
+ "name": {
+ "type": "string"
+ },
+ "expectations": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "teks": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "current": {
+ "type": "boolean",
+ "default": true
+ }
+ }
+ },
+ "NewSelection": {
+ "required": [
+ "current"
+ ],
+ "properties": {
+ "classroom": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "current": {
+ "type": "boolean",
+ "default": true
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Selection"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/server/api/session/documentation/1.0.0/session.json b/server/api/session/documentation/1.0.0/session.json
new file mode 100644
index 00000000..0dae4081
--- /dev/null
+++ b/server/api/session/documentation/1.0.0/session.json
@@ -0,0 +1,882 @@
+{
+ "paths": {
+ "/sessions": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Session"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Session"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Session"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Session"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSession"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/sessions/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Session"
+ ],
+ "parameters": []
+ }
+ },
+ "/sessions/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Session"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Session"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Session"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Session"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSession"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Session"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Session": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "classroom": {
+ "required": [
+ "id",
+ "code"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cc_workspaces": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "enrolled"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "character": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "enrolled": {
+ "type": "boolean"
+ },
+ "last_logged_in": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "submissions": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "status",
+ "workspace",
+ "board",
+ "sketch",
+ "sandbox"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ },
+ "workspace": {
+ "type": "string"
+ },
+ "success": {
+ "type": "boolean"
+ },
+ "hex": {
+ "type": "string"
+ },
+ "stdout": {
+ "type": "string"
+ },
+ "stderr": {
+ "type": "string"
+ },
+ "board": {
+ "type": "string"
+ },
+ "sketch": {
+ "type": "string"
+ },
+ "sandbox": {
+ "type": "boolean"
+ },
+ "session": {
+ "type": "string"
+ },
+ "day": {
+ "type": "string"
+ },
+ "job_id": {
+ "type": "integer"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "saves": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "workspace"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "day": {
+ "type": "string"
+ },
+ "student": {
+ "type": "string"
+ },
+ "workspace": {
+ "type": "string"
+ },
+ "replay": {
+ "type": "object"
+ },
+ "session": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "unit": {
+ "required": [
+ "id",
+ "name",
+ "number"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "teks_id": {
+ "type": "string"
+ },
+ "teks_description": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "learning_standards": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "grade": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "units": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "learning_standard": {
+ "required": [
+ "id",
+ "number",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "number"
+ },
+ "name": {
+ "type": "string"
+ },
+ "expectations": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "teks": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "NewSession": {
+ "properties": {
+ "classroom": {
+ "type": "string"
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "submissions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "saves": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Session"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/server/api/student/documentation/1.0.0/student.json b/server/api/student/documentation/1.0.0/student.json
new file mode 100644
index 00000000..5918a021
--- /dev/null
+++ b/server/api/student/documentation/1.0.0/student.json
@@ -0,0 +1,833 @@
+{
+ "paths": {
+ "/students": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Student"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Student"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewStudent"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/students/me": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "parameters": []
+ }
+ },
+ "/students/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "parameters": []
+ }
+ },
+ "/students/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Student"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Student"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewStudent"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/students/enrolled/{id}": {
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Student": {
+ "required": [
+ "id",
+ "enrolled"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "character": {
+ "type": "string"
+ },
+ "classroom": {
+ "required": [
+ "id",
+ "code"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cc_workspaces": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "submissions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "saves": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "enrolled": {
+ "type": "boolean",
+ "default": true
+ },
+ "last_logged_in": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "NewStudent": {
+ "required": [
+ "enrolled"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "character": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "enrolled": {
+ "type": "boolean",
+ "default": true
+ },
+ "last_logged_in": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Student"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/server/api/submission/documentation/1.0.0/submission.json b/server/api/submission/documentation/1.0.0/submission.json
new file mode 100644
index 00000000..437a0772
--- /dev/null
+++ b/server/api/submission/documentation/1.0.0/submission.json
@@ -0,0 +1,723 @@
+{
+ "paths": {
+ "/submissions": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Submission"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Submission"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Submission"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Submission"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSubmission"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/submissions/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Submission"
+ ],
+ "parameters": []
+ }
+ },
+ "/submissions/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Submission"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Submission"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Submission"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Submission"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSubmission"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Submission"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Submission": {
+ "required": [
+ "id",
+ "status",
+ "workspace",
+ "board",
+ "sketch",
+ "sandbox"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string",
+ "default": "WAITING"
+ },
+ "workspace": {
+ "type": "string"
+ },
+ "success": {
+ "type": "boolean"
+ },
+ "hex": {
+ "type": "string"
+ },
+ "stdout": {
+ "type": "string"
+ },
+ "stderr": {
+ "type": "string"
+ },
+ "board": {
+ "type": "string"
+ },
+ "sketch": {
+ "type": "string"
+ },
+ "sandbox": {
+ "type": "boolean",
+ "default": false
+ },
+ "session": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "submissions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "saves": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "day": {
+ "required": [
+ "id",
+ "number",
+ "template"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "template": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "TekS": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "activity_template": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "job_id": {
+ "type": "integer"
+ }
+ }
+ },
+ "NewSubmission": {
+ "required": [
+ "status",
+ "workspace",
+ "board",
+ "sketch",
+ "sandbox"
+ ],
+ "properties": {
+ "status": {
+ "type": "string",
+ "default": "WAITING"
+ },
+ "workspace": {
+ "type": "string"
+ },
+ "success": {
+ "type": "boolean"
+ },
+ "hex": {
+ "type": "string"
+ },
+ "stdout": {
+ "type": "string"
+ },
+ "stderr": {
+ "type": "string"
+ },
+ "board": {
+ "type": "string"
+ },
+ "sketch": {
+ "type": "string"
+ },
+ "sandbox": {
+ "type": "boolean",
+ "default": false
+ },
+ "session": {
+ "type": "string"
+ },
+ "day": {
+ "type": "string"
+ },
+ "job_id": {
+ "type": "integer"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Submission"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/server/api/unit/documentation/1.0.0/unit.json b/server/api/unit/documentation/1.0.0/unit.json
new file mode 100644
index 00000000..6104e8c3
--- /dev/null
+++ b/server/api/unit/documentation/1.0.0/unit.json
@@ -0,0 +1,660 @@
+{
+ "paths": {
+ "/units": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Unit"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Unit"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Unit"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Unit"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewUnit"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/units/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Unit"
+ ],
+ "parameters": []
+ }
+ },
+ "/units/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Unit"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Unit"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Unit"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Unit"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewUnit"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Unit"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Unit": {
+ "required": [
+ "id",
+ "name",
+ "number"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "grade": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "units": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "teks_id": {
+ "type": "string"
+ },
+ "teks_description": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "learning_standards": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "number",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "number"
+ },
+ "name": {
+ "type": "string"
+ },
+ "expectations": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "teks": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "NewUnit": {
+ "required": [
+ "name",
+ "number"
+ ],
+ "properties": {
+ "grade": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "teks_id": {
+ "type": "string"
+ },
+ "teks_description": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "learning_standards": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Unit"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/server/config/middleware.js b/server/config/middleware.js
index dbb34a33..80d033ed 100644
--- a/server/config/middleware.js
+++ b/server/config/middleware.js
@@ -13,6 +13,9 @@ module.exports = {
proxy: {
enabled: true,
clientPath: './public/client',
+ },
+ parser: {
+ jsonLimit: '10mb'
}
// logger: {
// // dev + prod
diff --git a/server/er_diagram.PNG b/server/er_diagram.PNG
new file mode 100644
index 00000000..aa64db61
Binary files /dev/null and b/server/er_diagram.PNG differ
diff --git a/server/er_diagram.png b/server/er_diagram.png
deleted file mode 100644
index ec0560ad..00000000
Binary files a/server/er_diagram.png and /dev/null differ
diff --git a/server/extensions/documentation/documentation/1.0.0/full_documentation.json b/server/extensions/documentation/documentation/1.0.0/full_documentation.json
new file mode 100755
index 00000000..fd3d5684
--- /dev/null
+++ b/server/extensions/documentation/documentation/1.0.0/full_documentation.json
@@ -0,0 +1,14774 @@
+{
+ "openapi": "3.0.0",
+ "info": {
+ "version": "1.0.0",
+ "title": "DOCUMENTATION",
+ "description": "",
+ "termsOfService": "YOUR_TERMS_OF_SERVICE_URL",
+ "contact": {
+ "name": "TEAM",
+ "email": "contact-email@something.io",
+ "url": "mywebsite.io"
+ },
+ "license": {
+ "name": "Apache 2.0",
+ "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
+ },
+ "x-generation-date": "04/21/2022 9:15:45 PM"
+ },
+ "x-strapi-config": {
+ "path": "/documentation",
+ "showGeneratedFiles": true,
+ "generateDefaultResponse": true
+ },
+ "servers": [
+ {
+ "url": "http://localhost:1337",
+ "description": "Development server"
+ },
+ {
+ "url": "YOUR_STAGING_SERVER",
+ "description": "Staging server"
+ },
+ {
+ "url": "YOUR_PRODUCTION_SERVER",
+ "description": "Production server"
+ }
+ ],
+ "externalDocs": {
+ "description": "Find out more",
+ "url": "https://strapi.io/documentation/developer-docs/latest/getting-started/introduction.html"
+ },
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ],
+ "paths": {
+ "/blocks": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Block"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Block"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Block"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Block"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewBlock"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/blocks/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Block"
+ ],
+ "parameters": []
+ }
+ },
+ "/blocks/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Block"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Block"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Block"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Block"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewBlock"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Block"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/blocks-categories": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Blocks-category"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Blocks-category"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewBlocks-category"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/blocks-categories/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Blocks-category"
+ ],
+ "parameters": []
+ }
+ },
+ "/blocks-categories/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Blocks-category"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Blocks-category"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewBlocks-category"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Blocks-category"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/cc-workspaces": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Cc-workspace"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Cc-workspace"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewCc-workspace"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cc-workspaces/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Cc-workspace"
+ ],
+ "parameters": []
+ }
+ },
+ "/cc-workspaces/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Cc-workspace"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Cc-workspace"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewCc-workspace"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Cc-workspace"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/cc-workspaces/toolbox/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Cc-workspace"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/classroom-managers/me": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom-manager"
+ ],
+ "parameters": []
+ }
+ },
+ "/classrooms": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Classroom"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Classroom"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewClassroom"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/classrooms/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "parameters": []
+ }
+ },
+ "/classrooms/student": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "parameters": []
+ }
+ },
+ "/classrooms/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Classroom"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Classroom"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewClassroom"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/classroom/workspaces/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "Retrieve classroom document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/classrooms/join/{code}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "parameters": [
+ {
+ "name": "code",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Classroom"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/days": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Day"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Day"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewDay"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/days/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "parameters": []
+ }
+ },
+ "/days/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Day"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Day"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewDay"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/days/toolbox/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/days/template/{id}": {
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/days/activity_template/{id}": {
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Day"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/bug-report": {
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Email"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/grades": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Grade"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Grade"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Grade"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Grade"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewGrade"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/grades/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Grade"
+ ],
+ "parameters": []
+ }
+ },
+ "/grades/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Grade"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Grade"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Grade"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Grade"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewGrade"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Grade"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/learning-component-types": {
+ "get": {
+ "deprecated": false,
+ "description": "Find all the learning-component-types's records",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-component-types document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-component-types"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new learning-component-types record",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-component-types document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-component-types"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewLearning-component-types"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/learning-component-types/count": {
+ "get": {
+ "deprecated": false,
+ "description": "Retrieve the number of learning-component-types documents",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-component-types document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-component-types"
+ ],
+ "parameters": []
+ }
+ },
+ "/learning-component-types/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "Find one learning-component-types record",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-component-types document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-component-types"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a single learning-component-types record",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-component-types document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-component-types"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewLearning-component-types"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a single learning-component-types record",
+ "responses": {
+ "200": {
+ "description": "deletes a single learning-component-types based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-component-types"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/learning-components": {
+ "get": {
+ "deprecated": false,
+ "description": "Find all the learning-components's records",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-components document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-components"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new learning-components record",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-components document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-components"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewLearning-components"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/learning-components/count": {
+ "get": {
+ "deprecated": false,
+ "description": "Retrieve the number of learning-components documents",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-components document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-components"
+ ],
+ "parameters": []
+ }
+ },
+ "/learning-components/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "Find one learning-components record",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-components document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-components"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a single learning-components record",
+ "responses": {
+ "200": {
+ "description": "Retrieve learning-components document(s)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-components"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewLearning-components"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a single learning-components record",
+ "responses": {
+ "200": {
+ "description": "deletes a single learning-components based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-components"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/learning-standards": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-standard"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-standard"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewLearning-standard"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/learning-standards/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-standard"
+ ],
+ "parameters": []
+ }
+ },
+ "/learning-standards/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-standard"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-standard"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewLearning-standard"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Learning-standard"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/mentors": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Mentor"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Mentor"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Mentor"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Mentor"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewMentor"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/mentors/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Mentor"
+ ],
+ "parameters": []
+ }
+ },
+ "/mentors/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Mentor"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Mentor"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Mentor"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Mentor"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewMentor"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Mentor"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/sandbox/toolbox": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Sandbox"
+ ],
+ "parameters": []
+ }
+ },
+ "/sandbox/submission/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Sandbox"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/sandbox/submission": {
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Sandbox"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/saves": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Save"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Save"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Save"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Save"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSave"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/saves/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Save"
+ ],
+ "parameters": []
+ }
+ },
+ "/saves/day/{day}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Save"
+ ],
+ "parameters": [
+ {
+ "name": "day",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/saves/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Save"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Save"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Save"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Save"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSave"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Save"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/schools": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/School"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "School"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/School"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "School"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSchool"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/schools/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "School"
+ ],
+ "parameters": []
+ }
+ },
+ "/schools/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/School"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "School"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/School"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "School"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSchool"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "School"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/selections": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Selection"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Selection"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Selection"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Selection"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSelection"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/selections/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Selection"
+ ],
+ "parameters": []
+ }
+ },
+ "/selections/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Selection"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Selection"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Selection"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Selection"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSelection"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Selection"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/sessions": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Session"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Session"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Session"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Session"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSession"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/sessions/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Session"
+ ],
+ "parameters": []
+ }
+ },
+ "/sessions/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Session"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Session"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Session"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Session"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSession"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Session"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/students": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Student"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Student"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewStudent"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/students/me": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "parameters": []
+ }
+ },
+ "/students/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "parameters": []
+ }
+ },
+ "/students/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Student"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Student"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewStudent"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/students/enrolled/{id}": {
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Student"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/submissions": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Submission"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Submission"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Submission"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Submission"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSubmission"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/submissions/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Submission"
+ ],
+ "parameters": []
+ }
+ },
+ "/submissions/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Submission"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Submission"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Submission"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Submission"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSubmission"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Submission"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/units": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Unit"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Unit"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Unit"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Unit"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewUnit"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/units/count": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "count": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Unit"
+ ],
+ "parameters": []
+ }
+ },
+ "/units/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Unit"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Unit"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update a record",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Unit"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Unit"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewUnit"
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a record",
+ "responses": {
+ "200": {
+ "description": "deletes a single record based on the ID supplied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Unit"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/email/": {
+ "post": {
+ "deprecated": false,
+ "description": "Send an email",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Email - Email"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/email/test": {
+ "post": {
+ "deprecated": false,
+ "description": "Send an test email",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Email - Email"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/email/settings": {
+ "get": {
+ "deprecated": false,
+ "description": "Get the email settings",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "Email - Email"
+ ],
+ "parameters": []
+ }
+ },
+ "/users-permissions/roles/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "Retrieve a role depending on its id",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UsersPermissionsRole"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - Role"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/users-permissions/roles": {
+ "get": {
+ "deprecated": false,
+ "description": "Retrieve all role documents",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UsersPermissionsRole"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - Role"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ },
+ "post": {
+ "deprecated": false,
+ "description": "Create a new role",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UsersPermissionsRole"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - Role"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewUsersPermissionsRole"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users-permissions/roles/{role}": {
+ "put": {
+ "deprecated": false,
+ "description": "Update a role",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UsersPermissionsRole"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - Role"
+ ],
+ "parameters": [
+ {
+ "name": "role",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewUsersPermissionsRole"
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete a role",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - Role"
+ ],
+ "parameters": [
+ {
+ "name": "role",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/users-permissions/search/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "Search for users",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UsersPermissionsUser"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - User"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ }
+ },
+ "/connect/*": {
+ "get": {
+ "deprecated": false,
+ "description": "Connect a provider",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - User"
+ ],
+ "parameters": []
+ }
+ },
+ "/auth/local": {
+ "post": {
+ "deprecated": false,
+ "description": "Login a user using the identifiers email and password",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - User"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/auth/local/register": {
+ "post": {
+ "deprecated": false,
+ "description": "Register a new user with the default role",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UsersPermissionsUser"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - User"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewUsersPermissionsUser"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/auth/{provider}/callback": {
+ "get": {
+ "deprecated": false,
+ "description": "Successfull redirection after approving a provider",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - User"
+ ],
+ "parameters": [
+ {
+ "name": "provider",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ "/auth/forgot-password": {
+ "post": {
+ "deprecated": false,
+ "description": "Send the reset password email link",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - User"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/auth/reset-password": {
+ "post": {
+ "deprecated": false,
+ "description": "Reset user password with a code (resetToken)",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - User"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/auth/email-confirmation": {
+ "get": {
+ "deprecated": false,
+ "description": "Validate a user account",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - User"
+ ],
+ "parameters": []
+ }
+ },
+ "/auth/send-email-confirmation": {
+ "post": {
+ "deprecated": false,
+ "description": "Send a confirmation email to user",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - User"
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users": {
+ "get": {
+ "deprecated": false,
+ "description": "Retrieve all user documents",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UsersPermissionsUser"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - User"
+ ],
+ "parameters": [
+ {
+ "name": "_limit",
+ "in": "query",
+ "required": false,
+ "description": "Maximum number of results possible",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "required": false,
+ "description": "Sort according to a specific field.",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_start",
+ "in": "query",
+ "required": false,
+ "description": "Skip a specific number of entries (especially useful for pagination)",
+ "schema": {
+ "type": "integer"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "=",
+ "in": "query",
+ "required": false,
+ "description": "Get entries that matches exactly your input",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_ne",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are not equals to something",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lt",
+ "in": "query",
+ "required": false,
+ "description": "Get record that are lower than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_lte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are lower than or equal to a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gt",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_gte",
+ "in": "query",
+ "required": false,
+ "description": "Get records that are greater than or equal a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_contains",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_containss",
+ "in": "query",
+ "required": false,
+ "description": "Get records that contains (case sensitive) a value",
+ "schema": {
+ "type": "string"
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_in",
+ "in": "query",
+ "required": false,
+ "description": "Get records that matches any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ },
+ {
+ "name": "_nin",
+ "in": "query",
+ "required": false,
+ "description": "Get records that doesn't match any value in the array of values",
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deprecated": false
+ }
+ ]
+ }
+ },
+ "/users/me": {
+ "get": {
+ "deprecated": false,
+ "description": "Retrieve the logged in user information",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UsersPermissionsUser"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - User"
+ ],
+ "parameters": []
+ }
+ },
+ "/users/{id}": {
+ "get": {
+ "deprecated": false,
+ "description": "Retrieve a single user depending on his id",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UsersPermissionsUser"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - User"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "put": {
+ "deprecated": false,
+ "description": "Update an existing user",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UsersPermissionsUser"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - User"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewUsersPermissionsUser"
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "deprecated": false,
+ "description": "Delete an existing user",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "foo": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ }
+ },
+ "summary": "",
+ "tags": [
+ "UsersPermissions - User"
+ ],
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "",
+ "deprecated": false,
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Block": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "blocks_category": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "image_url": {
+ "type": "string"
+ }
+ }
+ },
+ "NewBlock": {
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "blocks_category": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Blocks-category": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "blocks_category": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "NewBlocks-category": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Cc-workspace": {
+ "required": [
+ "id",
+ "name",
+ "template"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "template": {
+ "type": "string"
+ },
+ "published_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "NewCc-workspace": {
+ "required": [
+ "name",
+ "template"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "template": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "published_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Classroom": {
+ "required": [
+ "id",
+ "code"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "county": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "submissions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "saves": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "first_name": {
+ "type": "string"
+ },
+ "last_name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "user": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "enrolled"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "character": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "enrolled": {
+ "type": "boolean"
+ },
+ "last_logged_in": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "units": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "current"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "current": {
+ "type": "boolean"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "NewClassroom": {
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cc_workspaces": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Day": {
+ "required": [
+ "id",
+ "number",
+ "template"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "required": [
+ "id",
+ "number",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "number"
+ },
+ "name": {
+ "type": "string"
+ },
+ "expectations": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "teks": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "number": {
+ "type": "integer"
+ },
+ "template": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "blocks_category": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "TekS": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "learning_component_type": {
+ "type": "string"
+ },
+ "published_at": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "activity_template": {
+ "type": "string"
+ }
+ }
+ },
+ "NewDay": {
+ "required": [
+ "number",
+ "template"
+ ],
+ "properties": {
+ "learning_standard": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "template": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "TekS": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "activity_template": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Grade": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "code"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cc_workspaces": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "units": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "name",
+ "number"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "teks_id": {
+ "type": "string"
+ },
+ "teks_description": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "learning_standards": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "NewGrade": {
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "units": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Learning-component-types": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "learning_component_type": {
+ "type": "string"
+ },
+ "published_at": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "published_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "NewLearning-component-types": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "published_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Learning-components": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "number",
+ "template"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "template": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "TekS": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "activity_template": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "learning_component_type": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "published_at": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "published_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "NewLearning-components": {
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "learning_component_type": {
+ "type": "string"
+ },
+ "published_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Learning-standard": {
+ "required": [
+ "id",
+ "number",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "number"
+ },
+ "name": {
+ "type": "string"
+ },
+ "expectations": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "number",
+ "template"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "template": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "TekS": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "activity_template": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "unit": {
+ "required": [
+ "id",
+ "name",
+ "number"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "teks_id": {
+ "type": "string"
+ },
+ "teks_description": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "learning_standards": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "teks": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ }
+ }
+ },
+ "NewLearning-standard": {
+ "required": [
+ "number",
+ "name"
+ ],
+ "properties": {
+ "number": {
+ "type": "number"
+ },
+ "name": {
+ "type": "string"
+ },
+ "expectations": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "teks": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Mentor": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "first_name": {
+ "type": "string"
+ },
+ "last_name": {
+ "type": "string"
+ },
+ "school": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "county": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "code"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cc_workspaces": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "user": {
+ "required": [
+ "id",
+ "username",
+ "email"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "password": {
+ "type": "string"
+ },
+ "resetPasswordToken": {
+ "type": "string"
+ },
+ "confirmationToken": {
+ "type": "string"
+ },
+ "confirmed": {
+ "type": "boolean"
+ },
+ "blocked": {
+ "type": "boolean"
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "NewMentor": {
+ "properties": {
+ "first_name": {
+ "type": "string"
+ },
+ "last_name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "user": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Save": {
+ "required": [
+ "id",
+ "workspace"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "day": {
+ "required": [
+ "id",
+ "number",
+ "template"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "template": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "TekS": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "activity_template": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "student": {
+ "required": [
+ "id",
+ "enrolled"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "character": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "enrolled": {
+ "type": "boolean"
+ },
+ "last_logged_in": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "workspace": {
+ "type": "string"
+ },
+ "replay": {
+ "type": "object"
+ },
+ "session": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "submissions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "saves": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "NewSave": {
+ "required": [
+ "workspace"
+ ],
+ "properties": {
+ "day": {
+ "type": "string"
+ },
+ "student": {
+ "type": "string"
+ },
+ "workspace": {
+ "type": "string"
+ },
+ "replay": {
+ "type": "object"
+ },
+ "session": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "School": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "county": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "code"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cc_workspaces": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "first_name": {
+ "type": "string"
+ },
+ "last_name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "user": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "NewSchool": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "county": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Selection": {
+ "required": [
+ "id",
+ "current"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "classroom": {
+ "required": [
+ "id",
+ "code"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cc_workspaces": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "learning_standard": {
+ "required": [
+ "id",
+ "number",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "number"
+ },
+ "name": {
+ "type": "string"
+ },
+ "expectations": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "teks": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "current": {
+ "type": "boolean",
+ "default": true
+ }
+ }
+ },
+ "NewSelection": {
+ "required": [
+ "current"
+ ],
+ "properties": {
+ "classroom": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "current": {
+ "type": "boolean",
+ "default": true
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Session": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "classroom": {
+ "required": [
+ "id",
+ "code"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cc_workspaces": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "enrolled"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "character": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "enrolled": {
+ "type": "boolean"
+ },
+ "last_logged_in": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "submissions": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "status",
+ "workspace",
+ "board",
+ "sketch",
+ "sandbox"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ },
+ "workspace": {
+ "type": "string"
+ },
+ "success": {
+ "type": "boolean"
+ },
+ "hex": {
+ "type": "string"
+ },
+ "stdout": {
+ "type": "string"
+ },
+ "stderr": {
+ "type": "string"
+ },
+ "board": {
+ "type": "string"
+ },
+ "sketch": {
+ "type": "string"
+ },
+ "sandbox": {
+ "type": "boolean"
+ },
+ "session": {
+ "type": "string"
+ },
+ "day": {
+ "type": "string"
+ },
+ "job_id": {
+ "type": "integer"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "saves": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "workspace"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "day": {
+ "type": "string"
+ },
+ "student": {
+ "type": "string"
+ },
+ "workspace": {
+ "type": "string"
+ },
+ "replay": {
+ "type": "object"
+ },
+ "session": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "unit": {
+ "required": [
+ "id",
+ "name",
+ "number"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "teks_id": {
+ "type": "string"
+ },
+ "teks_description": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "learning_standards": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "grade": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "units": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "learning_standard": {
+ "required": [
+ "id",
+ "number",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "number"
+ },
+ "name": {
+ "type": "string"
+ },
+ "expectations": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "teks": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "NewSession": {
+ "properties": {
+ "classroom": {
+ "type": "string"
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "submissions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "saves": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Student": {
+ "required": [
+ "id",
+ "enrolled"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "character": {
+ "type": "string"
+ },
+ "classroom": {
+ "required": [
+ "id",
+ "code"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "school": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mentors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "code": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "selections": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cc_workspaces": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "submissions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "saves": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "enrolled": {
+ "type": "boolean",
+ "default": true
+ },
+ "last_logged_in": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "NewStudent": {
+ "required": [
+ "enrolled"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "character": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "sessions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "enrolled": {
+ "type": "boolean",
+ "default": true
+ },
+ "last_logged_in": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Submission": {
+ "required": [
+ "id",
+ "status",
+ "workspace",
+ "board",
+ "sketch",
+ "sandbox"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string",
+ "default": "WAITING"
+ },
+ "workspace": {
+ "type": "string"
+ },
+ "success": {
+ "type": "boolean"
+ },
+ "hex": {
+ "type": "string"
+ },
+ "stdout": {
+ "type": "string"
+ },
+ "stderr": {
+ "type": "string"
+ },
+ "board": {
+ "type": "string"
+ },
+ "sketch": {
+ "type": "string"
+ },
+ "sandbox": {
+ "type": "boolean",
+ "default": false
+ },
+ "session": {
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "classroom": {
+ "type": "string"
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "submissions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "saves": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "grade": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "day": {
+ "required": [
+ "id",
+ "number",
+ "template"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "learning_standard": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "template": {
+ "type": "string"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "TekS": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "learning_components": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "activity_template": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "job_id": {
+ "type": "integer"
+ }
+ }
+ },
+ "NewSubmission": {
+ "required": [
+ "status",
+ "workspace",
+ "board",
+ "sketch",
+ "sandbox"
+ ],
+ "properties": {
+ "status": {
+ "type": "string",
+ "default": "WAITING"
+ },
+ "workspace": {
+ "type": "string"
+ },
+ "success": {
+ "type": "boolean"
+ },
+ "hex": {
+ "type": "string"
+ },
+ "stdout": {
+ "type": "string"
+ },
+ "stderr": {
+ "type": "string"
+ },
+ "board": {
+ "type": "string"
+ },
+ "sketch": {
+ "type": "string"
+ },
+ "sandbox": {
+ "type": "boolean",
+ "default": false
+ },
+ "session": {
+ "type": "string"
+ },
+ "day": {
+ "type": "string"
+ },
+ "job_id": {
+ "type": "integer"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Unit": {
+ "required": [
+ "id",
+ "name",
+ "number"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "grade": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "classrooms": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "units": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "teks_id": {
+ "type": "string"
+ },
+ "teks_description": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "learning_standards": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "number",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "number"
+ },
+ "name": {
+ "type": "string"
+ },
+ "expectations": {
+ "type": "string"
+ },
+ "days": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unit": {
+ "type": "string"
+ },
+ "teks": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "NewUnit": {
+ "required": [
+ "name",
+ "number"
+ ],
+ "properties": {
+ "grade": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "teks_id": {
+ "type": "string"
+ },
+ "teks_description": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "learning_standards": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "UsersPermissionsRole": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "minLength": 3
+ },
+ "description": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "type",
+ "controller",
+ "action",
+ "enabled"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "controller": {
+ "type": "string"
+ },
+ "action": {
+ "type": "string"
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "policy": {
+ "type": "string"
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "users": {
+ "type": "array",
+ "items": {
+ "required": [
+ "id",
+ "username",
+ "email"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "password": {
+ "type": "string"
+ },
+ "resetPasswordToken": {
+ "type": "string"
+ },
+ "confirmationToken": {
+ "type": "string"
+ },
+ "confirmed": {
+ "type": "boolean"
+ },
+ "blocked": {
+ "type": "boolean"
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "NewUsersPermissionsRole": {
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "minLength": 3
+ },
+ "description": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "users": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "UsersPermissionsUser": {
+ "required": [
+ "id",
+ "username",
+ "email"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string",
+ "minLength": 3
+ },
+ "email": {
+ "type": "string",
+ "minLength": 6
+ },
+ "provider": {
+ "type": "string"
+ },
+ "confirmed": {
+ "type": "boolean",
+ "default": false
+ },
+ "blocked": {
+ "type": "boolean",
+ "default": false
+ },
+ "role": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "users": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "NewUsersPermissionsUser": {
+ "required": [
+ "username",
+ "email"
+ ],
+ "properties": {
+ "username": {
+ "type": "string",
+ "minLength": 3
+ },
+ "email": {
+ "type": "string",
+ "minLength": 6
+ },
+ "provider": {
+ "type": "string"
+ },
+ "password": {
+ "type": "string",
+ "format": "password",
+ "minLength": 6
+ },
+ "resetPasswordToken": {
+ "type": "string"
+ },
+ "confirmationToken": {
+ "type": "string"
+ },
+ "confirmed": {
+ "type": "boolean",
+ "default": false
+ },
+ "blocked": {
+ "type": "boolean",
+ "default": false
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_by": {
+ "type": "string"
+ },
+ "updated_by": {
+ "type": "string"
+ }
+ }
+ },
+ "Error": {
+ "required": [
+ "code",
+ "message"
+ ],
+ "properties": {
+ "code": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "securitySchemes": {
+ "bearerAuth": {
+ "type": "http",
+ "scheme": "bearer",
+ "bearerFormat": "JWT"
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Block"
+ },
+ {
+ "name": "Classroom"
+ },
+ {
+ "name": "Day"
+ },
+ {
+ "name": "Email"
+ },
+ {
+ "name": "Grade"
+ },
+ {
+ "name": "Mentor"
+ },
+ {
+ "name": "Sandbox"
+ },
+ {
+ "name": "Save"
+ },
+ {
+ "name": "School"
+ },
+ {
+ "name": "Selection"
+ },
+ {
+ "name": "Session"
+ },
+ {
+ "name": "Student"
+ },
+ {
+ "name": "Submission"
+ },
+ {
+ "name": "Unit"
+ },
+ {
+ "name": "Email - Email"
+ },
+ {
+ "name": "UsersPermissions - Role"
+ },
+ {
+ "name": "UsersPermissions - User"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/server/extensions/documentation/public/index.html b/server/extensions/documentation/public/index.html
new file mode 100644
index 00000000..02eb9307
--- /dev/null
+++ b/server/extensions/documentation/public/index.html
@@ -0,0 +1,57 @@
+