code.vegaprotocol.io/vega@v0.79.0/datanode/api/doc.go (about)

     1  // Copyright (C) 2023 Gobalsky Labs Limited
     2  //
     3  // This program is free software: you can redistribute it and/or modify
     4  // it under the terms of the GNU Affero General Public License as
     5  // published by the Free Software Foundation, either version 3 of the
     6  // License, or (at your option) any later version.
     7  //
     8  // This program is distributed in the hope that it will be useful,
     9  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    10  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    11  // GNU Affero General Public License for more details.
    12  //
    13  // You should have received a copy of the GNU Affero General Public License
    14  // along with this program.  If not, see <http://www.gnu.org/licenses/>.
    15  
    16  // Package api contains code for running the gRPC server.
    17  //
    18  // In order to add a new gRPC endpoint, add proto content (rpc call, request
    19  // and response messages), then add the endpoint function implementation in
    20  // `api/somefile.go`. Example:
    21  //
    22  //	func (s *tradingService) SomeNewEndpoint(
    23  //	    ctx context.Context, req *protoapi.SomeNewEndpointRequest,
    24  //	) (*protoapi.SomeNewEndpointResponse, error) {
    25  //	    /* Implementation goes here */
    26  //	    return &protoapi.SomeNewEndpointResponse{/* ... */}, nil
    27  //	}
    28  //
    29  // Add a test for the newly created endpoint in `api/trading_test.go`.
    30  package api