Demo Documentation

Theneo APIs enable you to generate beautiful API documentations effortlessly. Why should only top companies like Stripe, Square, and Twilio have gorgeous documentations? With Theneo you can also generate API documents that you could be proud of. The Theneo API follows the general patterns of REST Please note: All the endpoints and API references discussed here are just for demo purposes, they are not functional

This is the documentation for version 1.0.0 of the API.

Servers:

https://app.theneo.io - Theneo Sample API

By passing in the appropriate options, you can search for
available API documentations

Title	Required?	Type	Description	Min Length	Max Length
searchString	false	STRING	pass an optional search string for looking up inventory
numberofDocs	false	INTEGER (int32)	number of documentations to return
category	false	STRING	category of documentations to return
sortBy	false	STRING	Allowed: dateUpdated, dateAdded.
sortOrder	false	STRING	Allowed: asc, desc. asc is ascending and sorts from A to Z. desc is descending and sorts from Z to A.

Header Parameters

Content-Typestring

Query Parameters

searchStringstring

pass an optional search string for looking up inventory

numberofDocsinteger

number of documentations to return

categorystring

category of documentations to return

sortBystring

Allowed: dateUpdated, dateAdded.

sortOrderstring

Allowed: asc, desc. asc is ascending and sorts from A to Z. desc is descending and sorts from Z to A.

Response

200

Object

Response Attributes

idstring

documentationstring

keystring

categorystring

dateAddedstring

1
2

curl --location 'https://app.theneo.io/documentation?searchString=string&numberofDocs=integer&category=string&sortBy=string&sortOrder=string' \
--header 'Content-Type: application/json'

[
  {
    "id": "demo",
    "documentation": "Theneo Sample API Doc",
    "key": "demo",
    "category": "OpenAPI",
    "dateAdded": "2016-08-29T09:12:33.001Z"
  }
]

to the system

Title	Required?	Type	Description	Min Length	Max Length
documentation	true	string	The title of the documentation
key	true	string	Unique Id of of the documentation
category	false	string	category of the documentation (allowed categories TBD)

Header Parameters

Content-Typestring

Body Parameters

documentationstring Required

The title of the documentation

keystring Required

Unique Id of of the documentation

categorystring

category of the documentation (allowed categories TBD)

Response

200

Object

item created

Response Attributes

idstring

documentationstring

keystring

categorystring

dateAddedstring

curl --location 'https://app.theneo.io/documentation' \
--header 'Content-Type: application/json' \
--data '{
  "documentation": "Theneo Sample API Doc",
  "key": "demo",
  "category": "knockKnock"
}'

{
  "id": "demo",
  "documentation": "Theneo Sample API Doc",
  "key": "demo",
  "category": "OpenAPI",
  "dateAdded": "2016-08-29T09:12:33.001Z"
}

Delete the API Doc from the system

Title	Required?	Type	Description	Min Length	Max Length
id	false	STRING	The documentation ID for the documentation you want to delete

Header Parameters

Content-Typestring

Path Parameters

idstring

The documentation ID for the documentation you want to delete

1
2

curl --location --request DELETE 'https://app.theneo.io/documentation/string' \
--header 'Content-Type: application/json'

Update the API documentation details

Title	Required?	Type	Description	Min Length	Max Length
id	false	STRING	The documentation ID for the documentation you want to update

Header Parameters

Content-Typestring

Path Parameters

idstring

The documentation ID for the documentation you want to update

Response

200

Object

Documentation was successfully updated

Response Attributes

keystring

1
2

curl --location --request PUT 'https://app.theneo.io/doumentation/string' \
--header 'Content-Type: application/json'

{
  "key": "demo"
}

Title	Required?	Type	Description	Min Length	Max Length
documentatId	false	string	Unique ID of the document
useremail	true	string	User email that you want to add to the project
permission	false	string	What type of permission you would like to give it to them? Editor or Viewer

Header Parameters

Content-Typestring

Body Parameters

documentatIdstring

Unique ID of the document

useremailstring Required

User email that you want to add to the project

permissionstring

What type of permission you would like to give it to them? Editor or Viewer

Response

200

Object

Response Attributes

idstring

documentationstring

keystring

categorystring

dateAddedstring

curl --location 'https://app.theneo.io/doumentation/invitatation' \
--header 'Content-Type: application/json' \
--data-raw '{
  "documentatId": "theneo-demo",
  "useremail": "arobakid@theneo.io",
  "permission": "editor"
}'

{
  "id": "demo",
  "documentation": "Theneo Sample API Doc",
  "key": "demo",
  "category": "OpenAPI",
  "dateAdded": "2016-08-29T09:12:33.001Z"
}

Sections

Theneo Sample OpenAPI Doc

What made this section unhelpful for you?

Language Box

cURL

Ruby

Python

PHP

Java

Node.js

Go

.NET

What made this section unhelpful for you?

Retrieves documentations

Header Parameters

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Adds a documentation

Header Parameters

Body Parameters

Response

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Deletes an API Doc

Header Parameters

Path Parameters

What made this section unhelpful for you?

What made this section unhelpful for you?

Updates the API Doc

Header Parameters

Path Parameters

Response

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Invite users to the document

Header Parameters

Body Parameters

Response

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Response