Function buildFileServerOperation

http/codegen/openapi/v3/builder.go:354–445

buildFileServerOperation builds the OpenAPI Operation object for the given file server.

(key string, fs *expr.HTTPFileServerExpr, api *expr.APIExpr)

// buildFileServerOperation builds the OpenAPI Operation object for the given file server.
func buildFileServerOperation(key string, fs *expr.HTTPFileServerExpr, api *expr.APIExpr) *Operation {
	wildcards := expr.ExtractHTTPWildcards(key)
	svc := fs.Service

	// parameters
	var params []*ParameterRef
	if len(wildcards) > 0 {
		pref := ParameterRef{
			Value: &Parameter{
				// Use the literal wildcard (including leading '*') as name to match path if needed
				// Note: HTTPWildcardRegex already strips '*' in ExtractHTTPWildcards; however
				// the path key has been normalized to "/{name}" so the correct parameter name
				// is the bare wildcard identifier.
				Name:        wildcards[0],
				Description: "Relative file path",
				In:          "path",
				Required:    true,
				Schema: &openapi.Schema{ // string schema makes validators happy
					Type: openapi.String,
				},
			},
		}
		params = []*ParameterRef{&pref}
	}

	// responses
	var responses map[string]*ResponseRef
	{
		desc200 := "File downloaded"
		rref := ResponseRef{
			Value: &Response{
				Description: &desc200,
			},
		}
		responses = map[string]*ResponseRef{
			"200": &rref,
		}
		if len(wildcards) > 0 {
			desc404 := "File not found"
			responses["404"] = &ResponseRef{
				Value: &Response{
					Description: &desc404,
				},
			}
		}
	}

	// OpenAPI summary
	var summary string
	summary = fmt.Sprintf("Download %s", fs.FilePath)
	for n, mdata := range fs.Meta {
		if (n == "openapi:summary" || n == "swagger:summary") && len(mdata) > 0 {
			summary = mdata[0]
		}
	}

	// OpenAPI operationId
	var operationIDFormat string