Created
February 16, 2016 11:34
-
-
Save netmilk/ecfc9c21037e38e5012f to your computer and use it in GitHub Desktop.
API Blueprint with MSON circular reference
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# API Name | |
## Message Resource [/resource] | |
### Create a Message [POST] | |
+ Request | |
+ Attributes (Message) | |
+ Response 200 | |
+ Attributes | |
+ id (string) | |
+ message (Message) | |
## Message Resource with a model [/another_uri] | |
+ Attributes (Message) | |
+ Include Deleted Item | |
## Get a Message [GET] | |
+ Response 200 | |
## Message Resource without model [/just_another_uri] | |
## Some Action with Attributes [POST] | |
+ Attributes (Message) | |
+ action_key: its value | |
+ message_base (Message Base) | |
+ Response 200 | |
# Data Structures | |
## Message (Message Base) | |
- text: Hello! | |
- a (array[Message]) | |
## Message Base (object) | |
- send_from: a place | |
## Deleted Item (object) | |
- deleted_at: some-date |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment