owners remove/ add response does not fit documentation

[2ndDerivative]

Problem

The Registry Web API documentation says the Owner --remove command needs a JSON object

{
    "ok":true
}

even though it needs the same OwnerResponse object as the add command, which also has a msg field.
This causes registries that fit the documentation API to error out the user for an incomplete JSON when removing a user.

Steps

Respond to the Owner remove API request with a JSON object without the "msg" field.
Cargo will error out with

error: failed to remove owners from crate `[crate-name]` on registry at [endpoint]

Caused by:
  missing field `msg` at line 1 column 11

Possible Solution(s)

Either the OwnerResponse object should probably be split into AddResponse and RemoveResponse to fit the documentation, or the msg field on the remove method should be used, or the msg field should be made optional.

Notes

No response

Version

No response

[weihanglo]

Just looked into crates.io implementation, it always responds a JSON of { ok, msg }.

Given Cargo already fails when missing that field, I would recommend adding the msg field to the documentation. It shouldn't be a breaking change to registry implementors.

[weihanglo]

Place that needs a tweak:

cargo/src/doc/src/reference/registry-web-api.md

Lines 307 to 312 in a285008

	```javascript
	{
	// Indicates the remove succeeded, always true.
	"ok": true
	}
	```

[2ndDerivative]

I'd also suggest putting in the message display into cargo, I can do that later

[Bhardwaj-Himanshu]

Hi everyone, from my understanding
this-

{ 
    // Indicates the remove succeeded, always true. 
    "ok": true 
} 

should be replaced to something like-

{ 
   // some kind of message here
   "ok": true 
} 

But being unsure of how AddResponse and RemoveResponse work, I am unable to sense what changes to make and how.
Are these 2 seperate functions which need to be added as-

Addresponse { 
    // something_1
    "ok": true 
} 

and

RemoveResponse{ 
    // something_1
    "ok": true 
}

Or Add response and Remove response are just messages that need to be displayed whenever user interacts with this?

Also, let me know if someone is upto some ideas and how he/she is working on this.
Thanks

[2ndDerivative]

No the Json object response to cargo owner --remove needs to be replaced by

{
    "message": "Some message here",
    "ok": true
}

because the reponse cargo expects is the same as the response to cargo owner --add.

[Bhardwaj-Himanshu]

So the message which needs to go in there should be like

{
     "message": "task performed successfully",

     #not writing owner removed or owner added       here, as mentioned by you, the object responds similarly for both the cases.
      "ok": "true"

}

This message was written via phone, so pardon me for the improper syntax here;)

[2ndDerivative]

The message field in the reponse to owner --remove is not used in any way, but cargo expects it to just exist. So so far there can be anything there.

what we need to change is the documentation to recommend putting a message there to API implementors and warning that it's needed but not used (yet).

[Rustin170506]

@weihanglo I guess we can close this issue now.

[weihanglo]

Surely. Thanks!

Fixed by #12068