Attributes description #135
Conversation
|
🚢 it |
|
can we have this feature in the beta area, like the "New Documentation"? |
|
|
||
| + attributes (object) | ||
| + id: 250FF (string) | ||
| + object: coupon (string, fixed) |
There was a problem hiding this comment.
Would something other than object be better here, as object is used as a type?
There was a problem hiding this comment.
Nah, its a property in of the JSON, this example was taken from the Stripe API, see the JSON blob just bellow (https://github.com/apiaryio/api-blueprint/pull/135/files#diff-4a00d27e65fcbd5e907cb2fa3dec6111R36)
There was a problem hiding this comment.
I was mainly meaning for clarity purposes. Talking about objects and then using an object as a string could be unclear in some situations.
There was a problem hiding this comment.
Maybe add a little note saying that just because object is used to describe a type, there is no prohibition against using it as a property name.
|
@zdne My review is done. Looks very good. Please resolve my comments. Thanks. |
|
Addressed review comments. Proceeding with updating resource and action sections. |
|
Hey @L42y, once available in Apiary, this will be (most likely) directly part of the blueprint editor and documentation, no need to switch it on in the beta area. |
|
👍 Looks good. |
|
Added attributes to Resource and Action sections, please review c785fef |
|
The text looks good. Just a minor question about consistency. |
Propose resource relation syntax
Mention uniqueness of relation
Fix parameters in examples
Inline action syntax
Align parameters syntax with attributes
Added relation to advanced bueprint
Update snowcrash references to drafter
7594468 to
0151a55
Compare
| * `Values` is the **optional** enumeration of possible values | ||
| * and `<enumeration element n>` represents an element of enumeration type. | ||
| * `<type>` is the **optional** parameter type as expected by the API (e.g. "number", "string", "boolean"). "string" is the **default**. | ||
| * `Members` is the **optional** enumeration of possible values. `<type>` should be surrounded by `enum[]` if this is present. For example, if enumeration values are present for a parameter whose type is `number`, then `enum[number]` should be used instead of `number` to. |
Added format support information
For review ONLY – do not merge
This Pull Request proposes the way to describe Resource, Action and arbitrary message-body attributes in a reusable way. It also proposes the introduction of "data dictionary" to API Blueprint. In addition changes in this PR suggest that, if a message-body data structure is fully described using the attributes description, an explicit example asset (e.g. a JSON blob) is not needed and can be omitted from a blueprint.
Please read (and review) following examples:
Also, in particular, read (and review) following sections of API Blueprint Specification
Update
Added description of Attributes section in
This PR closes #25