{ "paths": { "/articles": { "get": { "deprecated": false, "description": "Find all the articles's records", "responses": { "200": { "description": "Retrieve articles document(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Articles" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "summary": "", "tags": [ "Articles" ], "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" }, "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" }, "deprecated": false } ] }, "post": { "deprecated": false, "description": "Create a new articles record", "responses": { "200": { "description": "Retrieve articles document(s)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Articles" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "summary": "", "tags": [ "Articles" ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewArticles" } } } } } }, "/articles/count": { "get": { "deprecated": false, "description": "Retrieve the numver of articles documents", "responses": { "200": { "description": "Retrieve articles document(s)", "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": [ "Articles" ], "parameters": [] } }, "/articles/{id}": { "get": { "deprecated": false, "description": "Find one articles record", "responses": { "200": { "description": "Retrieve articles document(s)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Articles" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "summary": "", "tags": [ "Articles" ], "parameters": [ { "name": "id", "in": "path", "description": "", "deprecated": false, "required": true, "schema": { "type": "string" } } ] }, "put": { "deprecated": false, "description": "Update a single articles record", "responses": { "200": { "description": "Retrieve articles document(s)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Articles" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "summary": "", "tags": [ "Articles" ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewArticles" } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "deprecated": false, "required": true, "schema": { "type": "string" } } ] }, "delete": { "deprecated": false, "description": "Delete a single articles record", "responses": { "200": { "description": "deletes a single articles 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": [ "Articles" ], "parameters": [ { "name": "id", "in": "path", "description": "", "deprecated": false, "required": true, "schema": { "type": "string" } } ] } } }, "components": { "schemas": { "Articles": { "required": [ "id", "content" ], "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "content2": { "type": "string" }, "bro": { "required": [ "id", "content" ], "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "content2": { "type": "string" }, "bro": { "type": "string" }, "bra": { "type": "string" }, "siblingArticles": { "type": "array", "items": { "type": "string" } }, "articles": { "type": "array", "items": { "type": "string" } }, "deluxeSiblingArticles": { "type": "array", "items": { "type": "string" } }, "deluxeArticles": { "type": "array", "items": { "type": "string" } }, "posts": { "type": "array", "items": { "type": "string" } } } }, "bra": { "required": [ "id", "content" ], "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "content2": { "type": "string" }, "bro": { "type": "string" }, "bra": { "type": "string" }, "siblingArticles": { "type": "array", "items": { "type": "string" } }, "articles": { "type": "array", "items": { "type": "string" } }, "deluxeSiblingArticles": { "type": "array", "items": { "type": "string" } }, "deluxeArticles": { "type": "array", "items": { "type": "string" } }, "posts": { "type": "array", "items": { "type": "string" } } } }, "siblingArticles": { "type": "array", "items": { "required": [ "id", "content" ], "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "content2": { "type": "string" }, "bro": { "type": "string" }, "bra": { "type": "string" }, "siblingArticles": { "type": "array", "items": { "type": "string" } }, "articles": { "type": "array", "items": { "type": "string" } }, "deluxeSiblingArticles": { "type": "array", "items": { "type": "string" } }, "deluxeArticles": { "type": "array", "items": { "type": "string" } }, "posts": { "type": "array", "items": { "type": "string" } } } } }, "articles": { "type": "array", "items": { "required": [ "id", "content" ], "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "content2": { "type": "string" }, "bro": { "type": "string" }, "bra": { "type": "string" }, "siblingArticles": { "type": "array", "items": { "type": "string" } }, "articles": { "type": "array", "items": { "type": "string" } }, "deluxeSiblingArticles": { "type": "array", "items": { "type": "string" } }, "deluxeArticles": { "type": "array", "items": { "type": "string" } }, "posts": { "type": "array", "items": { "type": "string" } } } } }, "deluxeSiblingArticles": { "type": "array", "items": { "required": [ "id", "content" ], "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "content2": { "type": "string" }, "bro": { "type": "string" }, "bra": { "type": "string" }, "siblingArticles": { "type": "array", "items": { "type": "string" } }, "articles": { "type": "array", "items": { "type": "string" } }, "deluxeSiblingArticles": { "type": "array", "items": { "type": "string" } }, "deluxeArticles": { "type": "array", "items": { "type": "string" } }, "posts": { "type": "array", "items": { "type": "string" } } } } }, "deluxeArticles": { "type": "array", "items": { "required": [ "id", "content" ], "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "content2": { "type": "string" }, "bro": { "type": "string" }, "bra": { "type": "string" }, "siblingArticles": { "type": "array", "items": { "type": "string" } }, "articles": { "type": "array", "items": { "type": "string" } }, "deluxeSiblingArticles": { "type": "array", "items": { "type": "string" } }, "deluxeArticles": { "type": "array", "items": { "type": "string" } }, "posts": { "type": "array", "items": { "type": "string" } } } } }, "posts": { "type": "array", "items": { "required": [ "id" ], "properties": { "id": { "type": "string" }, "articles": { "type": "array", "items": { "type": "string" } } } } } } }, "NewArticles": { "required": [ "content" ], "properties": { "content": { "type": "string" }, "content2": { "type": "string" }, "bro": { "type": "string" }, "bra": { "type": "string" }, "siblingArticles": { "type": "array", "items": { "type": "string" } }, "articles": { "type": "array", "items": { "type": "string" } }, "deluxeSiblingArticles": { "type": "array", "items": { "type": "string" } }, "deluxeArticles": { "type": "array", "items": { "type": "string" } }, "posts": { "type": "array", "items": { "type": "string" } } } } } }, "tags": [ { "name": "Articles" } ] }