Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PATCH should return 200 OK #10328

Merged
merged 4 commits into from
Aug 11, 2020
Merged

PATCH should return 200 OK #10328

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
df50e97
add support for PATCH returning 200 OK
solankisamir Aug 3, 2020
96fa07d
CI fixes
solankisamir Aug 4, 2020
ad13e7f
Password no longer a mandatory property when uploading Certificates
solankisamir Aug 4, 2020
d846c54
add missing x-ms-odata extension for filter support
solankisamir Aug 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 70 additions & 25 deletions ...agement/resource-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/apimapis.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion ...t/resource-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/apimapisByTags.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n\r\n|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|isCurrent | eq | |\n"
"description": "| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| isCurrent | filter | eq | |</br>"
},
{
"$ref": "./apimanagement.json#/parameters/TopQueryParameter"
Expand Down
15 changes: 12 additions & 3 deletions ...source-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/apimapiversionsets.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>"
"description": "| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>"
},
{
"$ref": "./apimanagement.json#/parameters/TopQueryParameter"
Expand Down Expand Up @@ -303,8 +303,17 @@
}
],
"responses": {
"204": {
"description": "The Api Version Set details were successfully updated."
"200": {
"description": "Api Version Set was successfully updated.",
"schema": {
"$ref": "./definitions.json#/definitions/ApiVersionSetContract"
},
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
Expand Down
29 changes: 22 additions & 7 deletions ...-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/apimauthorizationservers.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>"
"description": "| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>"
},
{
"$ref": "./apimanagement.json#/parameters/TopQueryParameter"
Expand Down Expand Up @@ -170,7 +170,7 @@
],
"responses": {
"200": {
"description": "Gets the details of the specified authorization server.",
"description": "Gets the details of the specified authorization server. No secrets included.",
"schema": {
"$ref": "./definitions.json#/definitions/AuthorizationServerContract"
},
Expand Down Expand Up @@ -303,8 +303,17 @@
}
],
"responses": {
"204": {
"description": "The authorization server settings were successfully updated."
"200": {
"description": "The authorization server settings were successfully updated.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
},
"schema": {
"$ref": "./definitions.json#/definitions/AuthorizationServerContract"
}
},
"default": {
"description": "Error response describing why the operation failed.",
Expand Down Expand Up @@ -369,8 +378,8 @@
"operationId": "AuthorizationServer_ListSecrets",
"description": "Gets the client secret details of the authorization server.",
"x-ms-examples": {
"ApiManagementListSecretsAuthorizationServer": {
"$ref": "./examples/ApiManagementListSecretsAuthorizationServer.json"
"ApiManagementAuthorizationServerListSecrets": {
"$ref": "./examples/ApiManagementAuthorizationServerListSecrets.json"
}
},
"parameters": [
Expand All @@ -392,9 +401,15 @@
],
"responses": {
"200": {
"description": "The response body contains the client secret.",
"description": "Gets the secrets of the specified authorization server.",
"schema": {
"$ref": "./definitions.json#/definitions/ClientSecretContract"
},
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
}
},
"default": {
Expand Down
15 changes: 12 additions & 3 deletions ...ent/resource-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/apimbackends.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>"
"description": "| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>"
},
{
"$ref": "./apimanagement.json#/parameters/TopQueryParameter"
Expand Down Expand Up @@ -306,8 +306,17 @@
}
],
"responses": {
"204": {
"description": "The existing backend was successfully updated."
"200": {
"description": "The existing backend was successfully updated.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
},
"schema": {
"$ref": "./definitions.json#/definitions/BackendContract"
}
},
"default": {
"description": "Error response describing why the operation failed.",
Expand Down
13 changes: 11 additions & 2 deletions ...ement/resource-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/apimcaches.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,8 +299,17 @@
}
],
"responses": {
"204": {
"description": "The cache details were successfully updated."
"200": {
"description": "The Cache details were successfully updated.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
},
"schema": {
"$ref": "./definitions.json#/definitions/CacheContract"
}
},
"default": {
"description": "Error response describing why the operation failed.",
Expand Down
2 changes: 1 addition & 1 deletion ...resource-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/apimcertificates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| expirationDate | filter | ge, le, eq, ne, gt, lt | | </br>"
"description": "| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| expirationDate | filter | ge, le, eq, ne, gt, lt | |</br>"
},
{
"$ref": "./apimanagement.json#/parameters/TopQueryParameter"
Expand Down
112 changes: 52 additions & 60 deletions ...resource-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/apimcontenttypes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,53 +80,12 @@
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}": {
"head": {
Copy link
Member

@majastrz majastrz Aug 6, 2020 •
edited by solankisamir
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

head [](start = 7, length = 4)

This looks like a potentially breaking change as per https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md. Do you have a breaking change approval for it or can you explain why it's not a breaking change? #Resolved

Copy link
Member Author

@solankisamir solankisamir Aug 6, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a new api-version and not published yet. #Resolved

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Read the link I sent. Yes, breaking changes require an new API version, which you are doing but removing things across API versions is also considered a breaking change and requires separate approval (instructions in the link).

In reply to: 466675140 [](ancestors = 466675140)

"tags": [
"ContentType"
],
"operationId": "ContentType_GetEntityTag",
"description": "Returns content type metadata",
"parameters": [
{
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Specified content type entity exists and current entity state version is present in the ETag header.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
}
}
}
},
"get": {
"tags": [
"ContentType"
],
"operationId": "ContentTypes_Get",
"description": "Gets API Management content type details",
"operationId": "ContentType_Get",
"description": "Gets API Management content type details.",
"x-ms-examples": {
"ApiManagementGetContentType": {
"$ref": "./examples/ApiManagementGetContentType.json"
Expand Down Expand Up @@ -175,7 +134,7 @@
"ContentType"
],
"operationId": "ContentType_CreateOrUpdate",
"description": "Creates new content type",
"description": "Creates or updates an Content Type.",
"x-ms-examples": {
"ApiManagementCreateContentType": {
"$ref": "./examples/ApiManagementCreateContentType.json"
Expand All @@ -191,6 +150,9 @@
{
"$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
Expand Down Expand Up @@ -237,6 +199,11 @@
],
"operationId": "ContentType_Delete",
"description": "Removes specified content type.",
"x-ms-examples": {
"ApiManagementDeleteContentType": {
"$ref": "./examples/ApiManagementDeleteContentType.json"
}
},
"parameters": [
{
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
Expand All @@ -247,6 +214,9 @@
{
"$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
Expand All @@ -258,6 +228,9 @@
"200": {
"description": "The content type was successfully deleted."
},
"204": {
"description": "The content type was successfully deleted."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
Expand All @@ -270,13 +243,13 @@
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems": {
"get": {
"tags": [
"ContentItem"
"ContentTypeContentItem"
],
"operationId": "ContentItem_ListByService",
"operationId": "ContentTypeContentItem_ListByService",
"description": "Returns list of content items",
"x-ms-examples": {
"ApiManagementListContentItems": {
"$ref": "./examples/ApiManagementListContentItems.json"
"ApiManagementListContentTypeContentItems": {
"$ref": "./examples/ApiManagementListContentTypeContentItems.json"
}
},
"parameters": [
Expand Down Expand Up @@ -318,10 +291,15 @@
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}": {
"head": {
"tags": [
"ContentItem"
"ContentTypeContentItem"
],
"operationId": "ContentItem_GetEntityTag",
"operationId": "ContentTypeContentItem_GetEntityTag",
"description": "Returns content item metadata",
"x-ms-examples": {
"ApiManagementHeadContentTypeContentItem": {
"$ref": "./examples/ApiManagementHeadContentTypeContentItem.json"
}
},
"parameters": [
{
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
Expand Down Expand Up @@ -362,13 +340,13 @@
},
"get": {
"tags": [
"ContentItem"
"ContentTypeContentItem"
],
"operationId": "ContentItem_Get",
"operationId": "ContentTypeContentItem_Get",
"description": "Returns content item details",
"x-ms-examples": {
"ApiManagementGetContentItem": {
"$ref": "./examples/ApiManagementGetContentItem.json"
"ApiManagementGetContentTypeContentItem": {
"$ref": "./examples/ApiManagementGetContentTypeContentItem.json"
}
},
"parameters": [
Expand Down Expand Up @@ -414,13 +392,13 @@
},
"put": {
"tags": [
"ContentItem"
"ContentTypeContentItem"
],
"operationId": "ContentItem_CreateOrUpdate",
"operationId": "ContentTypeContentItem_CreateOrUpdate",
"description": "Creates new content item",
"x-ms-examples": {
"ApiManagementCreateContentItem": {
"$ref": "./examples/ApiManagementCreateContentItem.json"
"ApiManagementCreateContentTypeContentItem": {
"$ref": "./examples/ApiManagementCreateContentTypeContentItem.json"
}
},
"parameters": [
Expand All @@ -436,6 +414,9 @@
{
"$ref": "./apimanagement.json#/parameters/ContentItemIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
Expand Down Expand Up @@ -478,10 +459,15 @@
},
"delete": {
"tags": [
"ContentItem"
"ContentTypeContentItem"
],
"operationId": "ContentItem_Delete",
"operationId": "ContentTypeContentItem_Delete",
"description": "Removes specified content item.",
"x-ms-examples": {
"ApiManagementDeleteContentTypeContentItem": {
"$ref": "./examples/ApiManagementDeleteContentTypeContentItem.json"
}
},
"parameters": [
{
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
Expand All @@ -495,6 +481,9 @@
{
"$ref": "./apimanagement.json#/parameters/ContentItemIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
Expand All @@ -506,6 +495,9 @@
"200": {
"description": "The content item was successfully deleted."
},
"204": {
"description": "The content item was successfully deleted."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
Expand Down
Loading