Azure Function Return Deprecated API Header

Question

I have an Azure Function that sits behind a proxy. If an update occurs to the objects that get returned we want to deprecate the Function after a period of time. I'm trying to create a response with the expected content from an HTTP Header by using what was provided in this solution.

Warning: 299 - "Deprecated API"

I try to append the Azure Function like so:

 [FunctionName("MyAPI")]
    public static async Task<HttpResponseMessage> Run([HttpTrigger(AuthorizationLevel.Function,
        "post", Route = null)]
        HttpRequestMessage req,
        TraceWriter log)
    {            
        object response = await someService.Get();
        if (settingsService.IsDeprecated)
        {
            var httpresponse = req.CreateResponse(HttpStatusCode.OK, response, "application/json");
            httpresponse.Content.Headers.Add("Warning", "299 - Deprecated API");
            return httpresponse;
        }
        return req.CreateResponse(HttpStatusCode.OK, response, "application/json");
    }

I get the Exception

Exception while executing function: MyAPI -> Misused header name. Make sure request headers are used with HttpRequestMessage, response headers with HttpResponseMessage, and content headers with HttpContent objects.

How do I append the "Deprecated" status warning in my API Http Response?

Mikhail Shilkov · Accepted Answer · 2018-04-03 20:17:12Z

2

Change your line to

httpresponse.Headers.Add("Warning", "299 - \"Deprecated API\"");

The quotes seem to be important there to adhere to the format requirement.

edited Apr 3, 2018 at 20:17

answered Apr 3, 2018 at 19:58

Mikhail Shilkov

35.3k4 gold badges78 silver badges110 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Azure Function Return Deprecated API Header

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related