---
# System prepended metadata

title: 'Title of the package, Class or API'

---

# Title of the package, Class or API

What this package provides in one sentence. 
project_tag

**Quip overview document**: 
Quip link to the Capi's Development relevant overview document[s]

**Status**: In Progress/Active/Archived (with the reason)

## Contains
List with links of Classes, Resource model, etc.
 - [Class1](#Usage-ClassResource)
 - [Resource model1](#Usage-ClassResource)

## Usage Class/Resource model
List with links of methods/endpoints.

Example:
 - [Method1([options], [ttls])](#Method1options-ttls)
 - [Endpoint1([options], [ttls])](#GET-userparam)
 
### Method1(option, [optionOpt])
One line description.

| Param | Type | Default | Description |
| -------- | -------- | -------- | -------- |
| option     | `string`     |   `"''"`   | Required example |
| [optionOpt]     | `string`     |   `"''"`   | Optional example  |
**Returns:** `object`
**Example:**
```
Usage examples
```

### GET /user/:param
One line description.

| Param    | Type     | Default  | Required |
| -------- | -------- | -------- | -------- |
| param    | `type`   |          |  Y       |

**Success 200**
| Field    | Type     | Description |
| -------- | -------- |  --------   |
| id       | `int`    |             |
| name     | `string` |             |
| email    | `string` |             |


**Error 4xx**
| Field    | Type     | Default | Description |
| -------- | -------- | --------| --------    |
| error    | `string` |         |             |

**Example:**

Request:
```
curl -i http://localhost/user/1
```
Success:
```
HTTP/1.1 200 OK
{
  "id": 1,
  "name": "foo",
  "email": "b@a.r",
  
}
```
Error:
```
HTTP/1.1 401 Not Authenticated
{
  "error": "NoAccessRight"
}
```    


## Tests
See Solo project or tool Template

## Troubleshooting  & FAQ
See Solo project or tool Template

## Known issues
See Solo project or tool Template

## TODOs
See Solo project or tool Template

## Built With
See Solo project or tool Template


Help us to improve this project!

#### Updated 05.09.2019