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

Documentation fixes for a preview API #27350

Merged
merged 16 commits into from
Jan 17, 2024
+27 −29
Merged

Documentation fixes for a preview API #27350

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
9273ff4
Fixed create package examples.
mahakjain314 Jan 11, 2024
69f1489
Fixed examples for Get Package
mahakjain314 Jan 11, 2024
f325f69
Updated examples for update package
mahakjain314 Jan 11, 2024
96f139c
Updated examples for List packages
mahakjain314 Jan 11, 2024
0a42523
Update createRuntimeEnvironment.json
mahakjain314 Jan 11, 2024
e1b986d
Update getRuntimeEnvironment.json
mahakjain314 Jan 11, 2024
80ec664
Update listRuntimeEnvironmentsByAutomationAccount.json
mahakjain314 Jan 11, 2024
9da8076
Update updateRuntimeEnvironment.json
mahakjain314 Jan 11, 2024
8d7d084
Update createRuntimeEnvironment.json
mahakjain314 Jan 15, 2024
aab6f73
Update getRuntimeEnvironment.json
mahakjain314 Jan 15, 2024
64b7449
Update listRuntimeEnvironmentsByAutomationAccount.json
mahakjain314 Jan 15, 2024
b158358
Update updateRuntimeEnvironment.json
mahakjain314 Jan 15, 2024
1e7d023
Update createOrUpdatePackage.json
mahakjain314 Jan 15, 2024
455527d
Update getPackage.json
mahakjain314 Jan 15, 2024
594797b
Update listPackagesByRuntimeEnvironment.json
mahakjain314 Jan 15, 2024
3747f39
Update updatePackage.json
mahakjain314 Jan 15, 2024
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
11 changes: 5 additions & 6 deletions ...crosoft.Automation/preview/2023-05-15-preview/examples/package/createOrUpdatePackage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@
"contentHash": {
"algorithm": "sha265",
"value": "07E108A962B81DD9C9BAA89BB47C0F6EE52B29E83758B07795E408D258B2B87A"
},
"version": "1.0.0.0"
}
}
}
}
Expand All @@ -23,9 +22,9 @@
"201": {
"headers": {},
"body": {
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/OmsCompositeResources",
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/runtimeEnvironmentName/packages/OmsCompositeResources",
"name": "OmsCompositeResources",
"type": "Microsoft.Automation/AutomationAccounts/Modules",
"type": "Microsoft.Automation/AutomationAccounts/RuntimeEnvironments/Packages",
Copy link
Member

Choose a reason for hiding this comment

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

RuntimeEnvironments

Your service should not be uppercasing the resource type. Resource type names use camelCasing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have updated the casing for resource type names to camelcasing.

"location": "East US 2",
"tags": {},
"properties": {
Expand All @@ -47,9 +46,9 @@
"200": {
"headers": {},
"body": {
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/OmsCompositeResources",
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/runtimeEnvironmentName/packages/OmsCompositeResources",
"name": "OmsCompositeResources",
"type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironmentss/Package",
"type": "Microsoft.Automation/AutomationAccounts/RuntimeEnvironments/Packages",
"location": "East US 2",
"tags": {},
"properties": {
Expand Down
10 changes: 5 additions & 5 deletions ...-manager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/getPackage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@
"200": {
"headers": {},
"body": {
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/myEnv/packages/OmsCompositeResources",
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/runtimeEnvironmentName/packages/OmsCompositeResources",
"name": "OmsCompositeResources",
"type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironmentss/Package",
"type": "Microsoft.Automation/AutomationAccounts/RuntimeEnvironments/Packages",
"location": "East US 2",
"tags": {},
"properties": {
"default": false,
"version": null,
"sizeInBytes": 0,
"provisioningState": "Creating"
"version": "1.0.0",
"sizeInBytes": 1560,
"provisioningState": "Succeeded"
},
"systemData": {
"createdAt": "2023-07-05T07:32:41.4389914+00:00",
Expand Down
10 changes: 5 additions & 5 deletions ...omation/preview/2023-05-15-preview/examples/package/listPackagesByRuntimeEnvironment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
"body": {
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/myEnv/packages/OmsCompositeResources",
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/runtimeEnvironmentName/packages/OmsCompositeResources",
"name": "OmsCompositeResources",
"type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironmentss/Package",
"type": "Microsoft.Automation/AutomationAccounts/RuntimeEnvironments/Packages",
"location": "East US 2",
"tags": {},
"properties": {
Expand All @@ -33,9 +33,9 @@
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/myEnv/packages/OmsCompositeResources2",
"name": "OmsCompositeResources",
"type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironmentss/Package",
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/runtimeEnvironmentName/packages/OmsCompositeResources2",
"name": "OmsCompositeResources2",
"type": "Microsoft.Automation/AutomationAccounts/RuntimeEnvironments/Packages",
"location": "East US 2",
"tags": {},
"properties": {
Expand Down
7 changes: 3 additions & 4 deletions ...nager/Microsoft.Automation/preview/2023-05-15-preview/examples/package/updatePackage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@
"contentHash": {
"algorithm": "sha265",
"value": "07E108A962B81DD9C9BAA89BB47C0F6EE52B29E83758B07795E408D258B2B87A"
},
"version": "1.0.0.0"
}
}
}
}
Expand All @@ -23,9 +22,9 @@
"200": {
"headers": {},
"body": {
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/OmsCompositeResources",
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyAutomationAccount/runtimeEnvironments/runtimeEnvironmentName/packages/OmsCompositeResources",
"name": "OmsCompositeResources",
"type": "Microsoft.Automation/AutomationAccounts/Modules",
"type": "Microsoft.Automation/AutomationAccounts/RuntimeEnvironments/Packages",
"location": "East US 2",
"tags": {},
"properties": {
Expand Down
4 changes: 2 additions & 2 deletions ...tion/preview/2023-05-15-preview/examples/runtimeEnvironment/createRuntimeEnvironment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"body": {
"name": "myRuntimeEnvironmentName",
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName",
"type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironments",
"type": "Microsoft.Automation/AutomationAccounts/RuntimeEnvironments",
"location": "East US 2",
"tags": {},
"systemData": {
Expand All @@ -47,7 +47,7 @@
"body": {
"name": "myRuntimeEnvironmentName",
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName",
"type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironments",
"type": "Microsoft.Automation/AutomationAccounts/RuntimeEnvironments",
"location": "East US 2",
"tags": {},
"systemData": {
Expand Down
2 changes: 1 addition & 1 deletion ...omation/preview/2023-05-15-preview/examples/runtimeEnvironment/getRuntimeEnvironment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"body": {
"name": "myRuntimeEnvironmentName",
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName",
"type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironments",
"type": "Microsoft.Automation/AutomationAccounts/RuntimeEnvironments",
"location": "East US 2",
"tags": {},
"systemData": {
Expand Down
10 changes: 5 additions & 5 deletions ...05-15-preview/examples/runtimeEnvironment/listRuntimeEnvironmentsByAutomationAccount.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
{
"name": "myRuntimeEnvironmentName",
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName",
"type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironments",
"type": "Microsoft.Automation/AutomationAccounts/RuntimeEnvironments",
"location": "East US 2",
"tags": {},
"systemData": {
Expand All @@ -23,7 +23,7 @@
"properties": {
"runtime": {
"language": "PowerShell",
"version": "7.1"
"version": "5.1"
},
"defaultPackages": {
"Az": "6.*"
Expand All @@ -34,7 +34,7 @@
{
"name": "myRuntimeEnvironmentName2",
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName2",
"type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironments",
"type": "Microsoft.Automation/AutomationAccounts/RuntimeEnvironments",
"location": "East US 2",
"tags": {},
"systemData": {
Expand All @@ -55,7 +55,7 @@
{
"name": "myRuntimeEnvironmentName3",
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName3",
"type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironments",
"type": "Microsoft.Automation/AutomationAccounts/RuntimeEnvironments",
"location": "East US 2",
"tags": {},
"systemData": {
Expand All @@ -65,7 +65,7 @@
"properties": {
"runtime": {
"language": "PowerShell",
"version": "7.1"
"version": "7.2"
},
"defaultPackages": {
"Az": "6.*"
Expand Down
2 changes: 1 addition & 1 deletion ...tion/preview/2023-05-15-preview/examples/runtimeEnvironment/updateRuntimeEnvironment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"body": {
"name": "myRuntimeEnvironmentName",
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName",
"type": "Microsoft.Automation/AutomationAccounts/runtimeEnvironments",
"type": "Microsoft.Automation/AutomationAccounts/RuntimeEnvironments",
"location": "East US 2",
"tags": {},
"properties": {
Expand Down