Skip to content
This repository has been archived by the owner on May 5, 2023. It is now read-only.

[AutoPR servicefabric/data-plane] Add Service Fabric 6.3 REST API specs remove unsupported versions #3217

Merged
merged 1 commit into from
Jul 25, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ const models = require('./index');
* - Limiting the custom capacity metrics to limit the total consumption of
* this metric by the services of this application
*
*
*/
class ApplicationCapacityDescription {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ const models = require('./index');
* Defines the application health policy map used to evaluate the health of an
* application or one of its children entities.
*
*
*/
class ApplicationHealthPolicies {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ const models = require('./index');
* Defines a health policy used to evaluate the health of an application or one
* of its children entities.
*
*
*/
class ApplicationHealthPolicy {
/**
Expand All @@ -32,7 +33,8 @@ class ApplicationHealthPolicy {
* applications over the number of nodes where the application is currently
* deployed on in the cluster.
* The computation rounds up to tolerate one failure on small numbers of
* nodes. Default percentage is zero. Default value: 0 .
* nodes. Default percentage is zero.
* . Default value: 0 .
* @member {object} [defaultServiceTypeHealthPolicy] The health policy used
* by default to evaluate the health of a service type.
* @member {number}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ const models = require('./index');
/**
* Defines an item in ApplicationHealthPolicyMap.
*
*
*/
class ApplicationHealthPolicyMapItem {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ const models = require('./index');
* Represents the health state of an application, which contains the
* application identifier and the aggregated health state.
*
*
* @extends models['EntityHealthState']
*/
class ApplicationHealthState extends models['EntityHealthState'] {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ const models = require('./index');
* aggregated health state and any children services and deployed applications
* that respect the filters in cluster health chunk query description.
*
*
* @extends models['EntityHealthStateChunk']
*/
class ApplicationHealthStateChunk extends models['EntityHealthStateChunk'] {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ const models = require('./index');
* input filters in the chunk query. Returned by get cluster health state
* chunks query.
*
*
* @extends models['EntityHealthStateChunkList']
*/
class ApplicationHealthStateChunkList extends models['EntityHealthStateChunkList'] {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ const models = require('./index');
* One filter can match zero, one or multiple applications, depending on its
* properties.
*
*
*/
class ApplicationHealthStateFilter {
/**
Expand Down Expand Up @@ -50,7 +51,7 @@ class ApplicationHealthStateFilter {
* If not specified, default value is None, unless the application name or
* the application type name are specified. If the filter has default value
* and application name is specified, the matching application is returned.
* The state values are flag based enumeration, so the value could be a
* The state values are flag-based enumeration, so the value could be a
* combination of these values obtained using bitwise 'OR' operator.
* For example, if the provided value is 6, it matches applications with
* HealthState value of OK (2) and Warning (4).
Expand All @@ -65,7 +66,8 @@ class ApplicationHealthStateFilter {
* - Error - Filter that matches input with HealthState value Error. The
* value is 8.
* - All - Filter that matches input with any HealthState value. The value is
* 65535. Default value: 0 .
* 65535.
* . Default value: 0 .
* @member {array} [serviceFilters] Defines a list of filters that specify
* which services to be included in the returned cluster health chunk as
* children of the application. The services are returned only if the parent
Expand Down
8 changes: 5 additions & 3 deletions lib/services/serviceFabric/lib/models/applicationInfo.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,18 @@ class ApplicationInfo {
* application manifest.
* @member {string} [typeVersion] The version of the application type as
* defined in the application manifest.
* @member {string} [status] The status of the application. Possible values
* include: 'Invalid', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'
* @member {string} [status] The status of the application.
* . Possible values include: 'Invalid', 'Ready', 'Upgrading', 'Creating',
* 'Deleting', 'Failed'
* @member {array} [parameters] List of application parameters with
* overridden values from their default values specified in the application
* manifest.
* @member {string} [healthState] The health state of a Service Fabric entity
* such as Cluster, Node, Application, Service, Partition, Replica etc.
* Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
* @member {string} [applicationDefinitionKind] The mechanism used to define
* a Service Fabric application. Possible values include: 'Invalid',
* a Service Fabric application.
* . Possible values include: 'Invalid',
* 'ServiceFabricApplicationDescription', 'Compose'
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
* can be used to limit the total consumption of this metric by the services of
* this application.
*
*
*/
class ApplicationMetricDescription {
/**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
* regenerated.
*/

'use strict';

const models = require('./index');

/**
* Describes a service fabric application resource.
*
*/
class ApplicationResourceDescription {
/**
* Create a ApplicationResourceDescription.
* @member {string} [description] User readable description of the
* application.
* @member {string} [debugParams] Internal use.
* @member {array} [services] describes the services in the application.
* @member {string} [healthState] Describes the health state of an
* application resource. Possible values include: 'Invalid', 'Ok', 'Warning',
* 'Error', 'Unknown'
* @member {string} [unhealthyEvaluation] When the application's health state
* is not 'Ok', this additional details from service fabric Health Manager
* for the user to know why the application is marked unhealthy.
* @member {string} [status] Status of the application resource. Possible
* values include: 'Invalid', 'Ready', 'Upgrading', 'Creating', 'Deleting',
* 'Failed'
* @member {string} [statusDetails] Gives additional information about the
* current status of the application deployment.
* @member {array} [serviceNames] Names of the services in the application.
* @member {object} [diagnostics] Describes the diagnostics definition and
* usage for an application resource.
* @member {array} [diagnostics.sinks] List of supported sinks that can be
* referenced.
* @member {boolean} [diagnostics.enabled] Status of whether or not sinks are
* enabled.
* @member {array} [diagnostics.defaultSinkRefs] The sinks to be used if
* diagnostics is enabled. Sink choices can be overridden at the service and
* code package level.
* @member {string} name Application resource name.
*/
constructor() {
}

/**
* Defines the metadata of ApplicationResourceDescription
*
* @returns {object} metadata of ApplicationResourceDescription
*
*/
mapper() {
return {
required: false,
serializedName: 'ApplicationResourceDescription',
type: {
name: 'Composite',
className: 'ApplicationResourceDescription',
modelProperties: {
description: {
required: false,
serializedName: 'properties.description',
type: {
name: 'String'
}
},
debugParams: {
required: false,
serializedName: 'properties.debugParams',
type: {
name: 'String'
}
},
services: {
required: false,
serializedName: 'properties.services',
type: {
name: 'Sequence',
element: {
required: false,
serializedName: 'ServiceResourceDescriptionElementType',
type: {
name: 'Composite',
className: 'ServiceResourceDescription'
}
}
}
},
healthState: {
required: false,
readOnly: true,
serializedName: 'properties.healthState',
type: {
name: 'String'
}
},
unhealthyEvaluation: {
required: false,
readOnly: true,
serializedName: 'properties.unhealthyEvaluation',
type: {
name: 'String'
}
},
status: {
required: false,
readOnly: true,
serializedName: 'properties.status',
type: {
name: 'String'
}
},
statusDetails: {
required: false,
readOnly: true,
serializedName: 'properties.statusDetails',
type: {
name: 'String'
}
},
serviceNames: {
required: false,
readOnly: true,
serializedName: 'properties.serviceNames',
type: {
name: 'Sequence',
element: {
required: false,
serializedName: 'StringElementType',
type: {
name: 'String'
}
}
}
},
diagnostics: {
required: false,
serializedName: 'properties.diagnostics',
type: {
name: 'Composite',
className: 'DiagnosticsDescription'
}
},
name: {
required: true,
serializedName: 'name',
type: {
name: 'String'
}
}
}
}
};
}
}

module.exports = ApplicationResourceDescription;
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
/**
* Defines an item in ApplicationTypeHealthPolicyMap.
*
*
*/
class ApplicationTypeHealthPolicyMapItem {
/**
Expand Down
11 changes: 6 additions & 5 deletions lib/services/serviceFabric/lib/models/applicationTypeInfo.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,15 @@ class ApplicationTypeInfo {
* in the application manifest.
* @member {array} [defaultParameterList] List of application type parameters
* that can be overridden when creating or updating the application.
* @member {string} [status] The status of the application type. Possible
* values include: 'Invalid', 'Provisioning', 'Available', 'Unprovisioning',
* 'Failed'
* @member {string} [status] The status of the application type.
* . Possible values include: 'Invalid', 'Provisioning', 'Available',
* 'Unprovisioning', 'Failed'
* @member {string} [statusDetails] Additional detailed information about the
* status of the application type.
* @member {string} [applicationTypeDefinitionKind] The mechanism used to
* define a Service Fabric application type. Possible values include:
* 'Invalid', 'ServiceFabricApplicationPackage', 'Compose'
* define a Service Fabric application type.
* . Possible values include: 'Invalid', 'ServiceFabricApplicationPackage',
* 'Compose'
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@
const models = require('./index');

/**
* Describes the parameters for an application upgrade. Please note that
* upgrade description replaces the existing application description. This
* means that if the parameters are not specified, the existing parameters on
* the applications will be overwritten with the empty parameters list. This
* would results in application using the default value of the parameters from
* the application manifest. If you do not want to change any existing
* parameter values, please get the application parameters first using the
* Describes the parameters for an application upgrade. Note that upgrade
* description replaces the existing application description. This means that
* if the parameters are not specified, the existing parameters on the
* applications will be overwritten with the empty parameters list. This would
* result in the application using the default value of the parameters from the
* application manifest. If you do not want to change any existing parameter
* values, please get the application parameters first using the
* GetApplicationInfo query and then supply those values as Parameters in this
* ApplicationUpgradeDescription.
*
Expand Down Expand Up @@ -59,7 +59,8 @@ class ApplicationUpgradeDescription {
* Invalid indicates the failure action is invalid. Rollback specifies that
* the upgrade will start rolling back automatically.
* Manual indicates that the upgrade will switch to UnmonitoredManual upgrade
* mode. Possible values include: 'Invalid', 'Rollback', 'Manual'
* mode.
* . Possible values include: 'Invalid', 'Rollback', 'Manual'
* @member {string} [monitoringPolicy.healthCheckWaitDurationInMilliseconds]
* The amount of time to wait after completing an upgrade domain before
* applying health policies. It is first interpreted as a string representing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,14 @@ class ApplicationUpgradeProgressInfo {
* 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value:
* 'UnmonitoredAuto' .
* @member {object} [upgradeDescription] Describes the parameters for an
* application upgrade. Please note that upgrade description replaces the
* existing application description. This means that if the parameters are
* not specified, the existing parameters on the applications will be
* overwritten with the empty parameters list. This would results in
* application using the default value of the parameters from the application
* manifest. If you do not want to change any existing parameter values,
* please get the application parameters first using the GetApplicationInfo
* query and then supply those values as Parameters in this
* ApplicationUpgradeDescription.
* application upgrade. Note that upgrade description replaces the existing
* application description. This means that if the parameters are not
* specified, the existing parameters on the applications will be overwritten
* with the empty parameters list. This would result in the application using
* the default value of the parameters from the application manifest. If you
* do not want to change any existing parameter values, please get the
* application parameters first using the GetApplicationInfo query and then
* supply those values as Parameters in this ApplicationUpgradeDescription.
* @member {string} [upgradeDescription.name] The name of the target
* application, including the 'fabric:' URI scheme.
* @member {string} [upgradeDescription.targetApplicationTypeVersion] The
Expand Down Expand Up @@ -83,7 +82,8 @@ class ApplicationUpgradeProgressInfo {
* Invalid indicates the failure action is invalid. Rollback specifies that
* the upgrade will start rolling back automatically.
* Manual indicates that the upgrade will switch to UnmonitoredManual upgrade
* mode. Possible values include: 'Invalid', 'Rollback', 'Manual'
* mode.
* . Possible values include: 'Invalid', 'Rollback', 'Manual'
* @member {string}
* [upgradeDescription.monitoringPolicy.healthCheckWaitDurationInMilliseconds]
* The amount of time to wait after completing an upgrade domain before
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,8 @@ class ApplicationUpgradeUpdateDescription {
* Invalid indicates the failure action is invalid. Rollback specifies that
* the upgrade will start rolling back automatically.
* Manual indicates that the upgrade will switch to UnmonitoredManual upgrade
* mode. Possible values include: 'Invalid', 'Rollback', 'Manual'
* mode.
* . Possible values include: 'Invalid', 'Rollback', 'Manual'
* @member {string} [updateDescription.healthCheckWaitDurationInMilliseconds]
* The amount of time to wait after completing an upgrade domain before
* applying health policies. It is first interpreted as a string representing
Expand Down
Loading