Giters

matheusfelipeog / beautiful-docs

Pointers to useful, well-written, and otherwise beautiful documentation.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Duplicate content on compile

opened this issue · comments

commented

version: 1.0.0
source file:

# Users

## /users [GET] 

### Params:

    _token // session token (required)
    _withCompany // join companies (optional)
    _withRole // join roles (optional)

### Response:
    [{Id: ...}]

### Errors:

    ERROR_NO_CONTENT // empty array response
    ERROR_AUTHORIZATION_FAILURE // access control error
    ERROR_OK // success

## /users/{id} [GET]

### Params:
    _token // session token (required)
    _withCompany // join companies (optional)
    _withRole // join roles (optional)

### Response:
    {Id: ...}

### Errors:
    ERROR_NOT_FOUND // record is deleted
    ERROR_AUTHORIZATION_FAILURE // access control error
    ERROR_OK // success

output

Users

/users [GET]

Params:
_token // session token (required)
_withCompany // join companies (optional)
_withRole // join roles (optional)
Response:
[{Id: ...}]
Errors:
ERROR_NO_CONTENT // empty array response
ERROR_AUTHORIZATION_FAILURE // access control error
ERROR_OK // success
/users/{id} [GET]

Params:
_token // session token (required)
_withCompany // join companies (optional)
_withRole // join roles (optional)
Response:
[{Id: ...}]
Errors:
ERROR_NO_CONTENT // empty array response
ERROR_AUTHORIZATION_FAILURE // access control error
ERROR_OK // success
/users/{id} [GET]

Params:
_token // session token (required)
_withCompany // join companies (optional)
_withRole // join roles (optional)
Response:
{Id: ...}
Errors:
ERROR_NOT_FOUND // record is deleted
ERROR_AUTHORIZATION_FAILURE // access control error
ERROR_OK // success

commented

This looks like it should have been filed against a different repo. Closing.