mitchell852 closed pull request #1815: [issue 1814] Add fields to the reponse
of POST/PUT steering target APIs
URL: https://github.com/apache/incubator-trafficcontrol/pull/1815
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/source/development/traffic_ops_api/v12/steering_target.rst
b/docs/source/development/traffic_ops_api/v12/steering_target.rst
index 180f755cdc..bf10a28300 100644
--- a/docs/source/development/traffic_ops_api/v12/steering_target.rst
+++ b/docs/source/development/traffic_ops_api/v12/steering_target.rst
@@ -184,21 +184,30 @@ Steering Targets
+========================+==========+==========================+
| ``deliveryServiceId`` | int | Steering DS ID |
+------------------------+----------+--------------------------+
+ | ``deliveryService`` | string | DS XML ID |
+ +------------------------+----------+--------------------------+
| ``targetId`` | int | Target DS ID |
+------------------------+----------+--------------------------+
+ | ``target`` | string | Target DS XML ID |
+ +------------------------+----------+--------------------------+
| ``value`` | string | Target value |
+------------------------+----------+--------------------------+
| ``typeId`` | int | Target type ID |
+------------------------+----------+--------------------------+
+ | ``type`` | string | Steering target type name|
+ +------------------------+----------+--------------------------+
**Response Example** ::
{
"response": {
"deliveryServiceId": 1,
+ "deliveryService": "steering-ds-one",
"targetId": 2,
+ "target": "steering-target-two",
"value": "34",
- "typeId": 45
+ "typeId": 45,
+ "type": "STEERING_ORDER"
},
"alerts": [
{
@@ -256,21 +265,30 @@ Steering Targets
+========================+==========+==========================+
| ``deliveryServiceId`` | int | Steering DS ID |
+------------------------+----------+--------------------------+
+ | ``deliveryService`` | string | DS XML ID |
+ +------------------------+----------+--------------------------+
| ``targetId`` | int | Target DS ID |
+------------------------+----------+--------------------------+
+ | ``target`` | string | Target DS XML ID |
+ +------------------------+----------+--------------------------+
| ``value`` | string | Target value |
+------------------------+----------+--------------------------+
| ``typeId`` | int | Target type ID |
+------------------------+----------+--------------------------+
+ | ``type`` | string | Steering target type name|
+ +------------------------+----------+--------------------------+
**Response Example** ::
{
"response": {
"deliveryServiceId": 1,
+ "deliveryService": "steering-ds-one",
"targetId": 6,
+ "target": "steering-target-six",
"value": "22",
- "typeId": 47
+ "typeId": 47,
+ "type": "STEERING_ORDER"
},
"alerts": [
{
diff --git a/traffic_ops/app/lib/API/DeliveryService/SteeringTarget.pm
b/traffic_ops/app/lib/API/DeliveryService/SteeringTarget.pm
index 3372f839d4..3f21fb837b 100644
--- a/traffic_ops/app/lib/API/DeliveryService/SteeringTarget.pm
+++ b/traffic_ops/app/lib/API/DeliveryService/SteeringTarget.pm
@@ -152,9 +152,12 @@ sub update {
my $response;
$response->{deliveryServiceId} = $update->deliveryservice->id;
+ $response->{deliveryService} =
$update->deliveryservice->xml_id;
$response->{targetId} = $update->target->id;
+ $response->{target} = $update->target->xml_id;
$response->{value} = $update->value;
$response->{typeId} = $update->type->id;
+ $response->{type} = $update->type->name;
&log( $self, "Updated steering target [ " . $target_ds_id . " ]
for deliveryservice: " . $steering_ds_id, "APICHANGE" );
@@ -220,9 +223,12 @@ sub create {
my @response;
push( @response, {
deliveryServiceId =>
$insert->deliveryservice->id,
+ deliveryService =>
$insert->deliveryservice->xml_id,
targetId => $insert->target->id,
+ target =>
$insert->target->xml_id,
value => $insert->value,
typeId => $insert->type->id,
+ type => $insert->type->name,
} );
&log( $self, "Created steering target [ '" . $target_ds_id . "'
] for delivery service: " . $steering_ds_id, "APICHANGE" );
diff --git a/traffic_ops/app/t/api/1.2/steering_target.t
b/traffic_ops/app/t/api/1.2/steering_target.t
index eec0e67cbe..b46cc59d8f 100644
--- a/traffic_ops/app/t/api/1.2/steering_target.t
+++ b/traffic_ops/app/t/api/1.2/steering_target.t
@@ -52,9 +52,12 @@ ok $t->post_ok('/api/1.2/steering/900/targets' => {Accept =>
'application/json'}
"typeId" => 40
})->status_is(200)->or( sub { diag
$t->tx->res->content->asset->{content}; } )
->json_is( "/response/0/deliveryServiceId" => 900 )
+ ->json_is( "/response/0/deliveryService" => "steering-ds3" )
->json_is( "/response/0/targetId" => 1000 )
+ ->json_is( "/response/0/target" => "steering-target-ds1" )
->json_is( "/response/0/value" => 852 )
->json_is( "/response/0/typeId" => 40 )
+ ->json_is( "/response/0/type" => "STEERING_ORDER" )
, 'Is the steering target created?';
ok $t->post_ok('/api/1.2/steering/900/targets' => {Accept =>
'application/json'} => json => {
@@ -89,9 +92,12 @@ ok $t->put_ok('/api/1.2/steering/900/targets/1000' =>
{Accept => 'application/js
})
->status_is(200)->or( sub { diag
$t->tx->res->content->asset->{content}; } )
->json_is( "/response/deliveryServiceId" => 900 )
+ ->json_is( "/response/deliveryService" => "steering-ds3" )
->json_is( "/response/targetId" => 1000 )
+ ->json_is( "/response/target" => "steering-target-ds1" )
->json_is( "/response/value" => 999 )
->json_is( "/response/typeId" => 40 )
+ ->json_is( "/response/type" => "STEERING_ORDER" )
->json_is( "/alerts/0/level" => "success" )
, 'Did the steering target update?';
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
