Skip to content

ApiManagement - renaming /properties entity to /namedValues #7683

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

Merged
solankisamir merged 2 commits into from
Nov 4, 2019
Merged

ApiManagement - renaming /properties entity to /namedValues #7683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77bd403
ApiManagement - renaming /properties entity to /namedValues
Oct 31, 2019
42c82a6
ApiManagement - renaming parameter name: propId to namedValueId
Nov 1, 2019
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
6 changes: 3 additions & 3 deletions ...nt/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimanagement.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,12 +530,12 @@
"maxLength": 256,
"x-ms-parameter-location": "method"
},
"PropertyIdParameter": {
"name": "propId",
"NamedValueIdParameter": {
"name": "namedValueId",
"in": "path",
"required": true,
"type": "string",
"description": "Identifier of the property.",
"description": "Identifier of the NamedValue.",
"maxLength": 256,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
Expand Down
106 changes: 53 additions & 53 deletions ...ew/2019-12-01-preview/apimproperties.json → ...w/2019-12-01-preview/apimnamedvalues.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"swagger": "2.0",
"info": {
"title": "ApiManagementClient",
"description": "Use these REST APIs for performing operations on Property entity associated with your Azure API Management deployment. API Management policies are a powerful capability of the system that allow the publisher to change the behavior of the API through configuration. Policies are a collection of statements that are executed sequentially on the request or response of an API. Policy statements can be constructed using literal text values, policy expressions, and properties. Each API Management service instance has a properties collection of key/value pairs that are global to the service instance. These properties can be used to manage constant string values across all API configuration and policies.",
"description": "Use these REST APIs for performing operations on NamedValue entity associated with your Azure API Management deployment. API Management policies are a powerful capability of the system that allow the publisher to change the behavior of the API through configuration. Policies are a collection of statements that are executed sequentially on the request or response of an API. Policy statements can be constructed using literal text values, policy expressions, and NamedValues. Each API Management service instance has a NamedValues collection of key/value pairs that are global to the service instance. These NamedValues can be used to manage constant string values across all API configuration and policies.",
Copy link
Copy Markdown
Member

@solankisamir solankisamir Oct 31, 2019

Choose a reason for hiding this comment

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

lowercase

Copy link
Copy Markdown
Contributor Author

@vfedonkin vfedonkin Nov 1, 2019

Choose a reason for hiding this comment

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

Usually we use upper case. Like "Lists a collection of all external Caches in the specified service instance."

"version": "2019-12-01-preview"
},
"host": "management.azure.com",
Expand Down Expand Up @@ -34,19 +34,19 @@
}
},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues": {
"get": {
"tags": [
"Property"
"NamedValue"
],
"operationId": "Property_ListByService",
"description": "Lists a collection of properties defined within a service instance.",
"operationId": "NamedValue_ListByService",
"description": "Lists a collection of NamedValues defined within a service instance.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-properties"
Copy link
Copy Markdown
Member

@solankisamir solankisamir Oct 31, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

properties [](start = 93, length = 10)

we should ask the PM to rename the doc name :) #Closed

Copy link
Copy Markdown
Contributor Author

@vfedonkin vfedonkin Nov 1, 2019 •
edited by solankisamir
Loading

Choose a reason for hiding this comment

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

