ApiDoc

Proto: api_doc.proto

Package: apimanagement.gloo.solo.io

The ApiDoc resource represents the schema of an API served by a Destination (Service, ExternalService). ApiDocs are typically created by Gloo Platform discovery running on the agent in registered workload clusters, but you can also manually create an ApiDoc CR. The ApiDoc type is used to represent different types of API schema specification languages:

• OpenAPI
• gRPC

ApiDocReport link

The report shows the resources that the ApiDoc selects after the it is successfully applied.

ApiDocReport.WorkspacesEntry link

ApiDocSpec link

Specifications for the ApiDoc.

ApiDocSpec.GraphQLSchema link

Unsupported: The GraphQL integration is no longer supported.

Provide a schema definition in GraphQL SDL format. The GraphQL schema also has logging options for logging sensitive request-related information, and schema extension configuration such as custom type definitions. For more information about the different schema features, see the GraphQL documentation.

ApiDocSpec.GrpcSchema link

Unsupported: The GraphQL integration is no longer supported.

A complete gRPC schema describing the API.

ApiDocSpec.OpenAPISchema link

The YAML- or JSON-formatted OpenAPI v2 or v3 schema string to use for your API.

Example: For detailed information about the settings in this example, see Create your APIs in the Gloo Portal documentation.

  apiVersion: apimanagement.gloo.solo.io/v2
kind: ApiDoc
metadata:
  annotations:
    cluster.solo.io/cluster: ""
  name: customers-api-schema
  namespace: default
spec:
  openapi:
    inlineString: '{ "info": { "title": "Gloo Platform Portal API", "version": "1.0.0", "description": "Review the following reference documentation for the Gloo Platform portal APIs. Use these endpoints to manage user access to both the developer portal and the API resources exposed by the portal." }, "openapi": "3.0.0", "servers": [ { "url": "https://api.gloo-platform-portal.com/v1" } ], "paths": { "/login": { "get": { "description": "Logs user into the developer portal. This is the path that should be used as the callbackPath in the ExtAuthPolicy's OIDC configuration.", "operationId": "login", "security": [ { "identityToken": [ ] } ], "responses": { "200": { "description": "Successfully logged in" } }, "summary": "Logs user into the developer portal", "tags": [ "User" ] } }'
  servedBy:
  - destinationSelector:
      port:
        number: 8080
      selector:
        cluster: $CLUSTER_NAME
        name: app
        namespace: app
  

ApiDocStatus link

The status of the ApiDoc after it is applied to your Gloo environment.

Gloo reports the status of Gloo custom resources in several places, such as in logs, when describing the object in kubectl, or when viewing the object in the Gloo UI. Unlike other Gloo custom resources, ApiDocs can be both an input and output object. For example, you can manually create an ApiDoc (input), or Gloo can automatically create an ApiDoc during discovery or translation processes (output). As such, status for ApiDocs is disabled. Because the status is disabled, you cannot review statuses for ApiDocs in kubectl. Also, you might notice ApiDocs reported as unhealthy in the Gloo UI even though the ApiDocs work. To verify that your ApiDocs are healthy, you can follow the steps in the ApiDoc guide.

ServedBy link

The destinations that serve this API, if any.