Function buildOperation

http/codegen/openapi/v3/builder.go:192–351

buildOperation builds the OpenAPI Operation object for the given path.

(key string, r *expr.RouteExpr, bodies *EndpointBodies, rand *expr.ExampleGenerator, meta expr.MetaExpr)

// buildOperation builds the OpenAPI Operation object for the given path.
func buildOperation(key string, r *expr.RouteExpr, bodies *EndpointBodies, rand *expr.ExampleGenerator, meta expr.MetaExpr) *Operation {
	e := r.Endpoint
	m := e.MethodExpr
	svc := e.Service

	// OpenAPI summary
	var summary string
	setSummary := func(meta expr.MetaExpr) {
		for n, mdata := range meta {
			if (n == "openapi:summary" || n == "swagger:summary") && len(mdata) > 0 {
				if mdata[0] == "{path}" {
					summary = r.Path
				} else {
					summary = mdata[0]
				}
			}
		}
	}

	summary = fmt.Sprintf("%s %s", e.Name(), svc.Name())
	setSummary(meta)
	setSummary(svc.ServiceExpr.Meta)
	setSummary(e.Meta)
	setSummary(m.Meta)

	// OpenAPI operationId
	var operationIDFormat string
	setOperationIDFormat := func(meta expr.MetaExpr) {
		for n, mdata := range meta {
			if (n == "openapi:operationId") && len(mdata) > 0 {
				operationIDFormat = mdata[0]
			}
		}
	}

	operationIDFormat = defaultOperationIDFormat
	setOperationIDFormat(meta)
	setOperationIDFormat(m.Service.Meta)
	setOperationIDFormat(e.Meta)
	setOperationIDFormat(m.Meta)

	// request body
	var requestBody *RequestBodyRef
	if e.Body.Type != expr.Empty {
		ct := "application/json" // TBD: need a way to specify method media type in design...
		if e.MultipartRequest {
			ct = "multipart/form-data"
		}
		mt := &MediaType{Schema: bodies.RequestBody}
		initExamples(mt, e.Body, rand)
		requestBody = &RequestBodyRef{Value: &RequestBody{
			Description: e.Body.Description,
			Required:    e.Body.Type != expr.Empty,
			Content:     map[string]*MediaType{ct: mt},
			Extensions:  openapi.ExtensionsFromExpr(e.Body.Meta),
		}}
	}