Skip to content

Commit 5bf59fd

Browse files
Merge pull request #227589 from mumurug-MSFT/patch-26
(AzureCXP) fixes MicrosoftDocs/azure-docs#105288
2 parents 066a619 + 1f07454 commit 5bf59fd

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

articles/api-management/api-management-api-import-restrictions.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -109,14 +109,14 @@ Security definitions are ignored.
109109
When importing query parameters, only the default array serialization method (`style: form`, `explode: true`) is supported. For more details on query parameters in OpenAPI specifications, refer to [the serialization specification](https://swagger.io/docs/specification/serialization/).
110110

111111
<!-- Ref: 1795433 Parameter limitations -->
112-
Parameters [defined in cookies](https://swagger.io/docs/specification/describing-parameters/#cookie-parameters) are not supported. You can still use policy to decode and validate the contents of cookies.
112+
Parameters [defined in cookies](https://swagger.io/docs/specification/describing-parameters/#cookie-parameters) aren't supported. You can still use policy to decode and validate the contents of cookies.
113113

114114
### <a name="open-api-v2"> </a>OpenAPI version 2
115115

116116
OpenAPI version 2 support is limited to JSON format only.
117117

118118
<!-- Ref: 1795433 Parameter limitations -->
119-
["Form" type parameters](https://swagger.io/specification/v2/#parameter-object) are not supported. You can still use policy to decode and validate `application/x-www-form-urlencoded` and `application/form-data` payloads.
119+
["Form" type parameters](https://swagger.io/specification/v2/#parameter-object) aren't supported. You can still use policy to decode and validate `application/x-www-form-urlencoded` and `application/form-data` payloads.
120120

121121
### <a name="open-api-v3"> </a>OpenAPI version 3.x
122122

@@ -128,19 +128,20 @@ API Management supports the following specification versions:
128128
#### HTTPS URLs
129129

130130
* If multiple `servers` are specified, API Management will use the first HTTPS URL it finds.
131-
* If there aren't any HTTPS URLs, the server URL will be empty.
131+
* If there aren't any HTTPS URLs, the server URL is empty.
132132

133133
#### Supported
134134

135135
- `example`
136136

137137
#### Unsupported
138138

139-
The following fields are included in [OpenAPI version 3.0.x](https://swagger.io/specification/), but are not supported:
139+
The following fields are included in either [OpenAPI version 3.0.x](https://swagger.io/specification/) or [OpenAPI version 3.1.x](https://spec.openapis.org/oas/v3.1.0), but aren't supported:
140140

141141
| Object | Field |
142142
| ----------- | ----------- |
143143
| **OpenAPI** | `externalDocs` |
144+
| **Info** | `summary` |
144145
| **Components** | <ul><li>`responses`</li><li>`parameters`</li><li>`examples`</li><li>`requestBodies`</li><li>`headers`</li><li>`securitySchemes`</li><li>`links`</li><li>`callbacks`</li></ul> |
145146
| **PathItem** | <ul><li>`trace`</li><li>`servers`</li></ul> |
146147
| **Operation** | <ul><li>`externalDocs`</li><li>`callbacks`</li><li>`security`</li><li>`servers`</li></ul> |
@@ -159,10 +160,10 @@ For configuration management of API definitions across different services/enviro
159160

160161
### Add new API via OpenAPI import
161162

162-
For each operation found in the OpenAPI document, a new operation will be created with:
163+
For each operation found in the OpenAPI document, a new operation is created with:
163164
* Azure resource name set to `operationId`.
164165
* `operationId` value is normalized.
165-
* If `operationId` isn't specified (not present, `null`, or empty), Azure resource name value will be generated by combining HTTP method and path template.
166+
* If `operationId` isn't specified (not present, `null`, or empty), Azure resource name value is generated by combining HTTP method and path template.
166167
* For example, `get-foo`.
167168

168169
* Display name set to `summary`.
@@ -174,9 +175,9 @@ For each operation found in the OpenAPI document, a new operation will be create
174175
**Normalization rules for `operationId`**
175176
- Convert to lower case.
176177
- Replace each sequence of non-alphanumeric characters with a single dash.
177-
- For example, `GET-/foo/{bar}?buzz={quix}` will be transformed into `get-foo-bar-buzz-quix-`.
178+
- For example, `GET-/foo/{bar}?buzz={quix}` is transformed into `get-foo-bar-buzz-quix-`.
178179
- Trim dashes on both sides.
179-
- For example, `get-foo-bar-buzz-quix-` will become `get-foo-bar-buzz-quix`
180+
- For example, `get-foo-bar-buzz-quix-` becomes `get-foo-bar-buzz-quix`
180181
- Truncate to fit 76 characters, four characters less than maximum limit for a resource name.
181182
- Use remaining four characters for a de-duplication suffix, if necessary, in the form of `-1, -2, ..., -999`.
182183

@@ -185,12 +186,12 @@ For each operation found in the OpenAPI document, a new operation will be create
185186
During import, the existing API operation:
186187
* Changes to match the API described in the OpenAPI document.
187188
* Matches to an operation in the OpenAPI document by comparing its `operationId` value to the existing operation's Azure resource name.
188-
* If a match is found, existing operation’s properties will be updated "in-place".
189+
* If a match is found, existing operation’s properties are updated "in-place".
189190
* If a match isn't found:
190-
* A new operation will be created by combining HTTP method and path template, for example, `get-foo`.
191+
* A new operation is created by combining HTTP method and path template, for example, `get-foo`.
191192
* For each new operation, the import will attempt to copy policies from an existing operation with the same HTTP method and path template.
192193

193-
All existing unmatched operations will be deleted.
194+
All existing unmatched operations are deleted.
194195

195196
To make import more predictable, follow these guidelines:
196197

@@ -201,17 +202,17 @@ To make import more predictable, follow these guidelines:
201202
**Normalization rules for `operationId`**
202203
- Convert to lower case.
203204
- Replace each sequence of non-alphanumeric characters with a single dash.
204-
- For example, `GET-/foo/{bar}?buzz={quix}` will be transformed into `get-foo-bar-buzz-quix-`.
205+
- For example, `GET-/foo/{bar}?buzz={quix}` is transformed into `get-foo-bar-buzz-quix-`.
205206
- Trim dashes on both sides.
206-
- For example, `get-foo-bar-buzz-quix-` will become `get-foo-bar-buzz-quix`
207+
- For example, `get-foo-bar-buzz-quix-` becomes `get-foo-bar-buzz-quix`
207208
- Truncate to fit 76 characters, four characters less than maximum limit for a resource name.
208209
- Use remaining four characters for a de-duplication suffix, if necessary, in the form of `-1, -2, ..., -999`.
209210

210211
### Export API as OpenAPI
211212

212-
For each operation, its:
213-
* Azure resource name will be exported as an `operationId`.
214-
* Display name will be exported as a `summary`.
213+
For each operation, it's:
214+
* Azure resource name is exported as an `operationId`.
215+
* Display name is exported as a `summary`.
215216

216217
Note that normalization of the `operationId` is done on import, not on export.
217218

@@ -230,7 +231,7 @@ You can create [SOAP pass-through](import-soap-api.md) and [SOAP-to-REST](restif
230231

231232
### WS-* specifications
232233

233-
WSDL files incorporating WS-* specifications are not supported.
234+
WSDL files incorporating WS-* specifications aren't supported.
234235

235236
### Messages with multiple parts
236237
This message type is not supported.
@@ -244,13 +245,13 @@ This message type is not supported.
244245
- Official support isn't offered at this time.
245246

246247
### Recursion
247-
- Types defined recursively are not supported by API Management.
248+
- Types defined recursively aren't supported by API Management.
248249
- For example, refer to an array of themselves.
249250

250251
### Multiple Namespaces
251252
While multiple namespaces can be used in a schema, only the target namespace can be used to define message parts. These namespaces are used to define other input or output elements.
252253

253-
Namespaces other than the target are not preserved on export. While you can import a WSDL document defining message parts with other namespaces, all message parts will have the WSDL target namespace on export.
254+
Namespaces other than the target aren't preserved on export. While you can import a WSDL document defining message parts with other namespaces, all message parts will have the WSDL target namespace on export.
254255

255256
### Arrays
256257
SOAP-to-REST transformation supports only wrapped arrays shown in the example below:

0 commit comments

Comments
 (0)