Spec for LineOfCredit API and other corrections (#6054)

* Added specs for Agreements API in version 2018-11-01-preview

Added specs for Agreements API in version 2018-11-01-preview

* Updated as per naming convension

Updated as per naming convension

* Corrected specs and examples for BillingRP

Corrected specs and examples for BillingRP

* Fixed the errors

Fixed the errors

* Fixing errors in spec

Fixing errors in spec

* Updated examples

Updated examples

* Incorporated review comments

Incorporated review comments

* Incorporated review comments

* Incorporated review comments

Incorporated review comments

* Updated the operation id for Billing spec

Updated the operation id for Billing spec

* Incorporated review comments

Incorporated review comments

* Incorporated review comments

Incorporated review comments

* Fixed the errors

Fixed the errors

* Added multiple inputs

Added multiple inputs

* Fixed build errors

Fixed build errors

* Incorporated review comments

Incorporated review comments

* Incorporated review comments

* Spec for LineOfCredit API and other corrections

Spec for LineOfCredit API and other corrections

* Fixed build error

* Incorporated review comments

Incorporated review comments

* Incorporated review comments

Incorporated review comments

* Updated the increase api

Updated the increase api

* Incorporated review comments

Incorporated review comments

* Updated the operation id

* Fixed errors

* Fixed errors

* Fixed error

Fixed error
This commit is contained in:
Anirban Sarkar 2019-05-30 14:55:05 -07:00 коммит произвёл Abhijeet
Родитель da98981461
Коммит 1e497e5bc4
8 изменённых файлов: 240 добавлений и 50 удалений

Просмотреть файл

@ -499,7 +499,7 @@
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/InvoiceSectionProperties"
"$ref": "#/definitions/InvoiceSectionCreationRequest"
},
"description": "Parameters supplied to the Create InvoiceSection operation."
}
@ -3308,6 +3308,106 @@
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingAccounts/default/lineOfCredit/default": {
"get": {
"tags": [
"LineOfCredits"
],
"x-ms-examples": {
"LineOfCreditBySubscription": {
"$ref": "./examples/LineOfCreditBySubscription.json"
}
},
"operationId": "LineOfCredits_Get",
"description": "Get the current line of credit.",
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/LineOfCredit"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"put": {
"tags": [
"LineOfCredits"
],
"operationId": "LineOfCredits_Update",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-examples": {
"IncreaseLineOfCreditBySubscription": {
"$ref": "./examples/IncreaseLineOfCreditBySubscription.json"
}
},
"description": "Increase the current line of credit.",
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/LineOfCredit"
},
"description": "Parameters supplied to the increase line of credit operation."
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/LineOfCredit"
}
},
"202": {
"description": "Accepted. Line of credit increase is in progress.",
"headers": {
"Location": {
"description": "Location URI to poll for result.",
"type": "string"
},
"Retry-After": {
"description": "Recommends the retryable time after receiving this.",
"type": "integer"
},
"Azure-AsyncOperation": {
"description": "URI to poll for the operation status",
"type": "string"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
}
},
"definitions": {
@ -4278,6 +4378,19 @@
}
}
},
"InvoiceSectionCreationRequest": {
"description": "The properties of an InvoiceSection.",
"properties": {
"displayName": {
"description": "The name of the InvoiceSection.",
"type": "string"
},
"billingProfileId": {
"description": "The billing profile id.",
"type": "string"
}
}
},
"InvoiceSectionListResult": {
"description": "Result of listing invoice sections.",
"properties": {
@ -5078,8 +5191,7 @@
},
"value": {
"description": "Amount value.",
"type": "number",
"readOnly": true
"type": "number"
}
}
},
@ -5222,13 +5334,11 @@
"properties": {
"principalId": {
"description": "The user's principal id that the role gets assigned to",
"type": "string",
"readOnly": true
"type": "string"
},
"billingRoleDefinitionName": {
"billingRoleDefinitionId": {
"description": "The role definition id",
"type": "string",
"readOnly": true
"type": "string"
}
}
},
@ -5474,6 +5584,54 @@
}
}
},
"LineOfCredit": {
"description": "Line of credit resource.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"properties": {
"properties": {
"description": "A line of credit.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/LineOfCreditProperties"
}
}
},
"LineOfCreditProperties": {
"description": "The properties of the line of credit.",
"properties": {
"creditLimit": {
"description": "The current credit limit.",
"$ref": "#/definitions/Amount",
"readOnly": false
},
"reason": {
"description": "The reason for the line of credit status when not approved.",
"type": "string",
"readOnly": true
},
"remainingBalance": {
"description": "Remaining balance.",
"$ref": "#/definitions/Amount",
"readOnly": true
},
"status": {
"description": "The line of credit status.",
"type": "string",
"enum": [
"Approved",
"Rejected"
],
"x-ms-enum": {
"name": "status",
"modelAsString": true
}
}
}
},
"Action": {
"description": "the action the caller allowed to do",
"type": "string",

Просмотреть файл

@ -4,7 +4,7 @@
"billingAccountName": "{billingAccountName}",
"parameters": {
"principalId": "00000000-0000-0000-0000-000000000000",
"billingRoleDefinitionName": "10000000-aaaa-bbbb-cccc-100000000000"
"billingRoleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingRoleDefinition/10000000-aaaa-bbbb-cccc-100000000000"
}
},
"responses": {

Просмотреть файл

@ -5,7 +5,7 @@
"billingProfileName": "{billingProfileName}",
"parameters": {
"principalId": "00000000-0000-0000-0000-000000000000",
"billingRoleDefinitionName": "10000000-aaaa-bbbb-cccc-100000000000"
"billingRoleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingRoleDefinition/10000000-aaaa-bbbb-cccc-100000000000"
}
},
"responses": {

Просмотреть файл

@ -5,7 +5,7 @@
"invoiceSectionName": "{invoiceSectionName}",
"parameters": {
"principalId": "00000000-0000-0000-0000-000000000000",
"billingRoleDefinitionName": "10000000-aaaa-bbbb-cccc-100000000000"
"billingRoleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingRoleDefinition/10000000-aaaa-bbbb-cccc-100000000000"
}
},
"responses": {

Просмотреть файл

@ -4,43 +4,7 @@
"billingAccountName": "{billingAccountName}",
"parameters": {
"displayName": "invoiceSection1",
"billingProfiles": [
{
"id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
"name": "11000000-0000-0000-0000-000000000000",
"type": "Microsoft.Billing/billingProfiles",
"properties": {
"displayName": "BillingProfile1",
"address": {
"companyName": "Contoso",
"firstName": "Test",
"lastName": "User",
"addressLine1": "Test Address1",
"addressLine2": "Test Address2",
"addressLine3": "Test Address3",
"city": "City",
"postalCode": "00000",
"region": "WA",
"country": "US"
},
"currency": "USD",
"enabledAzureSKUs": [
{
"skuId": "0001",
"skuDescription": "Microsoft Azure Dev/Test"
},
{
"skuId": "0002",
"skuDescription": "Microsoft Azure Standard"
}
],
"isClassic": false,
"invoiceDay": 5,
"invoiceEmailOptIn": true,
"poNumber": "ABC12345"
}
}
]
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000"
}
},
"responses": {

Просмотреть файл

@ -0,0 +1,42 @@
{
"parameters": {
"api-version": "2018-11-01-preview",
"subscriptionId": "{subscriptionId}",
"parameters": {
"properties": {
"creditLimit": {
"value": 20000.00
}
}
}
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingAccounts/default/lineOfCredit/default",
"name": "default",
"type": "Microsoft.Billing/lineOfCredit",
"properties": {
"creditLimit": {
"currency": "USD",
"value": 20000.00
},
"reason": null,
"remainingBalance": {
"currency": "USD",
"value": 6000.00
},
"status": "Approved"
}
}
},
"202": {
"headers": {
"Location": "https://management.azure.com/providers/Microsoft.Billing/operationResults/44000000-0000-0000-0000-000000000000?api-version=2018-11-01-preview",
"Retry-After": "60",
"Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/operationStatus/44000000-0000-0000-0000-000000000000?api-version=2018-11-01-preview",
"OData-EntityId": "44000000-0000-0000-0000-000000000000"
}
}
}
}

Просмотреть файл

@ -0,0 +1,27 @@
{
"parameters": {
"api-version": "2018-11-01-preview",
"subscriptionId": "{subscriptionId}"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingAccounts/default/lineOfCredit/default",
"name": "default",
"type": "Microsoft.Billing/lineOfCredit",
"properties": {
"creditLimit": {
"currency": "USD",
"value": 20000.00
},
"reason": null,
"remainingBalance": {
"currency": "USD",
"value": 6000.00
},
"status": "Approved"
}
}
}
}
}

Просмотреть файл

@ -6,8 +6,7 @@
"parameters": {
"properties": {
"displayName": "BillingProfile11",
"poNumber": "ABC12345",
"isClassic": false
"poNumber": "ABC12345"
}
}
},