Skip to content
This repository has been archived by the owner on Nov 8, 2024. It is now read-only.

Commit

Permalink
Move parameters in examples to new syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
pksunkara committed Mar 16, 2015
1 parent 16bcc3d commit f7d2f3b
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 17 deletions.
5 changes: 3 additions & 2 deletions examples/07. Parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Note the parameter name `id` is enclosed in curly brackets. We will discuss this

+ Parameters

+ id (number, `1`) ... An unique identifier of the message.
+ id: 1 (number) - An unique identifier of the message.

### Retrieve a Message [GET]

Expand Down Expand Up @@ -79,7 +79,8 @@ We have added the query URI template parameter - `limit`. This parameter is used

+ Parameters

+ limit = `20` (optional, number) ... The maximum number of results to return.
+ limit (number, optional) - The maximum number of results to return.
+ Default: `20`

+ Response 200 (application/json)

Expand Down
6 changes: 4 additions & 2 deletions examples/09. Advanced Attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The `Create a Coupon` action also demonstrate the description of request attribu
A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer.

+ Parameters
+ id (string)
+ id (string)

The ID of the desired coupon.

Expand All @@ -47,10 +47,12 @@ Retrieves the coupon with the given ID.
Returns a list of your coupons.

+ Parameters
+ limit = `10` (optional, number)
+ limit (number, optional)

A limit on the number of objects to be returned. Limit can range between 1 and 100 items.

+ Default: `10`

+ Response 200 (application/json)
+ Attributes (Coupons)

Expand Down
6 changes: 4 additions & 2 deletions examples/10. Data Structures.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Since a portion of the `Coupon` data structure is shared between the `Coupon` de
A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer.

+ Parameters
+ id (string)
+ id (string)

The ID of the desired coupon.

Expand All @@ -38,10 +38,12 @@ Retrieves the coupon with the given ID.
Returns a list of your coupons.

+ Parameters
+ limit = `10` (optional, number)
+ limit (number, optional)

A limit on the number of objects to be returned. Limit can range between 1 and 100 items.

+ Default: `10`

+ Response 200 (application/json)
+ Attributes (Coupons)

Expand Down
12 changes: 6 additions & 6 deletions examples/Gist Fox API + Auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ The Gist resource has the following attributes:
The states *id* and *created_at* are assigned by the Gist Fox API at the moment of creation.

+ Parameters
+ id (string) ... ID of the Gist in the form of a hash.
+ access_token (string, optional) ... Gist Fox API access token.
+ id (string) - ID of the Gist in the form of a hash.
+ access_token (string, optional) - Gist Fox API access token.

+ Model (application/hal+json)

Expand Down Expand Up @@ -138,7 +138,7 @@ In addition it **embeds** *Gist Resources* in the Gist Fox API.

### List All Gists [GET]
+ Parameters
+ since (optional, string) ... Timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ` Only gists updated at or after this time are returned.
+ since (string, optional) - Timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ` Only gists updated at or after this time are returned.

+ Response 200

Expand All @@ -150,7 +150,7 @@ To create a new Gist simply provide a JSON hash of the *description* and *conten
This action requires an `access_token` with `gist_write` scope.

+ Parameters
+ access_token (string, optional) ... Gist Fox API access token.
+ access_token (string, optional) - Gist Fox API access token.

+ Request (application/json)

Expand All @@ -171,8 +171,8 @@ The Star resource has the following attribute:
+ starred

+ Parameters
+ id (string) ... ID of the gist in the form of a hash
+ access_token (string, optional) ... Gist Fox API access token.
+ id (string) - ID of the gist in the form of a hash
+ access_token (string, optional) - Gist Fox API access token.

+ Model (application/hal+json)

Expand Down
6 changes: 3 additions & 3 deletions examples/Gist Fox API.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The states *id* and *created_at* are assigned by the Gist Fox API at the moment


+ Parameters
+ id (string) ... ID of the Gist in the form of a hash.
+ id (string) - ID of the Gist in the form of a hash.

+ Model (application/hal+json)

Expand Down Expand Up @@ -138,7 +138,7 @@ In addition it **embeds** *Gist Resources* in the Gist Fox API.

### List All Gists [GET]
+ Parameters
+ since (optional, string) ... Timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ` Only gists updated at or after this time are returned.
+ since (string, optional) - Timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ` Only gists updated at or after this time are returned.

+ Response 200

Expand Down Expand Up @@ -168,7 +168,7 @@ The Star resource has the following attribute:

+ Parameters

+ id (string) ... ID of the gist in the form of a hash
+ id (string) - ID of the gist in the form of a hash

+ Model (application/hal+json)

Expand Down
4 changes: 2 additions & 2 deletions examples/Real World API.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This section groups App.net post resources.
A Post is the other central object utilized by the App.net Stream API. It has rich text and annotations which comprise all of the content a users sees in their feed. Posts are closely tied to the follow graph...

+ Parameters
+ post_id (string, `1`) ... The id of the Post.
+ post_id: `1` (string) - The id of the Post.

+ Model (application/json)

Expand Down Expand Up @@ -127,7 +127,7 @@ Retrieves all posts.
A User’s stars are visible to others, but they are not automatically added to your followers’ streams.

+ Parameters
+ post_id (string, `1`) ... The id of the Post.
+ post_id: `1` (string) - The id of the Post.

### Star a Post [POST]
Save a given Post to the current User’s stars. This is just a “save” action, not a sharing action.
Expand Down

0 comments on commit f7d2f3b

Please sign in to comment.