From 7daacc245211b7aad08997c08cea89c31ccc8aed Mon Sep 17 00:00:00 2001 From: williamzhao87 Date: Wed, 5 Apr 2023 11:46:18 -0400 Subject: [PATCH 1/6] Updated JR swagger with maxNumberOfJobs --- .../communicationservicejobrouter.json | 49 +++++++++++-------- 1 file changed, 29 insertions(+), 20 deletions(-) diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json index d99cf4f070b0..a01df99284d2 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json @@ -162,7 +162,7 @@ "parameters": [ { "in": "query", - "name": "maxpagesize", + "name": "maxPageSize", "description": "Maximum page size", "type": "integer", "format": "int32" @@ -352,7 +352,7 @@ "parameters": [ { "in": "query", - "name": "maxpagesize", + "name": "maxPageSize", "description": "Maximum page size", "type": "integer", "format": "int32" @@ -542,7 +542,7 @@ "parameters": [ { "in": "query", - "name": "maxpagesize", + "name": "maxPageSize", "description": "Number of objects to return per page", "type": "integer", "format": "int32" @@ -1019,6 +1019,20 @@ "type": "string", "format": "date-time" }, + { + "in": "query", + "name": "scheduledBefore", + "description": "If specified, filter on jobs that was scheduled before or at given timestamp. Range: (-Inf, scheduledBefore]", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "scheduledAfter", + "description": "If specified, filter on jobs that was scheduled at or after given value. Range: [scheduledAfter, +Inf).", + "type": "string", + "format": "date-time" + }, { "in": "query", "name": "maxpagesize", @@ -1426,7 +1440,7 @@ "parameters": [ { "in": "query", - "name": "maxpagesize", + "name": "maxPageSize", "description": "Number of objects to return per page", "type": "integer", "format": "int32" @@ -1703,7 +1717,7 @@ }, { "in": "query", - "name": "maxpagesize", + "name": "maxPageSize", "description": "Number of objects to return per page", "type": "integer", "format": "int32" @@ -1836,8 +1850,7 @@ }, "CancelJobResult": { "description": "Response payload from cancelling a job", - "type": "object", - "properties": {} + "type": "object" }, "ChannelConfiguration": { "description": "Represents the capacity a job in this channel will consume from a worker", @@ -1960,8 +1973,7 @@ }, "CloseJobResult": { "description": "Response payload from closing a job", - "type": "object", - "properties": {} + "type": "object" }, "CommunicationError": { "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationError" @@ -1992,8 +2004,7 @@ }, "CompleteJobResult": { "description": "Response payload from completing a job", - "type": "object", - "properties": {} + "type": "object" }, "ConditionalQueueSelectorAttachment": { "description": "Describes a set of queue selectors that will be attached if the given condition resolves to true", @@ -2066,8 +2077,7 @@ }, "DeclineJobOfferResult": { "description": "Response payload from declining a job", - "type": "object", - "properties": {} + "type": "object" }, "DirectMapRouterRule": { "description": "A rule that return the same labels as the input labels.", @@ -2618,7 +2628,7 @@ "labelsToUpsert": { "description": "(optional) Dictionary containing the labels to update (or add if not existing) in key-value pairs", "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "x-ms-discriminator-value": "reclassify" @@ -2629,8 +2639,7 @@ }, "ReclassifyJobResult": { "description": "Response payload from reclassifying a job", - "type": "object", - "properties": {} + "type": "object" }, "RoundRobinMode": { "description": "Jobs are distributed in order to workers, starting with the worker that is after the last worker to receive a job.", @@ -2728,7 +2737,7 @@ "labels": { "description": "A set of key/value pairs that are identifying attributes used by the rules engines to make decisions.", "type": "object", - "additionalProperties": {} + "additionalProperties": { } }, "assignments": { "description": "A collection of the assignments of the job.\r\nKey is AssignmentId.", @@ -2741,7 +2750,7 @@ "tags": { "description": "A set of non-identifying attributes attached to this job", "type": "object", - "additionalProperties": {} + "additionalProperties": { } }, "notes": { "description": "Notes attached to a job, sorted by timestamp", @@ -3085,12 +3094,12 @@ "labels": { "description": "A set of key/value pairs that are identifying attributes used by the rules engines to make decisions.", "type": "object", - "additionalProperties": {} + "additionalProperties": { } }, "tags": { "description": "A set of non-identifying attributes attached to this worker.", "type": "object", - "additionalProperties": {} + "additionalProperties": { } }, "channelConfigurations": { "description": "The channel(s) this worker can handle and their impact on the workers capacity.", From 15f940cf489ae74c9d05087b0f31bf055a1bee80 Mon Sep 17 00:00:00 2001 From: Rajarshi Sarkar Date: Fri, 14 Jul 2023 13:14:55 -0700 Subject: [PATCH 2/6] sync with upstream main --- .../communicationservicejobrouter.json | 49 ++++++++----------- 1 file changed, 20 insertions(+), 29 deletions(-) diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json index a01df99284d2..d99cf4f070b0 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json @@ -162,7 +162,7 @@ "parameters": [ { "in": "query", - "name": "maxPageSize", + "name": "maxpagesize", "description": "Maximum page size", "type": "integer", "format": "int32" @@ -352,7 +352,7 @@ "parameters": [ { "in": "query", - "name": "maxPageSize", + "name": "maxpagesize", "description": "Maximum page size", "type": "integer", "format": "int32" @@ -542,7 +542,7 @@ "parameters": [ { "in": "query", - "name": "maxPageSize", + "name": "maxpagesize", "description": "Number of objects to return per page", "type": "integer", "format": "int32" @@ -1019,20 +1019,6 @@ "type": "string", "format": "date-time" }, - { - "in": "query", - "name": "scheduledBefore", - "description": "If specified, filter on jobs that was scheduled before or at given timestamp. Range: (-Inf, scheduledBefore]", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "scheduledAfter", - "description": "If specified, filter on jobs that was scheduled at or after given value. Range: [scheduledAfter, +Inf).", - "type": "string", - "format": "date-time" - }, { "in": "query", "name": "maxpagesize", @@ -1440,7 +1426,7 @@ "parameters": [ { "in": "query", - "name": "maxPageSize", + "name": "maxpagesize", "description": "Number of objects to return per page", "type": "integer", "format": "int32" @@ -1717,7 +1703,7 @@ }, { "in": "query", - "name": "maxPageSize", + "name": "maxpagesize", "description": "Number of objects to return per page", "type": "integer", "format": "int32" @@ -1850,7 +1836,8 @@ }, "CancelJobResult": { "description": "Response payload from cancelling a job", - "type": "object" + "type": "object", + "properties": {} }, "ChannelConfiguration": { "description": "Represents the capacity a job in this channel will consume from a worker", @@ -1973,7 +1960,8 @@ }, "CloseJobResult": { "description": "Response payload from closing a job", - "type": "object" + "type": "object", + "properties": {} }, "CommunicationError": { "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationError" @@ -2004,7 +1992,8 @@ }, "CompleteJobResult": { "description": "Response payload from completing a job", - "type": "object" + "type": "object", + "properties": {} }, "ConditionalQueueSelectorAttachment": { "description": "Describes a set of queue selectors that will be attached if the given condition resolves to true", @@ -2077,7 +2066,8 @@ }, "DeclineJobOfferResult": { "description": "Response payload from declining a job", - "type": "object" + "type": "object", + "properties": {} }, "DirectMapRouterRule": { "description": "A rule that return the same labels as the input labels.", @@ -2628,7 +2618,7 @@ "labelsToUpsert": { "description": "(optional) Dictionary containing the labels to update (or add if not existing) in key-value pairs", "type": "object", - "additionalProperties": { } + "additionalProperties": {} } }, "x-ms-discriminator-value": "reclassify" @@ -2639,7 +2629,8 @@ }, "ReclassifyJobResult": { "description": "Response payload from reclassifying a job", - "type": "object" + "type": "object", + "properties": {} }, "RoundRobinMode": { "description": "Jobs are distributed in order to workers, starting with the worker that is after the last worker to receive a job.", @@ -2737,7 +2728,7 @@ "labels": { "description": "A set of key/value pairs that are identifying attributes used by the rules engines to make decisions.", "type": "object", - "additionalProperties": { } + "additionalProperties": {} }, "assignments": { "description": "A collection of the assignments of the job.\r\nKey is AssignmentId.", @@ -2750,7 +2741,7 @@ "tags": { "description": "A set of non-identifying attributes attached to this job", "type": "object", - "additionalProperties": { } + "additionalProperties": {} }, "notes": { "description": "Notes attached to a job, sorted by timestamp", @@ -3094,12 +3085,12 @@ "labels": { "description": "A set of key/value pairs that are identifying attributes used by the rules engines to make decisions.", "type": "object", - "additionalProperties": { } + "additionalProperties": {} }, "tags": { "description": "A set of non-identifying attributes attached to this worker.", "type": "object", - "additionalProperties": { } + "additionalProperties": {} }, "channelConfigurations": { "description": "The channel(s) this worker can handle and their impact on the workers capacity.", From f36d07c16145a5447491c9e0a0a606d0ae5e357b Mon Sep 17 00:00:00 2001 From: Rajarshi Sarkar Date: Fri, 14 Jul 2023 13:40:18 -0700 Subject: [PATCH 3/6] add descriptions --- .../communicationservicejobrouter.json | 41 +++++++++---------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json index d99cf4f070b0..a64fb5e1504f 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json @@ -1698,7 +1698,7 @@ { "in": "query", "name": "hasCapacity", - "description": "If set to true, select only workers who have capacity for the channel specified by `channelId` or for any channel\r\n if `channelId` not specified. If set to false, then will return all workers including workers without any capacity for jobs. Defaults to false.", + "description": "If set to true, select only workers who have capacity for the channel specified by `channelId` or for any channel if `channelId` not specified. If set to false, then will return all workers including workers without any capacity for jobs. Defaults to false.", "type": "boolean" }, { @@ -1802,7 +1802,7 @@ "type": "string" }, "note": { - "description": "(Optional) A note that will be appended to the jobs' Notes collection with th current timestamp.", + "description": "(Optional) A note that will be appended to the jobs' Notes collection with the current timestamp.", "maxLength": 2000, "minLength": 0, "type": "string" @@ -1836,8 +1836,7 @@ }, "CancelJobResult": { "description": "Response payload from cancelling a job", - "type": "object", - "properties": {} + "type": "object" }, "ChannelConfiguration": { "description": "Represents the capacity a job in this channel will consume from a worker", @@ -1960,8 +1959,7 @@ }, "CloseJobResult": { "description": "Response payload from closing a job", - "type": "object", - "properties": {} + "type": "object" }, "CommunicationError": { "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationError" @@ -1992,8 +1990,7 @@ }, "CompleteJobResult": { "description": "Response payload from completing a job", - "type": "object", - "properties": {} + "type": "object" }, "ConditionalQueueSelectorAttachment": { "description": "Describes a set of queue selectors that will be attached if the given condition resolves to true", @@ -2066,8 +2063,7 @@ }, "DeclineJobOfferResult": { "description": "Response payload from declining a job", - "type": "object", - "properties": {} + "type": "object" }, "DirectMapRouterRule": { "description": "A rule that return the same labels as the input labels.", @@ -2355,10 +2351,11 @@ } }, "JobMatchingMode": { - "description": "", + "description": "The matching mode to be applied to this job.\r\n \r\nSupported types:\r\n \r\nQueueAndMatchMode: Used when matching worker to a job is required to be done right after job is queued.\r\nScheduleAndSuspendMode: Used for scheduling jobs to be queued at a future time. At specified time, matching of a worker to the job will not start automatically.\r\nSuspendMode: Used when matching workers to a job needs to be suspended.", "type": "object", "properties": { "modeType": { + "description": "Discriminator value used to differentiate between supported matching mode types.", "enum": [ "queueAndMatchMode", "scheduleAndSuspendMode", @@ -2535,7 +2532,7 @@ "x-ms-discriminator-value": "pass-through" }, "QueueAndMatchMode": { - "description": "", + "description": "Describes a matching mode where matching worker to a job is automatically started after job is queued successfully.", "type": "object" }, "QueueLengthExceptionTrigger": { @@ -2618,7 +2615,7 @@ "labelsToUpsert": { "description": "(optional) Dictionary containing the labels to update (or add if not existing) in key-value pairs", "type": "object", - "additionalProperties": {} + "additionalProperties": { } } }, "x-ms-discriminator-value": "reclassify" @@ -2629,8 +2626,7 @@ }, "ReclassifyJobResult": { "description": "Response payload from reclassifying a job", - "type": "object", - "properties": {} + "type": "object" }, "RoundRobinMode": { "description": "Jobs are distributed in order to workers, starting with the worker that is after the last worker to receive a job.", @@ -2728,7 +2724,7 @@ "labels": { "description": "A set of key/value pairs that are identifying attributes used by the rules engines to make decisions.", "type": "object", - "additionalProperties": {} + "additionalProperties": { } }, "assignments": { "description": "A collection of the assignments of the job.\r\nKey is AssignmentId.", @@ -2741,7 +2737,7 @@ "tags": { "description": "A set of non-identifying attributes attached to this job", "type": "object", - "additionalProperties": {} + "additionalProperties": { } }, "notes": { "description": "Notes attached to a job, sorted by timestamp", @@ -2921,7 +2917,7 @@ "labels": { "description": "A set of key/value pairs that are identifying attributes used by the rules engines to make decisions.", "type": "object", - "additionalProperties": {} + "additionalProperties": { } }, "exceptionPolicyId": { "description": "(Optional) The ID of the exception policy that determines various job escalation rules.", @@ -3085,12 +3081,12 @@ "labels": { "description": "A set of key/value pairs that are identifying attributes used by the rules engines to make decisions.", "type": "object", - "additionalProperties": {} + "additionalProperties": { } }, "tags": { "description": "A set of non-identifying attributes attached to this worker.", "type": "object", - "additionalProperties": {} + "additionalProperties": { } }, "channelConfigurations": { "description": "The channel(s) this worker can handle and their impact on the workers capacity.", @@ -3298,10 +3294,12 @@ "x-ms-discriminator-value": "rule-engine" }, "ScheduleAndSuspendMode": { + "description": "Describes a matching mode used for scheduling jobs to be queued at a future time.\r\nAt the specified time, matching worker to a job will not start automatically.", "type": "object", "properties": { "scheduleAt": { "format": "date-time", + "description": "Scheduled time.", "type": "string" } } @@ -3405,6 +3403,7 @@ "x-ms-discriminator-value": "static" }, "SuspendMode": { + "description": "Describes a matching mode where matching worker to a job is suspended.", "type": "object" }, "UnassignJobRequest": { @@ -3412,7 +3411,7 @@ "type": "object", "properties": { "suspendMatching": { - "description": "If WaitForActivation is true, then the job is not queued for re-matching with a worker.", + "description": "If SuspendMatching is true, then the job is not queued for re-matching with a worker.", "type": "boolean" } } From 60d15a980304d910e4db5b68a8fe6a90a1475264 Mon Sep 17 00:00:00 2001 From: Rajarshi Sarkar Date: Fri, 14 Jul 2023 13:48:27 -0700 Subject: [PATCH 4/6] prettier fix --- .../communicationservicejobrouter.json | 27 +++++++++++-------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json index a64fb5e1504f..cc0b576dd955 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json @@ -1836,7 +1836,8 @@ }, "CancelJobResult": { "description": "Response payload from cancelling a job", - "type": "object" + "type": "object", + "properties": {} }, "ChannelConfiguration": { "description": "Represents the capacity a job in this channel will consume from a worker", @@ -1959,7 +1960,8 @@ }, "CloseJobResult": { "description": "Response payload from closing a job", - "type": "object" + "type": "object", + "properties": {} }, "CommunicationError": { "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationError" @@ -1990,7 +1992,8 @@ }, "CompleteJobResult": { "description": "Response payload from completing a job", - "type": "object" + "type": "object", + "properties": {} }, "ConditionalQueueSelectorAttachment": { "description": "Describes a set of queue selectors that will be attached if the given condition resolves to true", @@ -2063,7 +2066,8 @@ }, "DeclineJobOfferResult": { "description": "Response payload from declining a job", - "type": "object" + "type": "object", + "properties": {} }, "DirectMapRouterRule": { "description": "A rule that return the same labels as the input labels.", @@ -2615,7 +2619,7 @@ "labelsToUpsert": { "description": "(optional) Dictionary containing the labels to update (or add if not existing) in key-value pairs", "type": "object", - "additionalProperties": { } + "additionalProperties": {} } }, "x-ms-discriminator-value": "reclassify" @@ -2626,7 +2630,8 @@ }, "ReclassifyJobResult": { "description": "Response payload from reclassifying a job", - "type": "object" + "type": "object", + "properties": {} }, "RoundRobinMode": { "description": "Jobs are distributed in order to workers, starting with the worker that is after the last worker to receive a job.", @@ -2724,7 +2729,7 @@ "labels": { "description": "A set of key/value pairs that are identifying attributes used by the rules engines to make decisions.", "type": "object", - "additionalProperties": { } + "additionalProperties": {} }, "assignments": { "description": "A collection of the assignments of the job.\r\nKey is AssignmentId.", @@ -2737,7 +2742,7 @@ "tags": { "description": "A set of non-identifying attributes attached to this job", "type": "object", - "additionalProperties": { } + "additionalProperties": {} }, "notes": { "description": "Notes attached to a job, sorted by timestamp", @@ -2917,7 +2922,7 @@ "labels": { "description": "A set of key/value pairs that are identifying attributes used by the rules engines to make decisions.", "type": "object", - "additionalProperties": { } + "additionalProperties": {} }, "exceptionPolicyId": { "description": "(Optional) The ID of the exception policy that determines various job escalation rules.", @@ -3081,12 +3086,12 @@ "labels": { "description": "A set of key/value pairs that are identifying attributes used by the rules engines to make decisions.", "type": "object", - "additionalProperties": { } + "additionalProperties": {} }, "tags": { "description": "A set of non-identifying attributes attached to this worker.", "type": "object", - "additionalProperties": { } + "additionalProperties": {} }, "channelConfigurations": { "description": "The channel(s) this worker can handle and their impact on the workers capacity.", From 2ff0587d9753b2b567554b90895cfa915145ccb4 Mon Sep 17 00:00:00 2001 From: Rajarshi Sarkar Date: Fri, 14 Jul 2023 15:18:51 -0700 Subject: [PATCH 5/6] add more missing descriptions --- .../communicationservicejobrouter.json | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json index cc0b576dd955..c6d51d69b1ce 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json @@ -1778,6 +1778,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing BestWorkerMode", "type": "string" }, "scoringRule": { @@ -1799,6 +1800,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing CancelExceptionAction", "type": "string" }, "note": { @@ -2009,6 +2011,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing ConditionalQueueSelectorAttachment", "type": "string" }, "condition": { @@ -2038,6 +2041,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing ConditionalWorkerSelectorAttachment", "type": "string" }, "condition": { @@ -2079,6 +2083,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing DirectMapRouterRule", "type": "string" } }, @@ -2282,6 +2287,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing ExpressionRouterRule", "type": "string" }, "language": { @@ -2317,6 +2323,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing FunctionRouterRule", "type": "string" }, "functionUri": { @@ -2392,6 +2399,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing LongestIdleMode", "type": "string" } }, @@ -2407,6 +2415,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing ManualReclassifyExceptionAction", "type": "string" }, "queueId": { @@ -2462,6 +2471,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing PassThroughQueueSelectorAttachment", "type": "string" }, "key": { @@ -2503,6 +2513,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing PassThroughWorkerSelectorAttachment", "type": "string" }, "key": { @@ -2552,6 +2563,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing a sub-type of QueueLengthExceptionTrigger", "type": "string" }, "threshold": { @@ -2608,6 +2620,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing ReclassifyExceptionAction.", "type": "string" }, "classificationPolicyId": { @@ -2643,6 +2656,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing RoundRobinMode", "type": "string" } }, @@ -3054,6 +3068,7 @@ "type": "object", "properties": { "id": { + "description": "Id of the worker.", "type": "string", "readOnly": true }, @@ -3269,6 +3284,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing RuleEngineQueueSelectorAttachment", "type": "string" }, "rule": { @@ -3290,6 +3306,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing RuleEngineWorkerSelectorAttachment", "type": "string" }, "rule": { @@ -3357,6 +3374,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing StaticQueueSelectorAttachment", "type": "string" }, "queueSelector": { @@ -3375,6 +3393,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing StaticRouterRule", "type": "string" }, "value": { @@ -3399,6 +3418,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing StaticWorkerSelectorAttachment", "type": "string" }, "workerSelector": { @@ -3454,6 +3474,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing a sub-type of WaitTimeExceptionTrigger", "type": "string" }, "thresholdSeconds": { @@ -3474,6 +3495,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing WebhookRouterRule", "type": "string" }, "authorizationServerUri": { @@ -3505,6 +3527,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing WeightedAllocationQueueSelectorAttachment", "type": "string" }, "allocations": { @@ -3530,6 +3553,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing WeightedAllocationWorkerSelectorAttachment", "type": "string" }, "allocations": { From 5ee7b4c49d607e59bb62bc75ca893dc74fa9dc86 Mon Sep 17 00:00:00 2001 From: Rajarshi Sarkar Date: Fri, 14 Jul 2023 15:42:19 -0700 Subject: [PATCH 6/6] add more description fixes --- .../communicationservicejobrouter.json | 126 +++++++++--------- 1 file changed, 63 insertions(+), 63 deletions(-) diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json index c6d51d69b1ce..2be2857afdbf 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json @@ -23,7 +23,7 @@ { "in": "path", "name": "id", - "description": "Id of the classification policy", + "description": "Id of the classification policy.", "required": true, "type": "string" }, @@ -33,7 +33,7 @@ { "in": "body", "name": "patch", - "description": "Model of classification policy properties to be patched. See also: https://datatracker.ietf.org/doc/html/rfc7386", + "description": "Model of classification policy properties to be patched. See also: https://datatracker.ietf.org/doc/html/rfc7386.", "required": true, "schema": { "$ref": "#/definitions/ClassificationPolicy" @@ -73,7 +73,7 @@ "tags": [ "ClassificationPolicies" ], - "summary": "Retrieves an existing classification policy by Id", + "summary": "Retrieves an existing classification policy by Id.", "operationId": "JobRouterAdministration_GetClassificationPolicy", "produces": [ "application/json" @@ -82,7 +82,7 @@ { "in": "path", "name": "id", - "description": "Id of the classification policy", + "description": "Id of the classification policy.", "required": true, "type": "string" }, @@ -114,7 +114,7 @@ "tags": [ "ClassificationPolicies" ], - "summary": "Delete a classification policy by Id", + "summary": "Delete a classification policy by Id.", "operationId": "JobRouterAdministration_DeleteClassificationPolicy", "produces": [ "application/json" @@ -123,7 +123,7 @@ { "in": "path", "name": "id", - "description": "Id of the classification policy", + "description": "Id of the classification policy.", "required": true, "type": "string" }, @@ -154,7 +154,7 @@ "tags": [ "ClassificationPolicies" ], - "summary": "Retrieves existing classification policies", + "summary": "Retrieves existing classification policies.", "operationId": "JobRouterAdministration_ListClassificationPolicies", "produces": [ "application/json" @@ -163,7 +163,7 @@ { "in": "query", "name": "maxpagesize", - "description": "Maximum page size", + "description": "Maximum page size.", "type": "integer", "format": "int32" }, @@ -213,7 +213,7 @@ { "in": "path", "name": "id", - "description": "Id of the distribution policy", + "description": "Id of the distribution policy.", "required": true, "type": "string" }, @@ -223,7 +223,7 @@ { "in": "body", "name": "patch", - "description": "Model of distribution policy properties to be patched. See also: https://datatracker.ietf.org/doc/html/rfc7386", + "description": "Model of distribution policy properties to be patched. See also: https://datatracker.ietf.org/doc/html/rfc7386.", "required": true, "schema": { "$ref": "#/definitions/DistributionPolicy" @@ -263,7 +263,7 @@ "tags": [ "DistributionPolicies" ], - "summary": "Retrieves an existing distribution policy by Id", + "summary": "Retrieves an existing distribution policy by Id.", "operationId": "JobRouterAdministration_GetDistributionPolicy", "produces": [ "application/json" @@ -272,7 +272,7 @@ { "in": "path", "name": "id", - "description": "Id of the distribution policy", + "description": "Id of the distribution policy.", "required": true, "type": "string" }, @@ -304,7 +304,7 @@ "tags": [ "DistributionPolicies" ], - "summary": "Delete a distribution policy by Id", + "summary": "Delete a distribution policy by Id.", "operationId": "JobRouterAdministration_DeleteDistributionPolicy", "produces": [ "application/json" @@ -313,7 +313,7 @@ { "in": "path", "name": "id", - "description": "Id of the distribution policy", + "description": "Id of the distribution policy.", "required": true, "type": "string" }, @@ -344,7 +344,7 @@ "tags": [ "DistributionPolicies" ], - "summary": "Retrieves existing distribution policies", + "summary": "Retrieves existing distribution policies.", "operationId": "JobRouterAdministration_ListDistributionPolicies", "produces": [ "application/json" @@ -353,7 +353,7 @@ { "in": "query", "name": "maxpagesize", - "description": "Maximum page size", + "description": "Maximum page size.", "type": "integer", "format": "int32" }, @@ -403,7 +403,7 @@ { "in": "path", "name": "id", - "description": "Id of the exception policy", + "description": "Id of the exception policy.", "required": true, "type": "string" }, @@ -453,7 +453,7 @@ "tags": [ "ExceptionPolicies" ], - "summary": "Retrieves an existing exception policy by Id", + "summary": "Retrieves an existing exception policy by Id.", "operationId": "JobRouterAdministration_GetExceptionPolicy", "produces": [ "application/json" @@ -462,7 +462,7 @@ { "in": "path", "name": "id", - "description": "Id of the exception policy to retrieve", + "description": "Id of the exception policy to retrieve.", "required": true, "type": "string" }, @@ -494,7 +494,7 @@ "tags": [ "ExceptionPolicies" ], - "summary": "Deletes a exception policy by Id", + "summary": "Deletes a exception policy by Id.", "operationId": "JobRouterAdministration_DeleteExceptionPolicy", "produces": [ "application/json" @@ -503,7 +503,7 @@ { "in": "path", "name": "id", - "description": "Id of the exception policy to delete", + "description": "Id of the exception policy to delete.", "required": true, "type": "string" }, @@ -534,7 +534,7 @@ "tags": [ "ExceptionPolicies" ], - "summary": "Retrieves existing exception policies", + "summary": "Retrieves existing exception policies.", "operationId": "JobRouterAdministration_ListExceptionPolicies", "produces": [ "application/json" @@ -543,7 +543,7 @@ { "in": "query", "name": "maxpagesize", - "description": "Number of objects to return per page", + "description": "Number of objects to return per page.", "type": "integer", "format": "int32" }, @@ -646,7 +646,7 @@ "tags": [ "Jobs" ], - "summary": "Retrieves an existing job by Id", + "summary": "Retrieves an existing job by Id.", "operationId": "JobRouter_GetJob", "produces": [ "application/json" @@ -655,7 +655,7 @@ { "in": "path", "name": "id", - "description": "Id of the job to retrieve", + "description": "Id of the job to retrieve.", "required": true, "type": "string" }, @@ -696,7 +696,7 @@ { "in": "path", "name": "id", - "description": "Id of the job", + "description": "Id of the job.", "required": true, "type": "string" }, @@ -739,7 +739,7 @@ { "in": "path", "name": "id", - "description": "Id of the job", + "description": "Id of the job.", "required": true, "type": "string" }, @@ -793,7 +793,7 @@ { "in": "path", "name": "id", - "description": "Id of the job", + "description": "Id of the job.", "required": true, "type": "string" }, @@ -803,7 +803,7 @@ { "in": "body", "name": "cancelJobRequest", - "description": "Request model for cancelling job", + "description": "Request model for cancelling job.", "schema": { "$ref": "#/definitions/CancelJobRequest" }, @@ -848,7 +848,7 @@ { "in": "path", "name": "id", - "description": "Id of the job", + "description": "Id of the job.", "required": true, "type": "string" }, @@ -858,7 +858,7 @@ { "in": "body", "name": "completeJobRequest", - "description": "Request model for completing job", + "description": "Request model for completing job.", "required": true, "schema": { "$ref": "#/definitions/CompleteJobRequest" @@ -904,7 +904,7 @@ { "in": "path", "name": "id", - "description": "Id of the job", + "description": "Id of the job.", "required": true, "type": "string" }, @@ -914,7 +914,7 @@ { "in": "body", "name": "closeJobRequest", - "description": "Request model for closing job", + "description": "Request model for closing job.", "required": true, "schema": { "$ref": "#/definitions/CloseJobRequest" @@ -954,7 +954,7 @@ "tags": [ "Jobs" ], - "summary": "Retrieves list of jobs based on filter parameters", + "summary": "Retrieves list of jobs based on filter parameters.", "operationId": "JobRouter_ListJobs", "produces": [ "application/json" @@ -1008,7 +1008,7 @@ { "in": "query", "name": "scheduledBefore", - "description": "If specified, filter on jobs that was scheduled before or at given timestamp. Range: (-Inf, scheduledBefore]", + "description": "If specified, filter on jobs that was scheduled before or at given timestamp. Range: (-Inf, scheduledBefore].", "type": "string", "format": "date-time" }, @@ -1022,7 +1022,7 @@ { "in": "query", "name": "maxpagesize", - "description": "Number of objects to return per page", + "description": "Number of objects to return per page.", "type": "integer", "format": "int32" }, @@ -1069,7 +1069,7 @@ { "in": "path", "name": "id", - "description": "Id of the job", + "description": "Id of the job.", "required": true, "type": "string" }, @@ -1115,14 +1115,14 @@ { "in": "path", "name": "id", - "description": "Id of the job to un-assign", + "description": "Id of the job to un-assign.", "required": true, "type": "string" }, { "in": "path", "name": "assignmentId", - "description": "Id of the assignment to un-assign", + "description": "Id of the assignment to un-assign.", "required": true, "type": "string" }, @@ -1132,7 +1132,7 @@ { "in": "body", "name": "unassignJobRequest", - "description": "Request body for unassign route", + "description": "Request body for unassign route.", "schema": { "$ref": "#/definitions/UnassignJobRequest" } @@ -1173,14 +1173,14 @@ { "in": "path", "name": "workerId", - "description": "Id of the worker", + "description": "Id of the worker.", "required": true, "type": "string" }, { "in": "path", "name": "offerId", - "description": "Id of the offer", + "description": "Id of the offer.", "required": true, "type": "string" }, @@ -1226,14 +1226,14 @@ { "in": "path", "name": "workerId", - "description": "Id of the worker", + "description": "Id of the worker.", "required": true, "type": "string" }, { "in": "path", "name": "offerId", - "description": "Id of the offer", + "description": "Id of the offer.", "required": true, "type": "string" }, @@ -1243,7 +1243,7 @@ { "in": "body", "name": "declineJobOfferRequest", - "description": "Request model for declining offer", + "description": "Request model for declining offer.", "schema": { "$ref": "#/definitions/DeclineJobOfferRequest" } @@ -1287,7 +1287,7 @@ { "in": "path", "name": "id", - "description": "Id of the queue", + "description": "Id of the queue.", "required": true, "type": "string" }, @@ -1297,7 +1297,7 @@ { "in": "body", "name": "patch", - "description": "Model of queue properties to be patched. See also: https://datatracker.ietf.org/doc/html/rfc7386", + "description": "Model of queue properties to be patched. See also: https://datatracker.ietf.org/doc/html/rfc7386.", "required": true, "schema": { "$ref": "#/definitions/RouterQueue" @@ -1337,7 +1337,7 @@ "tags": [ "Queues" ], - "summary": "Retrieves an existing queue by Id", + "summary": "Retrieves an existing queue by Id.", "operationId": "JobRouterAdministration_GetQueue", "produces": [ "application/json" @@ -1346,7 +1346,7 @@ { "in": "path", "name": "id", - "description": "Id of the queue to retrieve", + "description": "Id of the queue to retrieve.", "required": true, "type": "string" }, @@ -1378,7 +1378,7 @@ "tags": [ "Queues" ], - "summary": "Deletes a queue by Id", + "summary": "Deletes a queue by Id.", "operationId": "JobRouterAdministration_DeleteQueue", "produces": [ "application/json" @@ -1387,7 +1387,7 @@ { "in": "path", "name": "id", - "description": "Id of the queue to delete", + "description": "Id of the queue to delete.", "required": true, "type": "string" }, @@ -1418,7 +1418,7 @@ "tags": [ "Queues" ], - "summary": "Retrieves existing queues", + "summary": "Retrieves existing queues.", "operationId": "JobRouterAdministration_ListQueues", "produces": [ "application/json" @@ -1427,7 +1427,7 @@ { "in": "query", "name": "maxpagesize", - "description": "Number of objects to return per page", + "description": "Number of objects to return per page.", "type": "integer", "format": "int32" }, @@ -1465,7 +1465,7 @@ "tags": [ "Queues" ], - "summary": "Retrieves a queue's statistics", + "summary": "Retrieves a queue's statistics.", "operationId": "JobRouter_GetQueueStatistics", "produces": [ "application/json" @@ -1474,7 +1474,7 @@ { "in": "path", "name": "id", - "description": "Id of the queue to retrieve statistics", + "description": "Id of the queue to retrieve statistics.", "required": true, "type": "string" }, @@ -1520,7 +1520,7 @@ { "in": "path", "name": "workerId", - "description": "Id of the worker", + "description": "Id of the worker.", "required": true, "type": "string" }, @@ -1530,7 +1530,7 @@ { "in": "body", "name": "patch", - "description": "Model of worker properties to be created or patched. See also: https://datatracker.ietf.org/doc/html/rfc7386", + "description": "Model of worker properties to be created or patched. See also: https://datatracker.ietf.org/doc/html/rfc7386.", "required": true, "schema": { "$ref": "#/definitions/RouterWorker" @@ -1579,7 +1579,7 @@ "tags": [ "Workers" ], - "summary": "Retrieves an existing worker by Id", + "summary": "Retrieves an existing worker by Id.", "operationId": "JobRouter_GetWorker", "produces": [ "application/json" @@ -1588,7 +1588,7 @@ { "in": "path", "name": "workerId", - "description": "Id of the worker to retrieve", + "description": "Id of the worker to retrieve.", "required": true, "type": "string" }, @@ -1629,7 +1629,7 @@ { "in": "path", "name": "workerId", - "description": "Id of the worker to delete", + "description": "Id of the worker to delete.", "required": true, "type": "string" }, @@ -1686,13 +1686,13 @@ { "in": "query", "name": "channelId", - "description": "If specified, select workers who have a channel configuration with this channel", + "description": "If specified, select workers who have a channel configuration with this channel.", "type": "string" }, { "in": "query", "name": "queueId", - "description": "If specified, select workers who are assigned to this queue", + "description": "If specified, select workers who are assigned to this queue.", "type": "string" }, { @@ -1704,7 +1704,7 @@ { "in": "query", "name": "maxpagesize", - "description": "Number of objects to return per page", + "description": "Number of objects to return per page.", "type": "integer", "format": "int32" },