code.vegaprotocol.io/vega@v0.79.0/core/api/rest/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 rest contains code for running the REST-to-gRPC gateway.
    17  //
    18  // In order to add a new REST endpoint, add an entry to
    19  // `gateway/rest/grpc-rest-bindings.yml`.
    20  //
    21  // Run `make proto` to generate (among others) the swagger json file.
    22  //
    23  // Run `make rest_check` to make sure that all the endpoints in the bindings
    24  // yaml file make it into the swagger json file.
    25  package rest