diff --git a/exampleSite/content/kittens-specific.md b/exampleSite/content/kittens-specific.md new file mode 100644 index 0000000..1143cc5 --- /dev/null +++ b/exampleSite/content/kittens-specific.md @@ -0,0 +1,71 @@ +--- +weight: 12 +title: Get a Specific Kitten +--- + +## Get a Specific Kitten + +```go +package main + +import "github.com/bep/kittn/auth" + +func main() { + api := auth.Authorize("meowmeowmeow") + + _ = api.GetKitten(2) +} +``` + +```ruby +require 'kittn' + +api = Kittn::APIClient.authorize!('meowmeowmeow') +api.kittens.get(2) +``` + +```python +import kittn + +api = kittn.authorize('meowmeowmeow') +api.kittens.get(2) +``` + +```shell +curl "http://example.com/api/kittens/2" + -H "Authorization: meowmeowmeow" +``` + +```javascript +const kittn = require('kittn'); + +let api = kittn.authorize('meowmeowmeow'); +let max = api.kittens.get(2); +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": 2, + "name": "Max", + "breed": "unknown", + "fluffiness": 5, + "cuteness": 10 +} +``` + +This endpoint retrieves a specific kitten. + + + +### HTTP Request + +`GET http://example.com/kittens/` + +### URL Parameters + +Parameter | Description +--------- | ----------- +ID | The ID of the kitten to retrieve + diff --git a/exampleSite/content/kittens.md b/exampleSite/content/kittens.md new file mode 100644 index 0000000..f4d4a41 --- /dev/null +++ b/exampleSite/content/kittens.md @@ -0,0 +1,84 @@ +--- +weight: 11 +title: Kittens +--- + +# Kittens + +## Get All Kittens + +```go +package main + +import "github.com/bep/kittn/auth" + +func main() { + api := auth.Authorize("meowmeowmeow") + + _ = api.GetKittens() +} +``` + +```ruby +require 'kittn' + +api = Kittn::APIClient.authorize!('meowmeowmeow') +api.kittens.get +``` + +```python +import kittn + +api = kittn.authorize('meowmeowmeow') +api.kittens.get() +``` + +```shell +curl "http://example.com/api/kittens" + -H "Authorization: meowmeowmeow" +``` + +```javascript +const kittn = require('kittn'); + +let api = kittn.authorize('meowmeowmeow'); +let kittens = api.kittens.get(); +``` + +> The above command returns JSON structured like this: + +```json +[ + { + "id": 1, + "name": "Fluffums", + "breed": "calico", + "fluffiness": 6, + "cuteness": 7 + }, + { + "id": 2, + "name": "Max", + "breed": "unknown", + "fluffiness": 5, + "cuteness": 10 + } +] +``` + +This endpoint retrieves all kittens. + +### HTTP Request + +`GET http://example.com/api/kittens` + +### Query Parameters + +Parameter | Default | Description +--------- | ------- | ----------- +include_cats | false | If set to true, the result will also include cats. +available | true | If set to false, the result will include kittens that have already been adopted. + + diff --git a/exampleSite/content/main.md b/exampleSite/content/main.md index 933884b..bd7a0d3 100644 --- a/exampleSite/content/main.md +++ b/exampleSite/content/main.md @@ -63,150 +63,3 @@ Kittn expects for the API key to be included in all API requests to the server i - -# Kittens - -## Get All Kittens - -```go -package main - -import "github.com/bep/kittn/auth" - -func main() { - api := auth.Authorize("meowmeowmeow") - - _ = api.GetKittens() -} -``` - -```ruby -require 'kittn' - -api = Kittn::APIClient.authorize!('meowmeowmeow') -api.kittens.get -``` - -```python -import kittn - -api = kittn.authorize('meowmeowmeow') -api.kittens.get() -``` - -```shell -curl "http://example.com/api/kittens" - -H "Authorization: meowmeowmeow" -``` - -```javascript -const kittn = require('kittn'); - -let api = kittn.authorize('meowmeowmeow'); -let kittens = api.kittens.get(); -``` - -> The above command returns JSON structured like this: - -```json -[ - { - "id": 1, - "name": "Fluffums", - "breed": "calico", - "fluffiness": 6, - "cuteness": 7 - }, - { - "id": 2, - "name": "Max", - "breed": "unknown", - "fluffiness": 5, - "cuteness": 10 - } -] -``` - -This endpoint retrieves all kittens. - -### HTTP Request - -`GET http://example.com/api/kittens` - -### Query Parameters - -Parameter | Default | Description ---------- | ------- | ----------- -include_cats | false | If set to true, the result will also include cats. -available | true | If set to false, the result will include kittens that have already been adopted. - - - -## Get a Specific Kitten - -```go -package main - -import "github.com/bep/kittn/auth" - -func main() { - api := auth.Authorize("meowmeowmeow") - - _ = api.GetKitten(2) -} -``` - -```ruby -require 'kittn' - -api = Kittn::APIClient.authorize!('meowmeowmeow') -api.kittens.get(2) -``` - -```python -import kittn - -api = kittn.authorize('meowmeowmeow') -api.kittens.get(2) -``` - -```shell -curl "http://example.com/api/kittens/2" - -H "Authorization: meowmeowmeow" -``` - -```javascript -const kittn = require('kittn'); - -let api = kittn.authorize('meowmeowmeow'); -let max = api.kittens.get(2); -``` - -> The above command returns JSON structured like this: - -```json -{ - "id": 2, - "name": "Max", - "breed": "unknown", - "fluffiness": 5, - "cuteness": 10 -} -``` - -This endpoint retrieves a specific kitten. - - - -### HTTP Request - -`GET http://example.com/kittens/` - -### URL Parameters - -Parameter | Description ---------- | ----------- -ID | The ID of the kitten to retrieve -