{% returns %}

Valid Children

Tag	Multiplicity
{% property %}	[+]

Valid Parent Contexts

This tag is valid inside: {% operation %}

Rules

Rule	Force	Realm	Reference	Description
returns-requires-property	must	global	—	Must contain at least one child. structure
returns-no-attributes	must	global	—	No attributes allowed on the tag itself. Any prose body text is ignored by the compiler. structure

A container tag for property tags that describe the success-path response shape of an operation.

Returns container with property children

tagreturnspropertyoperation returns-tag-schema

{% returns %}
  {% property name="bookmark-id" type="uuid" required=true /%}
  {% property name="url" type="string" required=true /%}
{% /returns %}