This is an automated email from the ASF dual-hosted git repository.

mitchell852 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-trafficcontrol.git

commit b8b09fc348e5019cd7c47b7bc49ad3bcc792ab16
Author: Dewayne Richardson <dewr...@apache.org>
AuthorDate: Tue Apr 3 14:38:08 2018 -0600

    updated for swagger documentation
---
 lib/go-tc/v13/profile_parameters.go                |   8 ++
 .../traffic_ops_golang/swaggerdocs/v13/docs.go     |   2 +-
 .../swaggerdocs/v13/profileparameters.go           | 119 +++++++++++++++++++++
 3 files changed, 128 insertions(+), 1 deletion(-)

diff --git a/lib/go-tc/v13/profile_parameters.go 
b/lib/go-tc/v13/profile_parameters.go
index 954d6f0..67afa6c 100644
--- a/lib/go-tc/v13/profile_parameters.go
+++ b/lib/go-tc/v13/profile_parameters.go
@@ -26,6 +26,14 @@ type ProfileParametersResponse struct {
        Response []ProfileParameter `json:"response"`
 }
 
+// A Single ProfileParameter Response for Create to depict what changed
+// swagger:response ProfileParameterResponse
+// in: body
+type ProfileParameterResponse struct {
+       // in: body
+       Response ProfileParameter `json:"response"`
+}
+
 // ProfileParameter ...
 type ProfileParameter struct {
        LastUpdated tc.TimeNoMod `json:"lastUpdated"`
diff --git a/traffic_ops/traffic_ops_golang/swaggerdocs/v13/docs.go 
b/traffic_ops/traffic_ops_golang/swaggerdocs/v13/docs.go
index ee55e9c..730a8c7 100644
--- a/traffic_ops/traffic_ops_golang/swaggerdocs/v13/docs.go
+++ b/traffic_ops/traffic_ops_golang/swaggerdocs/v13/docs.go
@@ -1,5 +1,5 @@
 /*
- Package docs Traffic Ops API v1.3
+ Package docs Traffic Ops API
 
  The following REST APIs are used by the Traffic Portal UI along with several 
Traffic Control backend component and services.
 
diff --git 
a/traffic_ops/traffic_ops_golang/swaggerdocs/v13/profileparameters.go 
b/traffic_ops/traffic_ops_golang/swaggerdocs/v13/profileparameters.go
new file mode 100644
index 0000000..04a5408
--- /dev/null
+++ b/traffic_ops/traffic_ops_golang/swaggerdocs/v13/profileparameters.go
@@ -0,0 +1,119 @@
+package v13
+
+import v13 "github.com/apache/incubator-trafficcontrol/lib/go-tc/v13"
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+// ProfileParameters -  ProfileParametersResponse to get the "response" top 
level key
+// swagger:response ProfileParameters
+// in: body
+type ProfileParameters struct {
+       // ProfileParameter Response Body
+       // in: body
+       ProfileParametersResponse v13.ProfileParametersResponse 
`json:"response"`
+}
+
+// ProfileParameter -  ProfileParameterResponse to get the "response" top 
level key
+// swagger:response ProfileParameter
+// in: body
+type ProfileParameter struct {
+       // ProfileParameter Response Body
+       // in: body
+       ProfileParameterResponse v13.ProfileParameterResponse
+}
+
+// ProfileParameterQueryParams
+//
+// swagger:parameters GetProfileParameters
+type ProfileParameterQueryParams struct {
+
+       // ProfileParametersQueryParams
+
+       // Unique identifier for the ProfileParameter
+       //
+       ProfileID string `json:"profileId"`
+
+       // Unique identifier for the ProfileParameter
+       //
+       ParameterID string `json:"parameterId"`
+
+       // The field in the response to sort the response by
+       //
+       Orderby string `json:"orderby"`
+}
+
+// swagger:parameters PostProfileParameter
+type ProfileParameterPostParam struct {
+       // ProfileParameter Request Body
+       //
+       // in: body
+       // required: true
+       ProfileParameter v13.ProfileParameter
+}
+
+// PostProfileParameter swagger:route POST /profileparameters ProfileParameter 
PostProfileParameter
+//
+// Create a ProfileParameter
+//
+// A ProfileParameter is a join of the Profile and Parameters
+//
+// Responses:
+//          200: Alerts
+func PostProfileParameter(entity ProfileParameterPostParam) (ProfileParameter, 
Alerts) {
+       return ProfileParameter{}, Alerts{}
+}
+
+// GetProfileParameters swagger:route GET /profileparameters ProfileParameter 
GetProfileParameters
+//
+// Retrieve a list of ProfileParameters by narrowing down with query parameters
+//
+// List of ProfileParameters
+//
+// Responses:
+//          200: ProfileParameters
+//          400: Alerts
+func GetProfileParameters() (ProfileParameters, Alerts) {
+       return ProfileParameters{}, Alerts{}
+}
+
+// GetProfileParameterById swagger:route GET /profileparameters?id={id} 
ProfileParameter GetProfileParameterById
+//
+// Retrieve a specific ProfileParameter by Id
+//
+// Retrieve a single division
+//
+// Responses:
+//          200: ProfileParameters
+//          400: Alerts
+func GetProfileParameterById() (ProfileParameters, Alerts) {
+       return ProfileParameters{}, Alerts{}
+}
+
+// DeleteProfileParameter swagger:route DELETE /profileparameters/{id} 
ProfileParameter DeleteProfileParameter
+//
+// Delete a ProfileParameter by Id
+//
+// Delete a single ProfileParameter
+//
+// Responses:
+//          200: Alerts
+func DeleteProfileParameter(entityId int) Alerts {
+       return Alerts{}
+}

-- 
To stop receiving notification emails like this one, please contact
mitchell...@apache.org.

Reply via email to