Document standardized extensions to OpenAPI v2

This commit is contained in:
Andrew Morgan 2018-07-13 12:25:48 +01:00 committed by user
parent 273acb277c
commit 3e4962f211

View file

@ -0,0 +1,23 @@
OpenAPI Extensions
==================
For some functionality that is not directly provided by the OpenAPI v2
specification, some extensions have been added that are to be consistent
across the specification. The defined extensions are listed below. Extensions
should not break parsers, however if extra functionality is required, aware
parsers should be able to take advantage of the added syntax.
Extensible Query Parameters
---------------------------
If a unknown amount of query parameters can be added to a request, the
``name`` should be in form of ``something...``, with the trailing ellipses
representing the possibility of more fields.
Example:
.. code-block::
- in: query
name: fields...
type: string