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

Commit

Permalink
Merge pull request #171 from apiaryio/pksunkara/relation
Browse files Browse the repository at this point in the history
Added relation to advanced bueprint
  • Loading branch information
kylef committed Mar 16, 2015
2 parents f60b4b4 + ce48634 commit 5f015c4
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
1 change: 1 addition & 0 deletions API Blueprint Specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@ Following reserved keywords are used in section definitions:
- `Parameter` & `Parameters`
- `Values`
- `Attribute` & `Attributes`
- `Relation`

> **NOTE: Avoid using these keywords in other Markdown headers or lists**
Expand Down
10 changes: 10 additions & 0 deletions examples/Polls Hypermedia API.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ This resource does not have any attributes. Instead it offers the initial API af

### List All Questions [GET]

+ Relation: questions

+ Response 200 (application/vnd.siren+json)

{
Expand Down Expand Up @@ -224,6 +226,8 @@ You may create your own question using this action. It takes a JSON object conta
+ question (string) - The question
+ choices (array[string]) - A collection of choices.

+ Relation: create

+ Request (application/json)

{
Expand Down Expand Up @@ -394,6 +398,8 @@ A Question object has the following attributes:

### View a Questions Detail [GET]

+ Relation: question

+ Response 200 (application/vnd.siren+json)

{
Expand Down Expand Up @@ -542,6 +548,8 @@ A Question object has the following attributes:

### View a Choice Detail [GET]

+ Relation: choice

+ Response 200 (application/vnd.siren+json)

{
Expand Down Expand Up @@ -579,6 +587,8 @@ A Question object has the following attributes:

This action allows you to vote on a question's choice.

+ Relation: vote

+ Response 201 (application/vnd.siren+json)

{
Expand Down

0 comments on commit 5f015c4

Please sign in to comment.