feat: always upload bad specs (#1730)

Author: mfbx9da4

internal/run/source.go

@@ -177,31 +177,42 @@ func (w *Workflow) RunSource(ctx context.Context, parentStep *workflowTracking.W
 	}
 	sourceRes.OutputPath = outputLocation
 
+	var lintingErr error
 	if !w.SkipLinting {
 		w.OnSourceResult(sourceRes, SourceStepLint)
 		sourceRes.LintResult, err = w.validateDocument(ctx, rootStep, sourceID, currentDocument, rulesetToUse, w.ProjectDir, targetLanguage)
 		if err != nil {
-			return "", sourceRes, &LintingError{Err: err, Document: currentDocument}
+			lintingErr = &LintingError{Err: err, Document: currentDocument}
 		}
 	}
 
+	var diagnoseErr error
 	step := rootStep.NewSubstep("Diagnosing OpenAPI")
-	sourceRes.Diagnosis, err = suggest.Diagnose(ctx, currentDocument)
-	if err != nil {
+	sourceRes.Diagnosis, diagnoseErr = suggest.Diagnose(ctx, currentDocument)
+	if diagnoseErr != nil {
 		step.Fail()
-		return "", sourceRes, err
+	} else {
+		step.Succeed()
 	}
-	step.Succeed()
 
 	w.OnSourceResult(sourceRes, SourceStepUpload)
 
-	if !w.SkipSnapshot {
-		err = w.snapshotSource(ctx, rootStep, sourceID, source, sourceRes)
+	// Upload if validation passed OR if the spec looks like an OpenAPI spec (even if invalid)
+	if !w.SkipSnapshot && (lintingErr == nil || validation.LooksLikeAnOpenAPISpec(currentDocument)) {
+		err = w.snapshotSource(ctx, rootStep, sourceID, source, sourceRes, lintingErr)
 		if err != nil && !errors.Is(err, ocicommon.ErrAccessGated) {
 			logger.Warnf("failed to snapshot source: %s", err.Error())
 		}
 	}
 
+	// Return errors after snapshot attempt - prefer linting error over diagnose error
+	if lintingErr != nil {
+		return "", sourceRes, lintingErr
+	}
+	if diagnoseErr != nil {
+		return "", sourceRes, diagnoseErr
+	}
+
 	// If the source has a previous tracked revision, compute changes against it
 	if w.lockfileOld != nil && !w.SkipChangeReport {
 		if targetLockOld, ok := w.lockfileOld.Targets[targetID]; ok && !utils.IsZeroTelemetryOrganization(ctx) {

internal/run/sourceTracking.go

@@ -157,7 +157,7 @@ func (w *Workflow) computeChanges(ctx context.Context, rootStep *workflowTrackin
 	return computedChanges, err
 }
 
-func (w *Workflow) snapshotSource(ctx context.Context, parentStep *workflowTracking.WorkflowStep, sourceID string, source workflow.Source, sourceResult *SourceResult) (err error) {
+func (w *Workflow) snapshotSource(ctx context.Context, parentStep *workflowTracking.WorkflowStep, sourceID string, source workflow.Source, sourceResult *SourceResult, lintingErr error) (err error) {
 	registryStep := parentStep.NewSubstep("Tracking OpenAPI Changes")
 
 	if !registry.IsRegistryEnabled(ctx) {
@@ -204,7 +204,7 @@ func (w *Workflow) snapshotSource(ctx context.Context, parentStep *workflowTrack
 		apiKey = key
 	}
 
-	tags, err := w.getRegistryTags(ctx, sourceID)
+	tags, err := w.getRegistryTags(ctx, sourceID, lintingErr)
 	if err != nil {
 		return err
 	}
@@ -393,8 +393,11 @@ func getAndValidateAPIKey(ctx context.Context, orgSlug, workspaceSlug, registryL
 	return
 }
 
-func (w *Workflow) getRegistryTags(ctx context.Context, sourceID string) ([]string, error) {
-	tags := []string{"latest"}
+func (w *Workflow) getRegistryTags(ctx context.Context, sourceID string, lintingErr error) ([]string, error) {
+	var tags []string = []string{"latest"}
+	if lintingErr != nil {
+		return tags, nil
+	}
 	if env.IsGithubAction() {
 		// implicitly add branch tag
 		var branch string

internal/run/target.go

@@ -316,7 +316,7 @@ func (w *Workflow) snapshotCodeSamples(ctx context.Context, parentStep *workflow
 		return
 	}
 
-	tags, err := w.getRegistryTags(ctx, "")
+	tags, err := w.getRegistryTags(ctx, "", nil)
 	if err != nil {
 		return
 	}

internal/validation/openapi.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"io"
+	"os"
 	"slices"
 	"strings"
 
@@ -23,6 +24,7 @@ import (
 	"github.com/speakeasy-api/speakeasy/internal/interactivity"
 	"github.com/speakeasy-api/speakeasy/internal/log"
 	"go.uber.org/zap"
+	"gopkg.in/yaml.v3"
 )
 
 // OutputLimits defines the limits for validation output.
@@ -384,3 +386,40 @@ func generateReport(ctx context.Context, res validationResult) (reports.ReportRe
 	reportBytes := res.GenerateReport()
 	return reports.UploadReport(ctx, reportBytes, shared.TypeLinting)
 }
+
+// LooksLikeAnOpenAPISpec performs a basic check to determine if a file appears to be an OpenAPI spec.
+// It checks:
+// 1. The file can be unmarshaled as YAML (which also covers JSON)
+// 2. The file has the top-level keys: "openapi", "info", and "paths"
+//
+// This is a loose check intended to identify files that are likely OpenAPI specs even if they
+// have validation errors.
+func LooksLikeAnOpenAPISpec(schemaPath string) bool {
+	content, err := os.ReadFile(schemaPath)
+	if err != nil {
+		return false
+	}
+
+	return LooksLikeAnOpenAPISpecContent(content)
+}
+
+// LooksLikeAnOpenAPISpecContent performs a basic check on content to determine if it appears to be an OpenAPI spec.
+// It checks:
+// 1. The content can be unmarshaled as YAML (which also covers JSON)
+// 2. The content has the top-level keys: "openapi", "info", and "paths"
+func LooksLikeAnOpenAPISpecContent(content []byte) bool {
+	var doc map[string]any
+	if err := yaml.Unmarshal(content, &doc); err != nil {
+		return false
+	}
+
+	// Check for required top-level keys
+	requiredKeys := []string{"openapi", "info", "paths"}
+	for _, key := range requiredKeys {
+		if _, ok := doc[key]; !ok {
+			return false
+		}
+	}
+
+	return true
+}