Configuring API Reference
How to hide operations
To hide operations you can use hideOperations property in portal section of
konfig.yaml file. The property is a map where keys are paths to operations and
values are maps with HTTP methods as keys and boolean values. If the value is
true then the operation will be hidden in the API Reference page.
How to hide security requirements
To hide security requirements you can use hideSecurity property in portal.
The property is a list of security requirements names that should be hidden in
the API Reference page.
How to order operations in API Reference
To order the list of operations in your API Reference page, you can configure
the order property in your konfig.yaml file. Here are the
important things to know about the order property:
- The
orderproperty is a list of objects with a "tag" property and an "operations" property. - The "tag" property is a string that refers to a tag in your OpenAPI specification.
- The "operations" property is the order of operations that you want to appear under that tag.
- An operation can be specified by its "operationId" or by its "path" and "method".
- The order of tags is defined by the order of the objects in the list
- The order of operations is defined by the order of the operations in the "operations" property
Operations and tags that are not specified in the order property will appear
at the end of the list in the order that they appear in your OpenAPI specification.