570
94%

Ran 23 Nov 2018 02:18PM UTC

Jobs 3

Files 77

Run time 1min

Badge

Embed ▾

pending completion

Build # 570

Build Type

push

travis-ci

Committed by

web-flow

Commit Message

Update online documentation, remove outdated docs (#323)

- Removed outdated developer and admin documentation.
- Moved documents such as the Cheatsheet or the OAuth user guide into the
  online docs, which are now the 'single source of truth' for users.
- Extended the Cheatsheet to cover sending data with multipart/form-data
- Added general introductions to REST and API auth.
- In the online docs, added support for:
  - Query parameters.
  - Authorization header.
  - Additional lookup path for GET.
  - Error Responses.
- Hooks are not displayed anymore, as they are only relevant for API developers
  and not for users.
- Updates ReDoc to version 2.

Regarding the documentation updates, I briefly considered putting them into
a pull request to Eve-Swagger. However, development on Eve-Swagger seems stale,
with two open pull requests without response. Furthermore, most additions
include AMIV API specific detail (e.g. a link to the cheatsheet), so I opted
for a API specific solution instead.

Run Details

3607 of 3822 relevant lines covered (94.37%)

1.89 hits per line

Jobs

ID	Job ID	Ran	Coverage
1	570.1 (TOXENV=py35)	23 Nov 2018 02:19PM UTC	94.37	Travis Job 570.1
2	570.2 (TOXENV=py36)	23 Nov 2018 02:19PM UTC	94.14	Travis Job 570.2
3	570.3 (TOXENV=flake8)	23 Nov 2018 02:18PM UTC		Travis Job 570.3

Source Files on build 570

Detailed source file information is not available for this build.

amiv-eth / amivapi / 570
94%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 570

amiv-eth / amivapi / 570 94%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 570

amiv-eth / amivapi / 570
94%

README BADGES
x