devportal.solo.ioapidoc.proto

Package : devportal.solo.io

Top

apidoc.proto

Table of Contents

APIDocSpec

An APIDoc tells the DevPortal controller how to load an API Specification Document (e.g. a Swagger YAML file). APIDocs define the operations which are be bundled and exposed in API Products. The API Specifications contained within an APIDoc can be used to provide configuration for HTTP routing of calls to the APIs defined in the spec.

Field Type Description
content devportal.solo.io.common.devportal.solo.io.DataSource DataSource reference to the actual APIDoc content.
openApi devportal.solo.io.APIDocSpec.OpenApiDoc Set this field if the APIDoc is of type OpenApi (default)..
grpc devportal.solo.io.APIDocSpec.OpenApiDoc Set this field if the APIDoc is of type gRPC (default)..

APIDocSpec.GrpcDoc

APIDocSpec.OpenApiDoc

Parameters specific to OpenApi APIDoc.

APIDocStatus

The current status of the APIDoc. The APIDoc will be processed as soon as one or more Portals select it for publishing.

Field Type Description
observedGeneration devportal.solo.io. The observed generation of the APIDoc. When this matches the APIDoc’s metadata.generation, it indicates the status is up-to-date..
state devportal.solo.io.common.devportal.solo.io.State The current state of the APIDoc..
reason devportal.solo.io. A human-readable string explaining the error, if any..
displayName devportal.solo.io. User-facing display name for the APIDoc..
version devportal.solo.io. User-facing version number.
description devportal.solo.io. User-facing description.
openApi devportal.solo.io.OpenAPIOperations information specific to a grpc method.
grpc devportal.solo.io.GrpcMethods information specific to a grpc method.

GrpcMethods

Field Type Description
methods []devportal.solo.io.GrpcMethods.GrpcMethod the list of methods defined in the gRPC Schema.

GrpcMethods.GrpcMethod

describes an operation (RPC method) defined in a set of gRPC Descriptors

Field Type Description
serviceName string the name of the gRPC service serving the RPC method..
rpcName string the name of the RPC method as defined on the service..
summary string the summary, if any, for the method.
route devportal.solo.io.RouteSpec the Routing configuration, if any, defined for this operation within the gRPC descriptors. Defined using the router.devportal.solo.io. gRPC options..

OpenAPIOperations

Field Type Description
operations []devportal.solo.io.OpenAPIOperations.Operation the list of operations defined in the OpenAPI schema.

OpenAPIOperations.Operation

describes an operation as defined in an OpenAPI Schema

Field Type Description
operationId string the OperationID of the operation.
path string the HTTP Path for the operation.
verb string the HTTP Verb for the operation.
summary string the summary, if any, for the operation.
route devportal.solo.io.RouteSpec the Routing configuration, if any, defined for this operation within the OpenAPI doc. Defined using the x-solo-portal-router OpenAPI extension..