How to write the spec for an endpoint so that the generated client does not require application/json mime type?

[atljoseph]

For those really backwards APIs and folks who don't maintain their specs... We still have to consume those APIs.

[atljoseph]

Example:

• spec says application/json is expected of the whole endpoint, but 200 OK has not Content-Type.
• 400 returns Content-Type as expected.

"/v1/user/password-reset-request": {
            "post": {
                "description": "Request a password reset email to reset your password.\n***Post Password Reset Request Object***\n\n| Key | Type |  Required | Description |  \n|:--|:--|:--|---|\n|UBI|String|Yes| UBI of the licensee user requesting a password reset email. |\n|Username|String|Yes| Username of the licensee user requesting a password reset email. |",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/forms.PasswordResetRequestPost"
                            }
                        }
                    },
                    "description": "body data",
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {}
                    },
                    "400": {
                        "description": "Bad Request",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/api_error.WebResponse"
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Unauthorized",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/api_error.WebResponse"
                                }
                            }
                        }
                    }
                },
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "summary": "Password reset",
                "tags": [
                    "User"
                ]
            }
        },

The generated client still requires application/json for the 200 OK response.

[ghost]

I can't reproduce it.

Generated decoder looks like this and it allows 200 OK to have any Content-Type.

func decodeV1UserPasswordResetRequestPostResponse(resp *http.Response) (res V1UserPasswordResetRequestPostRes, _ error) {
	switch resp.StatusCode {
	case 200:
		// Code 200.
		return &V1UserPasswordResetRequestPostOK{}, nil
	case 400:
		// Code 400.
		ct, _, err := mime.ParseMediaType(resp.Header.Get("Content-Type"))
		if err != nil {
			return res, errors.Wrap(err, "parse media type")
		}
		switch {
		case ct == "application/json":
...

[atljoseph]

Are you using convenient errors? Am not here

…

On Thu, Jun 13, 2024 at 11:48 PM tdakkota ***@***.***> wrote: I can't reproduce it. Generated decoder looks like this and it allows 200 OK to have any Content-Type. func decodeV1UserPasswordResetRequestPostResponse(resp *http.Response) (res V1UserPasswordResetRequestPostRes, _ error) { switch resp.StatusCode { case 200: // Code 200. return &V1UserPasswordResetRequestPostOK{}, nil case 400: // Code 400. ct, _, err := mime.ParseMediaType(resp.Header.Get("Content-Type")) if err != nil { return res, errors.Wrap(err, "parse media type") } switch { case ct == "application/json":... — Reply to this email directly, view it on GitHub <#1265 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AF632FI2AM7Y7V6IQNXT7QLZHJRXBAVCNFSM6AAAAABJHGUZV6VHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM4TONRZHEZTC> . You are receiving this because you authored the thread.Message ID: ***@***.***>