Skip to content

Commit 04aa6ad

Browse files
committed
acrolinx 1
1 parent e308fc1 commit 04aa6ad

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

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

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ During OpenAPI import, API Management:
3232

3333
If you prefer a different behavior, you can either:
3434
* Manually change via form-based editor, or
35-
* Simply remove the "required" attribute from the OpenAPI definition, thus not converting them to template parameters.
35+
* Remove the "required" attribute from the OpenAPI definition, thus not converting them to template parameters.
3636

3737
## <a name="open-api"> </a>OpenAPI/Swagger import limitations
3838

@@ -46,7 +46,7 @@ If you receive errors while importing your OpenAPI document, make sure you've va
4646

4747
| Requirement | Description |
4848
| ----------- | ----------- |
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> |
5050
| **Defined URL parameter** | Must be part of the URL template. |
5151
| **Available source file URL** | Applied to relative server URLs. |
5252
| **`\$ref` pointers** | Can't reference external files. |
@@ -118,15 +118,21 @@ API definitions exported from an API Management service are:
118118
* Primarily intended for external applications that need to call the API hosted in API Management service.
119119
* Not intended to be imported into the same or different API Management service.
120120

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.
122122

123123
### Add new API via OpenAPI import
124124

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`.
130136

131137
### Update an existing API via OpenAPI import
132138

@@ -148,7 +154,7 @@ To make import more predictable, follow these guidelines:
148154

149155
### Export API as OpenAPI
150156

151-
Each operation's:
157+
For each operation, its:
152158
* Azure resource name will be exported as an `operationId`.
153159
* Display name will be exported as a `summary`.
154160

0 commit comments

Comments
 (0)