Skip to content

Documentation

Jump to bottom
Bo Motlagh edited this page Mar 4, 2017 · 2 revisions

UE Content Service

The Content Service allows you to store and retrieve organized frontend content as text or html.

Version: 1.0.0

Security

api_key

type bearer
Name authentication
In header

/health

GET

Summary: Health check

Description: Health check

Responses

Code Description Schema
200 GET successful success
401 Unauthorized defaultError
500 Internal server error defaultError

/health/admin

GET

Summary: Health check

Description: Health check

Responses

Code Description Schema
200 GET successful success
401 Unauthorized defaultError
500 Internal server error defaultError

/content

POST

Summary: ADMIN - Add a new content entry

Description: ADMIN - Add a new content entry

Parameters

Name Located in Description Required Schema
new content body new content to be added Yes contentObject

Responses

Code Description Schema
200 Save successful success
401 Unauthorized defaultError
500 Internal server error defaultError
GET

Summary: Get All content entrys

Description: Get All content entrys

Parameters

Name Located in Description Required Schema
tag query optional filter on tag value No string

Responses

Code Description Schema
200 GET successful success
401 Unauthorized defaultError
500 Internal server error defaultError

/content/{slug}

GET

Summary: Get a content entry by slug

Description: Get a content entry by slug

Parameters

Name Located in Description Required Schema
slug path slug of content to retrieve Yes string

Responses

Code Description Schema
200 GET successful success
401 Unauthorized defaultError
500 Internal server error defaultError

/content/{id}

GET

Summary: Get a content entry

Description: Get a content entry

Parameters

Name Located in Description Required Schema
id path Id of content to retrieve Yes string

Responses

Code Description Schema
200 GET successful success
401 Unauthorized defaultError
500 Internal server error defaultError
PATCH

Summary: ADMIN - Edit a content entry

Description: ADMIN - Edit a content entry

Parameters

Name Located in Description Required Schema
Edit content body updates to content. Any of the following. Yes contentPatchObject
id path Id of content to retrieve Yes string

Responses

Code Description Schema
200 Save successful success
401 Unauthorized defaultError
500 Internal server error defaultError
DELETE

Summary: ADMIN - Delete a content entry (hard delete)

Description: ADMIN - Delete a content (hard delete)

Parameters

Name Located in Description Required Schema
id path Id of content to delete Yes string

Responses

Code Description Schema
200 GET successful success
401 Unauthorized defaultError
500 Internal server error defaultError

/content/{id}/category

PUT

Summary: ADMIN - add a category to a content entry

Description: ADMIN - add a category to a content entry

Parameters

Name Located in Description Required Schema
id path Id of content to retrieve Yes string
Edit content body updates to content. Any of the following. Yes categoryAddObject

Responses

Code Description Schema
200 Save successful success
401 Unauthorized defaultError
500 Internal server error defaultError

/content/{id}/category/{name}

PATCH

Summary: ADMIN - remove a category to a content entry

Description: ADMIN - remove a category to a content entry

Parameters

Name Located in Description Required Schema
id path Id of content entry to retrieve Yes string
name path Name of the category to remove from issue Yes string

Responses

Code Description Schema
200 Save successful success
401 Unauthorized defaultError
500 Internal server error defaultError

/content/{id}/categories

GET

Summary: Get a content entry categories

Description: Get a content entry categories

Parameters

Name Located in Description Required Schema
id path Id of content entry categories to retrieve Yes string

Responses

Code Description Schema
200 GET successful success
401 Unauthorized defaultError
500 Internal server error defaultError

/content/category/{name}

GET

Summary: Get content entrys by category

Description: Get content entrys by category

Parameters

Name Located in Description Required Schema
name path name of category to filter Yes string

Responses

Code Description Schema
200 GET successful success
401 Unauthorized defaultError
500 Internal server error defaultError

/search

GET

Summary: Search for content

Description: Search for content

Parameters

Name Located in Description Required Schema
q query String to define what you are looking for Yes string
active query Whether or not you want active or inactive records returned No boolean

Responses

Code Description Schema
200 GET successful success
401 Unauthorized defaultError
500 Internal server error defaultError

/categories/search

GET

Summary: Search for categories

Description: Search for categories

Parameters

Name Located in Description Required Schema
q query String to define what you are looking for Yes string

Responses

Code Description Schema
200 GET successful success
401 Unauthorized defaultError
500 Internal server error defaultError

/category

POST

Summary: ADMIN - Add a new category

Description: ADMIN - Add a new category

Parameters

Name Located in Description Required Schema
new content body new category to be added Yes categoryObject

Responses

Code Description Schema
200 Save successful success
401 Unauthorized defaultError
500 Internal server error defaultError

/categories

GET

Summary: Get All categories

Description: Get All categories

Responses

Code Description Schema
200 GET successful success
401 Unauthorized defaultError
500 Internal server error defaultError

/category/{id}

GET

Summary: Get a category

Description: Get a category

Parameters

Name Located in Description Required Schema
id path Id of category to retrieve Yes string

Responses

Code Description Schema
200 GET successful success
401 Unauthorized defaultError
500 Internal server error defaultError
DELETE

Summary: ADMIN - Delete a category (hard delete)

Description: ADMIN - Delete a category (hard delete)

Parameters

Name Located in Description Required Schema
id path Id of category to delete Yes string

Responses

Code Description Schema
200 GET successful success
401 Unauthorized defaultError
500 Internal server error defaultError

/category/name/{name}

GET

Summary: Get a category by name

Description: Get a category by name

Parameters

Name Located in Description Required Schema
name path name of category to retrieve Yes string

Responses

Code Description Schema
200 GET successful success
401 Unauthorized defaultError
500 Internal server error defaultError

Models

success

Name Type Description Required
err string Yes
data object Yes
defaultError
Name Type Description Required
err integer Yes
data string Yes
contentPatchObject
Name Type Description Required
title string No
content string No
slug string No
path string No
tag string No
publish boolean No
active boolean No
internal_description string No
contentObject
Name Type Description Required
title string No
content string No
slug string No
path string No
tag string No
internal_description string No
categoryObject
Name Type Description Required
name string No
description string No
categoryAddObject
Name Type Description Required
name string No
Clone this wiki locally