Skip to content

Instantly share code, notes, and snippets.

@danielsousaio

danielsousaio/doc.json

Created June 19, 2020 19:51
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save danielsousaio/34bd099105873cb7920ec5832e2deaa8 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save danielsousaio/34bd099105873cb7920ec5832e2deaa8 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
doc.json
{
"openapi": [
{
"openapi": "3.0.2",
"info": {
"title": "My componentlayout1_dev_6277 API",
"version": "",
"description": "API documentation for componentlayout1_dev_6277 App"
},
"paths": {
"/api/v1/customtext/": {
"get": {
"operationId": "listCustomTexts",
"description": "",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"title": {
"type": "string",
"maxLength": 150
},
"test3": {
"type": "string",
"nullable": true,
"maxLength": 256
}
},
"required": [
"title"
]
}
}
}
},
"description": ""
}
}
}
},
"/api/v1/customtext/{id}/": {
"get": {
"operationId": "retrieveCustomText",
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "A unique integer value identifying this custom text.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"title": {
"type": "string",
"maxLength": 150
},
"test3": {
"type": "string",
"nullable": true,
"maxLength": 256
}
},
"required": [
"title"
]
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "updateCustomText",
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "A unique integer value identifying this custom text.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"title": {
"type": "string",
"maxLength": 150
},
"test3": {
"type": "string",
"nullable": true,
"maxLength": 256
}
},
"required": [
"title"
]
}
},
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"title": {
"type": "string",
"maxLength": 150
},
"test3": {
"type": "string",
"nullable": true,
"maxLength": 256
}
},
"required": [
"title"
]
}
},
"multipart/form-data": {
"schema": {
"properties": {
"title": {
"type": "string",
"maxLength": 150
},
"test3": {
"type": "string",
"nullable": true,
"maxLength": 256
}
},
"required": [
"title"
]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"title": {
"type": "string",
"maxLength": 150
},
"test3": {
"type": "string",
"nullable": true,
"maxLength": 256
}
},
"required": [
"title"
]
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "partial_updateCustomText",
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "A unique integer value identifying this custom text.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"title": {
"type": "string",
"maxLength": 150
},
"test3": {
"type": "string",
"nullable": true,
"maxLength": 256
}
}
}
},
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"title": {
"type": "string",
"maxLength": 150
},
"test3": {
"type": "string",
"nullable": true,
"maxLength": 256
}
}
}
},
"multipart/form-data": {
"schema": {
"properties": {
"title": {
"type": "string",
"maxLength": 150
},
"test3": {
"type": "string",
"nullable": true,
"maxLength": 256
}
}
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"title": {
"type": "string",
"maxLength": 150
},
"test3": {
"type": "string",
"nullable": true,
"maxLength": 256
}
},
"required": [
"title"
]
}
}
},
"description": ""
}
}
}
},
"/api/v1/homepage/": {
"get": {
"operationId": "listHomePages",
"description": "",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"body": {
"type": "string"
}
},
"required": [
"body"
]
}
}
}
},
"description": ""
}
}
}
},
"/api/v1/homepage/{id}/": {
"get": {
"operationId": "retrieveHomePage",
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "A unique integer value identifying this home page.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"body": {
"type": "string"
}
},
"required": [
"body"
]
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "updateHomePage",
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "A unique integer value identifying this home page.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"type": "string"
}
},
"required": [
"body"
]
}
},
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"body": {
"type": "string"
}
},
"required": [
"body"
]
}
},
"multipart/form-data": {
"schema": {
"properties": {
"body": {
"type": "string"
}
},
"required": [
"body"
]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"body": {
"type": "string"
}
},
"required": [
"body"
]
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "partial_updateHomePage",
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "A unique integer value identifying this home page.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"type": "string"
}
}
}
},
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"body": {
"type": "string"
}
}
}
},
"multipart/form-data": {
"schema": {
"properties": {
"body": {
"type": "string"
}
}
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"body": {
"type": "string"
}
},
"required": [
"body"
]
}
}
},
"description": ""
}
}
}
},
"/rest-auth/logout/": {
"get": {
"operationId": "listLogouts",
"description": "Calls Django logout method and delete the Token object\nassigned to the current User object.\n\nAccepts/Returns nothing.",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "CreateLogout",
"description": "Calls Django logout method and delete the Token object\nassigned to the current User object.\n\nAccepts/Returns nothing.",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": ""
}
}
}
},
"/rest-auth/user/": {
"get": {
"operationId": "RetrieveUserDetails",
"description": "Reads and updates UserModel fields\nAccepts GET, PUT, PATCH methods.\n\nDefault accepted fields: username, first_name, last_name\nDefault display fields: pk, username, email, first_name, last_name\nRead-only fields: pk, email\n\nReturns UserModel fields.",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"pk": {
"type": "integer",
"readOnly": true
},
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"email": {
"type": "string",
"format": "email",
"readOnly": true
},
"first_name": {
"type": "string",
"maxLength": 30
},
"last_name": {
"type": "string",
"maxLength": 150
}
},
"required": [
"username"
]
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "UpdateUserDetails",
"description": "Reads and updates UserModel fields\nAccepts GET, PUT, PATCH methods.\n\nDefault accepted fields: username, first_name, last_name\nDefault display fields: pk, username, email, first_name, last_name\nRead-only fields: pk, email\n\nReturns UserModel fields.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"first_name": {
"type": "string",
"maxLength": 30
},
"last_name": {
"type": "string",
"maxLength": 150
}
},
"required": [
"username"
]
}
},
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"first_name": {
"type": "string",
"maxLength": 30
},
"last_name": {
"type": "string",
"maxLength": 150
}
},
"required": [
"username"
]
}
},
"multipart/form-data": {
"schema": {
"properties": {
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"first_name": {
"type": "string",
"maxLength": 30
},
"last_name": {
"type": "string",
"maxLength": 150
}
},
"required": [
"username"
]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"pk": {
"type": "integer",
"readOnly": true
},
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"email": {
"type": "string",
"format": "email",
"readOnly": true
},
"first_name": {
"type": "string",
"maxLength": 30
},
"last_name": {
"type": "string",
"maxLength": 150
}
},
"required": [
"username"
]
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "PartialUpdateUserDetails",
"description": "Reads and updates UserModel fields\nAccepts GET, PUT, PATCH methods.\n\nDefault accepted fields: username, first_name, last_name\nDefault display fields: pk, username, email, first_name, last_name\nRead-only fields: pk, email\n\nReturns UserModel fields.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"first_name": {
"type": "string",
"maxLength": 30
},
"last_name": {
"type": "string",
"maxLength": 150
}
}
}
},
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"first_name": {
"type": "string",
"maxLength": 30
},
"last_name": {
"type": "string",
"maxLength": 150
}
}
}
},
"multipart/form-data": {
"schema": {
"properties": {
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"first_name": {
"type": "string",
"maxLength": 30
},
"last_name": {
"type": "string",
"maxLength": 150
}
}
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"pk": {
"type": "integer",
"readOnly": true
},
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"email": {
"type": "string",
"format": "email",
"readOnly": true
},
"first_name": {
"type": "string",
"maxLength": 30
},
"last_name": {
"type": "string",
"maxLength": 150
}
},
"required": [
"username"
]
}
}
},
"description": ""
}
}
}
},
"/api/v1/signup/": {
"post": {
"operationId": "createSignup",
"description": "",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 255
},
"email": {
"type": "string",
"format": "email",
"maxLength": 254
},
"password": {
"type": "string",
"writeOnly": true,
"maxLength": 128
}
},
"required": [
"email",
"password"
]
}
},
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 255
},
"email": {
"type": "string",
"format": "email",
"maxLength": 254
},
"password": {
"type": "string",
"writeOnly": true,
"maxLength": 128
}
},
"required": [
"email",
"password"
]
}
},
"multipart/form-data": {
"schema": {
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 255
},
"email": {
"type": "string",
"format": "email",
"maxLength": 254
},
"password": {
"type": "string",
"writeOnly": true,
"maxLength": 128
}
},
"required": [
"email",
"password"
]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 255
},
"email": {
"type": "string",
"format": "email",
"maxLength": 254
}
},
"required": [
"email"
]
}
}
},
"description": ""
}
}
}
},
"/api/v1/login/": {
"post": {
"operationId": "createLoginViewSet",
"description": "Based on rest_framework.authtoken.views.ObtainAuthToken",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": ""
}
}
}
},
"/rest-auth/password/reset/": {
"post": {
"operationId": "CreatePassword",
"description": "Calls Django Auth PasswordResetForm save method.\n\nAccepts the following POST parameters: email\nReturns the success/fail message.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"email": {
"type": "string",
"format": "email"
}
},
"required": [
"email"
]
}
},
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"email": {
"type": "string",
"format": "email"
}
},
"required": [
"email"
]
}
},
"multipart/form-data": {
"schema": {
"properties": {
"email": {
"type": "string",
"format": "email"
}
},
"required": [
"email"
]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"email": {
"type": "string",
"format": "email"
}
},
"required": [
"email"
]
}
}
},
"description": ""
}
}
}
},
"/rest-auth/password/reset/confirm/": {
"post": {
"operationId": "CreatePasswordResetConfirm",
"description": "Password reset e-mail link is confirmed, therefore\nthis resets the user's password.\n\nAccepts the following POST parameters: token, uid,\n new_password1, new_password2\nReturns the success/fail message.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"new_password1": {
"type": "string",
"maxLength": 128
},
"new_password2": {
"type": "string",
"maxLength": 128
},
"uid": {
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"new_password1",
"new_password2",
"uid",
"token"
]
}
},
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"new_password1": {
"type": "string",
"maxLength": 128
},
"new_password2": {
"type": "string",
"maxLength": 128
},
"uid": {
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"new_password1",
"new_password2",
"uid",
"token"
]
}
},
"multipart/form-data": {
"schema": {
"properties": {
"new_password1": {
"type": "string",
"maxLength": 128
},
"new_password2": {
"type": "string",
"maxLength": 128
},
"uid": {
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"new_password1",
"new_password2",
"uid",
"token"
]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"new_password1": {
"type": "string",
"maxLength": 128
},
"new_password2": {
"type": "string",
"maxLength": 128
},
"uid": {
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"new_password1",
"new_password2",
"uid",
"token"
]
}
}
},
"description": ""
}
}
}
},
"/rest-auth/login/": {
"post": {
"operationId": "CreateLogin",
"description": "Check the credentials and return the REST Token\nif the credentials are valid and authenticated.\nCalls Django Auth login method to register User ID\nin Django session framework\n\nAccept the following POST parameters: username, password\nReturn the REST Framework Token Object's key.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"username": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"password": {
"type": "string"
}
},
"required": [
"password"
]
}
},
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"username": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"password": {
"type": "string"
}
},
"required": [
"password"
]
}
},
"multipart/form-data": {
"schema": {
"properties": {
"username": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"password": {
"type": "string"
}
},
"required": [
"password"
]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"username": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"password": {
"type": "string"
}
},
"required": [
"password"
]
}
}
},
"description": ""
}
}
}
},
"/rest-auth/password/change/": {
"post": {
"operationId": "CreatePasswordChange",
"description": "Calls Django Auth SetPasswordForm save method.\n\nAccepts the following POST parameters: new_password1, new_password2\nReturns the success/fail message.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"new_password1": {
"type": "string",
"maxLength": 128
},
"new_password2": {
"type": "string",
"maxLength": 128
}
},
"required": [
"new_password1",
"new_password2"
]
}
},
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"new_password1": {
"type": "string",
"maxLength": 128
},
"new_password2": {
"type": "string",
"maxLength": 128
}
},
"required": [
"new_password1",
"new_password2"
]
}
},
"multipart/form-data": {
"schema": {
"properties": {
"new_password1": {
"type": "string",
"maxLength": 128
},
"new_password2": {
"type": "string",
"maxLength": 128
}
},
"required": [
"new_password1",
"new_password2"
]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"new_password1": {
"type": "string",
"maxLength": 128
},
"new_password2": {
"type": "string",
"maxLength": 128
}
},
"required": [
"new_password1",
"new_password2"
]
}
}
},
"description": ""
}
}
}
},
"/rest-auth/registration/": {
"post": {
"operationId": "CreateSignup",
"description": "",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 255
},
"email": {
"type": "string",
"format": "email",
"maxLength": 254
},
"password": {
"type": "string",
"writeOnly": true,
"maxLength": 128
}
},
"required": [
"email",
"password"
]
}
},
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 255
},
"email": {
"type": "string",
"format": "email",
"maxLength": 254
},
"password": {
"type": "string",
"writeOnly": true,
"maxLength": 128
}
},
"required": [
"email",
"password"
]
}
},
"multipart/form-data": {
"schema": {
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 255
},
"email": {
"type": "string",
"format": "email",
"maxLength": 254
},
"password": {
"type": "string",
"writeOnly": true,
"maxLength": 128
}
},
"required": [
"email",
"password"
]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 255
},
"email": {
"type": "string",
"format": "email",
"maxLength": 254
}
},
"required": [
"email"
]
}
}
},
"description": ""
}
}
}
},
"/rest-auth/registration/verify-email/": {
"post": {
"operationId": "CreateVerifyEmail",
"description": "",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"key": {
"type": "string"
}
},
"required": [
"key"
]
}
},
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"key": {
"type": "string"
}
},
"required": [
"key"
]
}
},
"multipart/form-data": {
"schema": {
"properties": {
"key": {
"type": "string"
}
},
"required": [
"key"
]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"key": {
"type": "string"
}
},
"required": [
"key"
]
}
}
},
"description": ""
}
}
}
}
}
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment