diff --git a/libs/converter-openapi/README.md b/libs/converter-openapi/README.md index 27bced12..48fc23de 100644 --- a/libs/converter-openapi/README.md +++ b/libs/converter-openapi/README.md @@ -35,12 +35,9 @@ A library for implementing the OpenAPI specification and ADC profile conversion. Override the name of the generated route - x-adc-labels + x-adc-labels Root Level - Add labels field to the specified level. It supports string and string array formats. - - - Path Level + Add labels field to the specified level. It supports string and string array formats. Operation Level @@ -48,11 +45,10 @@ A library for implementing the OpenAPI specification and ADC profile conversion. x-adc-plugins Root Level - Add plugins field to the specified level. It is an object that contains one or more plugins. + Add plugins field to the specified level. It is an object that contains one or more plugins. Plugins set at the path or operation level are attached directly to the routes generated from that path or operation; they do not by themselves cause the service to be split. Path Level - Plugin objects at the Path level and Operation level will cause the service to be split, i.e. the sub-level containing the plugin will be included in a new service. Operation Level @@ -116,7 +112,7 @@ servers: x-adc-route-defaults Root Level - It supports setting/overriding parameters in the route at various levels. This field on sub-levels will cause the service to be split. + It supports setting/overriding parameters in the route at various levels. Sub-level values override root-level values (operation > path > root); the merged result is applied to each route. This field does not by itself cause the service to be split. Path Level