ContextQMD
Back to Swagger Php

Vendor extensions

docs/guide/vendor-extensions.md

6.5.0878 B
Original Source

Vendor extensions

The specification allows for custom properties as long as they start with "x-". Therefore, all swagger-php annotations have an x property which accepts an array (map) and will unfold into "x-" properties.

<codeblock id="custom-property"> <template v-slot:at>

<<< @/snippets/guide/vendor-extensions/custom_property_at.php

</template> <template v-slot:an>

<<< @/snippets/guide/vendor-extensions/custom_property_an.php

</template> <template v-slot:spec>

<<< @/snippets/guide/vendor-extensions/custom_property_spec.php

</template> </codeblock>

Results in:

yaml
openapi: 3.0.0
info:
  title: Example
  version: 1
  x-some-name: a-value
  x-another: 2
  x-complex-type:
    supported:
      - version: "1.0"
        level: baseapi
      - version: "2.1"
        level: fullapi