What is the convention for specifying attribute data types in apiary.io markdown?

The attributes of the apiary.io resource are listed as a dot. Is there a specific agreement to show what type of data these attributes are or correspond to data formats?

+3
source share
1 answer

There is currently no agreement to discuss resource attributes in the Blueprint API. Close planned Description of the attributes of the message body .

But I feel that it would be a real solution that the concept of the future Blueprint API - Resource Blueprint offers to define semantic data (from a resource). Refer to an example resource .

, , , , , :

# Resource [/resource]

## Attributes

+ ip (string) ... ipv4 or ipv6 address associated with the resource
+ some-other-attribute (number, optional, `42`) ... a number of something
+2

All Articles