Method Finalize

expr/http_endpoint.go:746–841

Finalize is run post DSL execution. It merges response definitions, creates implicit endpoint parameters and initializes querystring parameters. It also flattens the error responses and makes sure the error types are all user types so that the response encoding code can properly use the type to infe

()

// types so that the response encoding code can properly use the type to infer
// the response that it needs to build.
func (e *HTTPEndpointExpr) Finalize() {
	// For JSON-RPC WebSocket endpoints with server streaming and non-streaming payload,
	// move the payload to streaming payload. This is because the payload is sent as
	// JSON-RPC messages after the WebSocket connection is established, making it
	// effectively a streaming payload from the transport perspective.
	if _, isJSONRPC := e.MethodExpr.Meta["jsonrpc"]; isJSONRPC && e.MethodExpr.Stream == ServerStreamKind && e.SSE == nil {
		if e.MethodExpr.Payload.Type != Empty && e.MethodExpr.StreamingPayload.Type == Empty {
			// Move payload to streaming payload
			e.MethodExpr.StreamingPayload = e.MethodExpr.Payload
			e.MethodExpr.Payload = &AttributeExpr{Type: Empty}
			// Change stream kind to bidirectional since we now have both streaming payload and result
			e.MethodExpr.Stream = BidirectionalStreamKind
		}
	}

	// Compute security scheme attribute name and corresponding HTTP location
	requirements := EffectiveSecurityRequirements(e.MethodExpr.Requirements)
	if reqLen := len(requirements); reqLen > 0 {
		e.Requirements = make([]*SecurityExpr, 0, reqLen)
		for _, req := range requirements {
			dupReq := DupRequirement(req)
			for _, sch := range dupReq.Schemes {
				var field string
				switch sch.Kind {
				case NoKind:
					continue
				case BasicAuthKind:
					sch.In = "header"
					sch.Name = "Authorization"
					continue
				case APIKeyKind:
					field = TaggedAttribute(e.MethodExpr.Payload, "security:apikey:"+sch.SchemeName)
				case BearerKind:
					field = TaggedAttribute(e.MethodExpr.Payload, "security:bearer")
				case JWTKind:
					field = TaggedAttribute(e.MethodExpr.Payload, "security:token")
				case OAuth2Kind:
					field = TaggedAttribute(e.MethodExpr.Payload, "security:accesstoken")
				}
				sch.Name, sch.In = findKey(e, field)
				if sch.Name == "" {
					// Initialize Authorization header implicitly defined via
					// security DSL if mapping isn't explicit.
					sch.Name = "Authorization"
					attr := e.MethodExpr.Payload.Find(field)
					e.Headers.Type.(*Object).Set(field, attr)
					e.Headers.Map(sch.Name, field)
					if e.MethodExpr.Payload.IsRequired(field) {
						if e.Headers.Validation == nil {
							e.Headers.Validation = &ValidationExpr{}
						}
						e.Headers.Validation.AddRequired(field)
					}
				}
			}
			e.Requirements = append(e.Requirements, dupReq)
		}
	}