github.com/prysmaticlabs/prysm@v1.4.4/proto/eth/v1alpha1/swagger.proto (about)

     1  // Copyright 2020 Prysmatic Labs.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // This is an optional proto that provides some gRPC gateway metadata for
    16  // generating the OpenAPIv2(swagger) header.
    17  syntax = "proto3";
    18  
    19  package ethereum.eth.v1alpha1;
    20  
    21  import "protoc-gen-openapiv2/options/annotations.proto";
    22  
    23  option go_package = "github.com/prysmaticlabs/prysm/proto/eth/v1alpha1;eth";
    24  
    25  option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
    26      info: {
    27          title: "Ethereum Serenity APIs";
    28          version: "v1alpha1";
    29          license: {
    30              name: "Licenced under Apache 2.0";
    31              url: "http://www.apache.org/licenses/LICENSE-2.0";
    32          };
    33          description: "{{ index . "description" }}";
    34      };
    35      external_docs: {
    36          url: "https://github.com/ethereum/eth2.0-specs";
    37          description: "Ethereum Consensus Specification on Github";
    38      };
    39      host: "api.prylabs.net",
    40      schemes: HTTPS;
    41      schemes: WSS;
    42      consumes: "application/json";
    43      consumes: "application/grpc-web-text";
    44      consumes: "application/grpc-web-json";
    45      produces: "application/json";
    46      produces: "application/grpc-web-text";
    47      produces: "application/grpc-web-json";
    48  };