You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -46,7 +46,7 @@ If you receive errors while importing your OpenAPI document, make sure you've va
46
46
47
47
| Requirement | Description |
48
48
| ----------- | ----------- |
49
-
|**Unique names for required path and query parameters**| In OpenAPI: <ul><li>A parameter name only needs to be unique within a location, for example path, query, header.</li></ul>In API Management:<ul><li>We allow operations to be discriminated by both path and query parameters.</li><li>OpenAPI doesn't support this, so we require parameter names to be unique within the entire URL template.</li></ul> |
49
+
|**Unique names for required path and query parameters**| In OpenAPI: <ul><li>A parameter name only needs to be unique within a location, for example path, query, header.</li></ul>In API Management:<ul><li>We allow operations to be discriminated by both path and query parameters.</li><li>OpenAPI doesn't support this discrimination, so we require parameter names to be unique within the entire URL template.</li></ul> |
50
50
|**Defined URL parameter**| Must be part of the URL template. |
51
51
|**Available source file URL**| Applied to relative server URLs. |
@@ -118,15 +118,21 @@ API definitions exported from an API Management service are:
118
118
* Primarily intended for external applications that need to call the API hosted in API Management service.
119
119
* Not intended to be imported into the same or different API Management service.
120
120
121
-
For configuration management of API definitions across different services/environments, please refer to documentation regarding using API Management Service with Git.
121
+
For configuration management of API definitions across different services/environments, refer to documentation regarding using API Management service with Git.
122
122
123
123
### Add new API via OpenAPI import
124
124
125
-
For each operation found in the OpenAPI document, a new operation will be created with Azure resource name and display name set to `operationId` and `summary`, respectively.
126
-
*`operationId` value is normalized.
127
-
* If `operationId` isn't specified (not present, `null`, or empty), Azure resource name value will be generated by combining HTTP method and path template, for example, `get-foo`.
128
-
*`summary` value is imported as-is and its length is limited to 300 characters.
129
-
* If `summary` isn't specified (not present, `null`, or empty), `display name` value will set to `operationId`.
125
+
For each operation found in the OpenAPI document, a new operation will be created with:
126
+
* Azure resource name set to `operationId`.
127
+
*`operationId` value is normalized.
128
+
* If `operationId` isn't specified (not present, `null`, or empty), Azure resource name value will be generated by combining HTTP method and path template.
129
+
* For example, `get-foo`.
130
+
131
+
* Display name set to `summary`.
132
+
*`summary` value:
133
+
* Imported as-is.
134
+
* Length is limited to 300 characters.
135
+
* If `summary` isn't specified (not present, `null`, or empty), display name value will set to `operationId`.
130
136
131
137
### Update an existing API via OpenAPI import
132
138
@@ -148,7 +154,7 @@ To make import more predictable, follow these guidelines:
148
154
149
155
### Export API as OpenAPI
150
156
151
-
Each operation's:
157
+
For each operation, its:
152
158
* Azure resource name will be exported as an `operationId`.
0 commit comments