Tasks API

# Install the command line client
$ pip install coreapi-cli

# Install the Python client library
$ pip install coreapi

tasks

list

GET /tasks/api/v1/tasks/

# Load the schema document
$ coreapi get https://django-crud-react.onrender.com/tasks/docs/

# Interact with the API endpoint
$ coreapi action tasks list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["tasks", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://django-crud-react.onrender.com/tasks/docs/")

# Interact with the API endpoint
action = ["tasks", "list"]
result = client.action(schema, action)

create

POST /tasks/api/v1/tasks/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`title` required
`description`
`completed`

# Load the schema document
$ coreapi get https://django-crud-react.onrender.com/tasks/docs/

# Interact with the API endpoint
$ coreapi action tasks create -p title=... -p description=... -p completed=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["tasks", "create"]
var params = {
    title: ...,
    description: ...,
    completed: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://django-crud-react.onrender.com/tasks/docs/")

# Interact with the API endpoint
action = ["tasks", "create"]
params = {
    "title": ...,
    "description": ...,
    "completed": ...,
}
result = client.action(schema, action, params=params)

read

GET /tasks/api/v1/tasks/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this task.

# Load the schema document
$ coreapi get https://django-crud-react.onrender.com/tasks/docs/

# Interact with the API endpoint
$ coreapi action tasks read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["tasks", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://django-crud-react.onrender.com/tasks/docs/")

# Interact with the API endpoint
action = ["tasks", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /tasks/api/v1/tasks/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this task.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`title` required
`description`
`completed`

# Load the schema document
$ coreapi get https://django-crud-react.onrender.com/tasks/docs/

# Interact with the API endpoint
$ coreapi action tasks update -p id=... -p title=... -p description=... -p completed=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["tasks", "update"]
var params = {
    id: ...,
    title: ...,
    description: ...,
    completed: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://django-crud-react.onrender.com/tasks/docs/")

# Interact with the API endpoint
action = ["tasks", "update"]
params = {
    "id": ...,
    "title": ...,
    "description": ...,
    "completed": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /tasks/api/v1/tasks/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this task.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`title`
`description`
`completed`

# Load the schema document
$ coreapi get https://django-crud-react.onrender.com/tasks/docs/

# Interact with the API endpoint
$ coreapi action tasks partial_update -p id=... -p title=... -p description=... -p completed=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["tasks", "partial_update"]
var params = {
    id: ...,
    title: ...,
    description: ...,
    completed: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://django-crud-react.onrender.com/tasks/docs/")

# Interact with the API endpoint
action = ["tasks", "partial_update"]
params = {
    "id": ...,
    "title": ...,
    "description": ...,
    "completed": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /tasks/api/v1/tasks/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this task.

# Load the schema document
$ coreapi get https://django-crud-react.onrender.com/tasks/docs/

# Interact with the API endpoint
$ coreapi action tasks delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["tasks", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://django-crud-react.onrender.com/tasks/docs/")

# Interact with the API endpoint
action = ["tasks", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)