Skip to content

Commit bd9ac4f

Browse files
committed
Update 2.0.md
1 parent d6d4e1e commit bd9ac4f

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

versions/2.0.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2280,5 +2280,6 @@ Some objects in the Swagger specification may be declared and remain empty, or c
22802280
The reasoning behind it is to allow an additional layer of access control over the documentation itself. While not part of the specification itself, certain libraries may choose to allow access to parts of the documentation based on some form of authentication/authorization.
22812281

22822282
Two examples for this:
2283+
22832284
1. The [Paths Object](#pathsObject) may be empty. It may be counterintuitive, but this may tell the viewer that they got to the right place, but can't access any documentation. They'd still have access to the [Info Object](#infoObject) which may contain additional information regarding authentication.
22842285
2. The [Path Item Object](#pathItemObject) may be empty. In this case, the viewer will be aware that the path exists, but will not be able to see any of its operations or parameters. This is different than hiding the path itself from the [Paths Object](#pathsObject) so the user will not be aware of its existence. This allows the documentation provider a finer control over what the viewer can see.

0 commit comments

Comments
 (0)