Skip to content

Commit

Permalink
Add note about Blueprint/tag display order
Browse files Browse the repository at this point in the history
  • Loading branch information
lafrech committed Sep 16, 2019
1 parent 12c9f90 commit d6b9118
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/openapi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -194,8 +194,8 @@ The :meth:`Api.register_converter` allows to register a converter in the
@blp.route('/pets/{objectid:pet_id}')
...
Enforce Field Order in Documentation
------------------------------------
Enforce Order in OpenAPI Specification File
-------------------------------------------

In the OpenAPI specification file, the fields of a ``Schema`` are documented as
schema `properties`. Although objects are not ordered in JSON, OpenAPI
Expand All @@ -219,6 +219,11 @@ This is typically done in a base class:
name = ma.fields.String()
surname = ma.fields.String()
Also, when a :class:`Blueprint <Blueprint>` is registered, a `tag` is created
with the ``Blueprint`` name. The display order in the interface is the
``Blueprint`` registration order. And the display order inside a `tag` is the
order in which the resources are defined in the ``Blueprint``.

Serve the OpenAPI Documentation
-------------------------------

Expand Down

0 comments on commit d6b9118

Please sign in to comment.