Method combinedOpenAPISpec

runtime/server/api.go:100–179

(w http.ResponseWriter, req *http.Request)

}

func (s *Server) combinedOpenAPISpec(w http.ResponseWriter, req *http.Request) error {
	// Parse path parameters
	ctx := req.Context()
	instanceID := req.PathValue("instance_id")

	// Add observability attributes
	observability.AddRequestAttributes(ctx)
	s.addInstanceRequestAttributes(ctx, instanceID)

	// Only GET request is allowed
	if req.Method != http.MethodGet {
		return httputil.Error(http.StatusMethodNotAllowed, fmt.Errorf("GET only"))
	}

	// Check if user has access to query for API data
	if !auth.GetClaims(ctx, instanceID).Can(runtime.ReadAPI) {
		return httputil.Errorf(http.StatusForbidden, "does not have access to custom APIs")
	}

	apis := make(map[string]*runtimev1.API)

	// Get all built-in APIs
	for name, api := range runtime.BuiltinAPIs {
		apis[name] = api
	}

	// Get all custom APIs
	ctrl, err := s.runtime.Controller(ctx, instanceID)
	if err != nil {
		return httputil.Error(http.StatusBadRequest, err)
	}

	list, err := ctrl.List(ctx, runtime.ResourceKindAPI, "", false)
	if err != nil {
		return err
	}

	for _, res := range list {
		apis[res.Meta.Name.Name] = res.GetApi()
	}

	// Generate the OpenAPI spec
	combinedAPISpec, err := s.generateOpenAPISpec(ctx, instanceID, apis)
	if err != nil {
		return httputil.Error(http.StatusInternalServerError, err)
	}

	// Check accepted format of the OpenAPI spec: JSON or YAML
	accept := req.Header.Get("Accept")

	// YAML
	if accept == "application/yaml" || accept == "application/x-yaml" {
		data, err := yaml.Marshal(combinedAPISpec)
		if err != nil {
			return httputil.Error(http.StatusInternalServerError, err)
		}

		w.Header().Set("Content-Type", "application/yaml")