https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/NETCONF-1026 netconf <p><a href="https://swagger.io/specification/" class="external-link" target="_blank" rel="nofollow noopener">https://swagger.io/specification/</a> says:</p> <p><b>Deprecated:</b> The <tt>example</tt> property has been deprecated in favor of the JSON Schema <tt>examples</tt> keyword. Use of <tt>example</tt> is discouraged, and later versions of this specification may remove it.</p> <p>Thus we need to replace our usage of <tt>example</tt> keyword to <tt>examples</tt> keyword. Please note that the main difference is that <tt>examples</tt> is an array according to <a href="https://swagger.io/docs/specification/adding-examples/" class="external-link" target="_blank" rel="nofollow noopener">https://swagger.io/docs/specification/adding-examples/</a>.</p> NETCONF-1026

OpenAPI: Use examples instead of example

Improvement Medium Open Unresolved Ivan Hrasko Ivan Hrasko pt Wed, 10 May 2023 11:22:38 +0000 Tue, 23 May 2023 12:55:17 +0000 restconf-openapi 0 1 <p><b>Note that schemas and properties support single example but not multiple examples</b> as is stated in <a href="https://swagger.io/docs/specification/adding-examples/" class="external-link" target="_blank" rel="nofollow noopener">https://swagger.io/docs/specification/adding-examples/.</a></p> <p>In addition, what we originally supposed to do is availbale only since openapi 3.1.0 as seen in <a href="https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0" class="external-link" target="_blank" rel="nofollow noopener">https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0.</a></p> <p>Thus we will postpone this task to time when mi migrate to openapi 3.1.0.</p> <p>No, we cannot update to OpenAPI 3.1 because swagger UI does not support it yet: <a href="https://github.com/swagger-api/swagger-ui#compatibility" class="external-link" target="_blank" rel="nofollow noopener">https://github.com/swagger-api/swagger-ui#compatibility</a></p> Blocks NETCONF-999 Development Rank 0|i0452v: