ocket8888 commented on code in PR #7881: URL: https://github.com/apache/trafficcontrol/pull/7881#discussion_r1443832263
########## experimental/traffic-portal/src/app/api/coordinate.service.ts: ########## @@ -0,0 +1,83 @@ +/* + * Licensed 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. + */ +import { HttpClient } from "@angular/common/http"; +import { Injectable } from "@angular/core"; +import type { ResponseCoordinate } from "trafficops-types"; + +import { APIService } from "./base-api.service"; + +/** + * CoordinateService exposes API functionality relating to Coordinates. + */ +@Injectable() +export class CoordinateService extends APIService { + /** + * Gets a specific Coordinate from Traffic Ops. + * + * @param idOrName Either the integral, unique identifier (number) or name + * (string) of the Coordinate to be returned. + * @returns The requested Coordinate. + */ + public async getCoordinates( + idOrName: number | string + ): Promise<ResponseCoordinate>; + /** + * Gets Coordinates from Traffic Ops. Review Comment: Missing `@returns` annotation -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