I asked Mike to do this #Closed

},
"x-ms-examples": {
"ApiManagementListProperties": {
"$ref": "./examples/ApiManagementListProperties.json"
"ApiManagementListNamedValues": {
"$ref": "./examples/ApiManagementListNamedValues.json"
}
},
"parameters": [
Expand Down Expand Up @@ -78,9 +78,9 @@
],
"responses": {
"200": {
"description": "A Collection of the Property entities for the specified API Management service instance.",
"description": "A Collection of the NamedValue entities for the specified API Management service instance.",
"schema": {
"$ref": "./definitions.json#/definitions/PropertyCollection"
"$ref": "./definitions.json#/definitions/NamedValueCollection"
}
},
"default": {
Expand All @@ -93,19 +93,19 @@
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-odata": "./definitions.json#/definitions/PropertyContract"
"x-ms-odata": "./definitions.json#/definitions/NamedValueContract"
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties/{propId}": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}": {
"head": {
"tags": [
"Property"
"NamedValue"
],
"operationId": "Property_GetEntityTag",
"description": "Gets the entity state (Etag) version of the property specified by its identifier.",
"operationId": "NamedValue_GetEntityTag",
"description": "Gets the entity state (Etag) version of the NamedValue specified by its identifier.",
"x-ms-examples": {
"ApiManagementHeadProperty": {
"$ref": "./examples/ApiManagementHeadProperty.json"
"ApiManagementHeadNamedValue": {
"$ref": "./examples/ApiManagementHeadNamedValue.json"
}
},
"parameters": [
Expand All @@ -116,7 +116,7 @@
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/PropertyIdParameter"
"$ref": "./apimanagement.json#/parameters/NamedValueIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
Expand All @@ -127,7 +127,7 @@
],
"responses": {
"200": {
"description": "Specified Property entity exists and current entity state version is present in the ETag header.",
"description": "Specified NamedValue 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.",
Expand All @@ -145,13 +145,13 @@
},
"get": {
"tags": [
"Property"
"NamedValue"
],
"operationId": "Property_Get",
"description": "Gets the details of the property specified by its identifier.",
"operationId": "NamedValue_Get",
"description": "Gets the details of the NamedValue specified by its identifier.",
"x-ms-examples": {
"ApiManagementGetProperty": {
"$ref": "./examples/ApiManagementGetProperty.json"
"ApiManagementGetNamedValue": {
"$ref": "./examples/ApiManagementGetNamedValue.json"
}
},
"parameters": [
Expand All @@ -162,7 +162,7 @@
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/PropertyIdParameter"
"$ref": "./apimanagement.json#/parameters/NamedValueIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
Expand All @@ -173,9 +173,9 @@
],
"responses": {
"200": {
"description": "The response body contains the specified Property entity.",
"description": "The response body contains the specified NamedValue entity.",
"schema": {
"$ref": "./definitions.json#/definitions/PropertyContract"
"$ref": "./definitions.json#/definitions/NamedValueContract"
},
"headers": {
"ETag": {
Expand All @@ -194,13 +194,13 @@
},
"put": {
"tags": [
"Property"
"NamedValue"
],
"operationId": "Property_CreateOrUpdate",
"description": "Creates or updates a property.",
"operationId": "NamedValue_CreateOrUpdate",
"description": "Creates or updates a NamedValue.",
"x-ms-examples": {
"ApiManagementCreateProperty": {
"$ref": "./examples/ApiManagementCreateProperty.json"
"ApiManagementCreateNamedValue": {
"$ref": "./examples/ApiManagementCreateNamedValue.json"
}
},
"parameters": [
Expand All @@ -211,14 +211,14 @@
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/PropertyIdParameter"
"$ref": "./apimanagement.json#/parameters/NamedValueIdParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "./definitions.json#/definitions/PropertyContract"
"$ref": "./definitions.json#/definitions/NamedValueContract"
},
"description": "Create parameters."
},
Expand All @@ -234,9 +234,9 @@
],
"responses": {
"201": {
"description": "Property was successfully created.",
"description": "NamedValue was successfully created.",
"schema": {
"$ref": "./definitions.json#/definitions/PropertyContract"
"$ref": "./definitions.json#/definitions/NamedValueContract"
},
"headers": {
"ETag": {
Expand All @@ -246,9 +246,9 @@
}
},
"200": {
"description": "Property was successfully updated.",
"description": "NamedValue was successfully updated.",
"schema": {
"$ref": "./definitions.json#/definitions/PropertyContract"
"$ref": "./definitions.json#/definitions/NamedValueContract"
},
"headers": {
"ETag": {
Expand All @@ -267,13 +267,13 @@
},
"patch": {
"tags": [
"Property"
"NamedValue"
],
"operationId": "Property_Update",
"description": "Updates the specific property.",
"operationId": "NamedValue_Update",
"description": "Updates the specific NamedValue.",
"x-ms-examples": {
"ApiManagementUpdateProperty": {
"$ref": "./examples/ApiManagementUpdateProperty.json"
"ApiManagementUpdateNamedValue": {
"$ref": "./examples/ApiManagementUpdateNamedValue.json"
}
},
"parameters": [
Expand All @@ -284,14 +284,14 @@
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/PropertyIdParameter"
"$ref": "./apimanagement.json#/parameters/NamedValueIdParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "./definitions.json#/definitions/PropertyUpdateParameters"
"$ref": "./definitions.json#/definitions/NamedValueUpdateParameters"
},
"description": "Update parameters."
},
Expand All @@ -307,7 +307,7 @@
],
"responses": {
"204": {
"description": "Property was successfully updated."
"description": "NamedValue was successfully updated."
},
"default": {
"description": "Error response describing why the operation failed.",
Expand All @@ -319,13 +319,13 @@
},
"delete": {
"tags": [
"Property"
"NamedValue"
],
"operationId": "Property_Delete",
"description": "Deletes specific property from the API Management service instance.",
"operationId": "NamedValue_Delete",
"description": "Deletes specific NamedValue from the API Management service instance.",
"x-ms-examples": {
"ApiManagementDeleteProperty": {
"$ref": "./examples/ApiManagementDeleteProperty.json"
"ApiManagementDeleteNamedValue": {
"$ref": "./examples/ApiManagementDeleteNamedValue.json"
}
},
"parameters": [
Expand All @@ -336,7 +336,7 @@
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/PropertyIdParameter"
"$ref": "./apimanagement.json#/parameters/NamedValueIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter"
Expand All @@ -350,10 +350,10 @@
],
"responses": {
"200": {
"description": "Property was successfully deleted."
"description": "NamedValue was successfully deleted."
},
"204": {
"description": "Property was successfully deleted."
"description": "NamedValue was successfully deleted."
},
"default": {
"description": "Error response describing why the operation failed.",
Expand Down
Loading