cadey
/
ponyapi
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

build status

This commit is contained in:
Cadey Ratio 2016-07-15 14:16:35 -07:00
parent 4685252143
commit c27a7e6d5f
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,6 +1,8 @@
PonyAPI PonyAPI
======= =======
[![Build Status](http://drone.greedo.xeserv.us/api/badges/xena/PonyAPI/status.svg)](http://drone.greedo.xeserv.us/xena/PonyAPI)
A simple API for episodes of My Little Pony: Friendship is Magic to be run A simple API for episodes of My Little Pony: Friendship is Magic to be run
inside a container. inside a container.
@ -40,9 +42,9 @@ Clients
Routes Routes
------ ------
The canonical route base for PonyAPI is `https://ponyapi.apps.xeserv.us`. This The canonical route base for PonyAPI is `https://ponyapi.apps.xeserv.us`. This
now supports HTTP/2.0 using [Caddy](https://caddyserver.com) and SSL using now supports HTTP/2.0 using [Caddy](https://caddyserver.com) and SSL using
[Let's Encrypt](https://letsencrypt.org/). If you get SSL errors, please be [Let's Encrypt](https://letsencrypt.org/). If you get SSL errors, please be
sure your system certificate lists are up to date. sure your system certificate lists are up to date.
Example usage: Example usage:
@ -63,10 +65,10 @@ Bare Replies
------------ ------------
As of [882b5b1](https://github.com/Xe/PonyAPI/commit/882b5b155157d3a3c9e329fffcf7ff3fdf64d4ee), As of [882b5b1](https://github.com/Xe/PonyAPI/commit/882b5b155157d3a3c9e329fffcf7ff3fdf64d4ee),
PonyAPI will accept an `X-API-Options` header that when set to `bare` will PonyAPI will accept an `X-API-Options` header that when set to `bare` will
return the API replies without the `episode` or `episodes` header. return the API replies without the `episode` or `episodes` header.
Functionality is otherwise unchanged, however an error will still be shown if Functionality is otherwise unchanged, however an error will still be shown if
something goes wrong, and that will parse differently. This API will return something goes wrong, and that will parse differently. This API will return
`200` if and **only** if everything went to plan. `200` if and **only** if everything went to plan.
An example: An example: