prysm-pulse/proto/prysm/v1alpha1/swagger.proto

// Copyright 2020 Prysmatic Labs.
//
// 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.

// This is an optional proto that provides some gRPC gateway metadata for
// generating the OpenAPIv2(swagger) header.
syntax = "proto3";

package ethereum.eth.v1alpha1;

import "protoc-gen-openapiv2/options/annotations.proto";

option go_package = "github.com/prysmaticlabs/prysm/proto/prysm/v1alpha1;eth";

option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
    info: {
        title: "Ethereum Serenity APIs";
        version: "v1alpha1";
        license: {
            name: "Licenced under Apache 2.0";
            url: "http://www.apache.org/licenses/LICENSE-2.0";
        };
        description: "{{ index . "description" }}";
    };
    external_docs: {
        url: "https://github.com/ethereum/consensus-specs";
        description: "Ethereum Consensus Specification on Github";
    };
    host: "api.prylabs.net",
    schemes: HTTPS;
    schemes: WSS;
    consumes: "application/json";
    consumes: "application/grpc-web-text";
    consumes: "application/grpc-web-json";
    produces: "application/json";
    produces: "application/grpc-web-text";
    produces: "application/grpc-web-json";
};