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

Fix Swagger Linting Error for Microsoft.Features #3841

Merged
merged 3 commits into from
Sep 19, 2018
Merged

Fix Swagger Linting Error for Microsoft.Features #3841

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a6405d
Fix Swagger Linting Error for Microsoft.Features
Sep 7, 2018
8df7edd
Merge branch 'master' of https://github.com/Azure/azure-rest-api-spec…
Sep 7, 2018
79862aa
Remove additional properties in examples
Sep 7, 2018
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
21 changes: 21 additions & 0 deletions .../resources/resource-manager/Microsoft.Features/stable/2015-12-01/examples/getFeature.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"parameters": {
"resourceProviderNamespace": "Resource Provider Namespace",
"featureName": "feature",
"api-version": "2015-12-01",
"subscriptionId": "subid"
},
"responses": {
"200": {
"headers": {},
"body": {
"name": "Feature1",
"properties": {
"state": "registered"
},
"id": "feature_id1",
"type": "type1"
}
}
}
}
30 changes: 30 additions & 0 deletions ...esource-manager/Microsoft.Features/stable/2015-12-01/examples/listFeaturesOperations.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"parameters": {
"api-version": "2015-12-01"
},
"responses": {
"200": {
"headers": {},
"body": {
"value": [
{
"name": "FeaturesOpeartion1",
"display": {
"provider": "Microsoft.ResourceProvider",
"resource": "Resource1",
"operation": "Read"
}
},
{
"name": "FeaturesOpeartion2",
"display": {
"provider": "Microsoft.ResourceProvider",
"resource": "Resource2",
"operation": "Write"
}
}
]
}
}
}
}
32 changes: 32 additions & 0 deletions .../resource-manager/Microsoft.Features/stable/2015-12-01/examples/listProviderFeatures.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"parameters": {
"resourceProviderNamespace": "Resource Provider Namespace",
"api-version": "2015-12-01",
"subscriptionId": "subid"
},
"responses": {
"200": {
"headers": {},
"body": {
"value": [
{
"name": "Feature1",
"properties": {
"state": "registered"
},
"id": "feature_id1",
"type": "type1"
},
{
"name": "Feature2",
"properties": {
"state": "unregistered"
},
"id": "feature_id2",
"type": "type2"
}
]
}
}
}
}
31 changes: 31 additions & 0 deletions ...ource-manager/Microsoft.Features/stable/2015-12-01/examples/listSubscriptionFeatures.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"parameters": {
"api-version": "2015-12-01",
"subscriptionId": "subid"
},
"responses": {
"200": {
"headers": {},
"body": {
"value": [
{
"name": "Feature1",
"properties": {
"state": "registered"
},
"id": "feature_id1",
"type": "type1"
},
{
"name": "Feature2",
"properties": {
"state": "unregistered"
},
"id": "feature_id2",
"type": "type2"
}
]
}
}
}
}
21 changes: 21 additions & 0 deletions ...urces/resource-manager/Microsoft.Features/stable/2015-12-01/examples/registerFeature.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"parameters": {
"resourceProviderNamespace": "Resource Provider Namespace",
"featureName": "feature",
"api-version": "2015-12-01",
"subscriptionId": "subid"
},
"responses": {
"200": {
"headers": {},
"body": {
"name": "Feature1",
"properties": {
"state": "registered"
},
"id": "feature_id1",
"type": "type1"
}
}
}
}
93 changes: 93 additions & 0 deletions specification/resources/resource-manager/Microsoft.Features/stable/2015-12-01/features.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,48 @@
}
},
"paths": {
"/providers/Microsoft.Features/operations": {
"get": {
"tags": [
"Operations"
],
"operationId": "ListOperations",
"description": "Lists all of the available Microsoft.Features REST API operations.",
"x-ms-examples": {
"List Features operations": {
"$ref": "./examples/listFeaturesOperations.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/OperationListResult"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Features/features": {
"get": {
"tags": [
"Features"
],
"operationId": "Features_ListAll",
"description": "Gets all the preview features that are available through AFEC for the subscription.",
"x-ms-examples": {
"List subscription Features": {
"$ref": "./examples/listSubscriptionFeatures.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
Expand Down Expand Up @@ -71,6 +106,11 @@
],
"operationId": "Features_List",
"description": "Gets all the preview features in a provider namespace that are available through AFEC for the subscription.",
"x-ms-examples": {
"List provider Features": {
"$ref": "./examples/listProviderFeatures.json"
}
},
"parameters": [
{
"name": "resourceProviderNamespace",
Expand Down Expand Up @@ -106,6 +146,11 @@
],
"operationId": "Features_Get",
"description": "Gets the preview feature with the specified name.",
"x-ms-examples": {
"Get feature": {
"$ref": "./examples/getFeature.json"
}
},
"parameters": [
{
"name": "resourceProviderNamespace",
Expand Down Expand Up @@ -145,6 +190,11 @@
],
"operationId": "Features_Register",
"description": "Registers the preview feature for the subscription.",
"x-ms-examples": {
"Register feature": {
"$ref": "./examples/registerFeature.json"
}
},
"parameters": [
{
"name": "resourceProviderNamespace",
Expand Down Expand Up @@ -224,6 +274,49 @@
}
},
"description": "List of previewed features."
},
"Operation": {
"description": "Microsoft.Features operation",
"type": "object",
"properties": {
"name": {
"description": "Operation name: {provider}/{resource}/{operation}",
"type": "string"
},
"display": {
"description": "The object that represents the operation.",
"properties": {
"provider": {
"description": "Service provider: Microsoft.Features",
"type": "string"
},
"resource": {
"description": "Resource on which the operation is performed: Profile, endpoint, etc.",
"type": "string"
},
"operation": {
"description": "Operation type: Read, write, delete, etc.",
"type": "string"
Copy link
Member

Choose a reason for hiding this comment

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

Should this be an enum of specific values?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Usually, the operation type only has read, write, delete and action.

}
}
}
}
},
"OperationListResult": {
"description": "Result of the request to list Microsoft.Features operations. It contains a list of operations and a URL link to get the next set of results.",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Operation"
},
"description": "List of Microsoft.Features operations."
},
"nextLink": {
"type": "string",
"description": "URL to get the next set of operation list results if there are any."
}
}
}
},
"parameters": {
Expand Down