Skip to content

Commit a482be4

Browse files
committed
improve documentation
1 parent 3cc212b commit a482be4

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

openapi-parser/src/main/java/io/openapiparser/OpenApiResult.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ enum Version { V30, V31 }
6161
void write(Writer writer) throws IOException;
6262

6363
/**
64-
* Apply an OpenAPI overlay to the OpenAPI document. The result document has to be parse to navigate its OpenAPI
65-
* model.
64+
* Apply an OpenAPI overlay to the OpenAPI document. The result document has to be parsed to navigate its OpenAPI
65+
* model. The document should be bundled before applying an overlay.
6666
*
6767
* @param overlay the overlay document
6868
* @return a raw copy of the OpenAPI document with the applied overlay.

0 commit comments

Comments
 (0)