mitchell852 closed pull request #2105: created swaggerdocs for /regions URL: https://github.com/apache/incubator-trafficcontrol/pull/2105
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/lib/go-tc/v13/regions.go b/lib/go-tc/v13/regions.go new file mode 100644 index 000000000..8b7cde31b --- /dev/null +++ b/lib/go-tc/v13/regions.go @@ -0,0 +1,66 @@ +package v13 + +import tc "github.com/apache/incubator-trafficcontrol/lib/go-tc" + +/* + * 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. + */ + +// A List of Regions Response +// swagger:response RegionsResponse +// in: body +type RegionsResponse struct { + // in: body + Response []Region `json:"response"` +} + +// A Single Region Response for Update and Create to depict what changed +// swagger:response RegionResponse +// in: body +type RegionResponse struct { + // in: body + Response Region `json:"response"` +} + +type Region struct { + + // The Region to retrieve + + // DivisionName - Name of the Division associated to this Region + // + // required: true + DivisionName string `json:"divisionName"` + + // DivisionName of the Division + // + // required: true + Division int `json:"division" db:"division"` + + // Region ID + // + ID int `json:"id" db:"id"` + + // LastUpdated + // + LastUpdated tc.TimeNoMod `json:"lastUpdated" db:"last_updated"` + + // Region Name + // + // required: true + Name string `json:"name" db:"name"` +} diff --git a/traffic_ops/traffic_ops_golang/swaggerdocs/v13/regions.go b/traffic_ops/traffic_ops_golang/swaggerdocs/v13/regions.go new file mode 100644 index 000000000..f3cb335c0 --- /dev/null +++ b/traffic_ops/traffic_ops_golang/swaggerdocs/v13/regions.go @@ -0,0 +1,147 @@ +package v13 + +import "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. + */ + +// Regions - RegionsResponse to get the "response" top level key +// swagger:response Regions +// in: body +type Regions struct { + // Region Response Body + // in: body + RegionsResponse v13.RegionsResponse `json:"response"` +} + +// Region - RegionResponse to get the "response" top level key +// swagger:response Region +// in: body +type Region struct { + // Region Response Body + // in: body + RegionResponse v13.RegionResponse +} + +// RegionQueryParams +// +// swagger:parameters GetRegions +type RegionQueryParams struct { + + // RegionsQueryParams + + // Division ID that refers to this Region + // + Division string `json:"division"` + + // Division Name that refers to this Region + // + DivisionName string `json:"divisionName"` + + // Unique identifier for the Region + // + ID string `json:"id"` + + // + // + Orderby string `json:"orderby"` +} + +// swagger:parameters PostRegion +type RegionPostParam struct { + // Region Request Body + // + // in: body + // required: true + Region v13.Region +} + +// swagger:parameters GetRegionById DeleteRegion +type RegionPathParams struct { + + // Id associated to the Region + // in: path + ID int `json:"id"` +} + +// PostRegion swagger:route POST /regions Region PostRegion +// +// Create a Region +// +// Responses: +// 200: Alerts +func PostRegion(entity RegionPostParam) (Region, Alerts) { + return Region{}, Alerts{} +} + +// GetRegions swagger:route GET /regions Region GetRegions +// +// Retrieve a list of Regions +// +// Responses: +// 200: Regions +// 400: Alerts +func GetRegions() (Regions, Alerts) { + return Regions{}, Alerts{} +} + +// swagger:parameters PutRegion +type RegionPutParam struct { + + // ID + // in: path + ID int `json:"id"` + + // Region Request Body + // + // in: body + // required: true + Region v13.Region +} + +// PutRegion swagger:route PUT /regions/{id} Region PutRegion +// +// Update a Region +// +// Responses: +// 200: Region +func PutRegion(entity RegionPutParam) (Region, Alerts) { + return Region{}, Alerts{} +} + +// GetRegionById swagger:route GET /regions/{id} Region GetRegionById +// +// Retrieve a specific Region +// +// Responses: +// 200: Regions +// 400: Alerts +func GetRegionById() (Regions, Alerts) { + return Regions{}, Alerts{} +} + +// DeleteRegion swagger:route DELETE /regions/{id} Region DeleteRegion +// +// Delete a Region +// +// Responses: +// 200: Alerts +func DeleteRegion(entityId int) Alerts { + return Alerts{} +} ---------------------------------------------------------------- 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: us...@infra.apache.org With regards, Apache Git Services
