[Openid-specs-fapi] API-ID's

[Nat Sakimura]

Hi Sascha, 

 

Welcome to the FAPI WG. 

 

Good point re: error code. 

 

Can you suggest the actual text change? A pull request would be great. 

 

Best, 

 

Nat

 

--

PLEASE READ :This e-mail is confidential and intended for the

named recipient only. If you are not an intended recipient,

please notify the sender  and delete this e-mail.

 

From: Openid-specs-fapi [mailto:openid-specs-fapi-bounces at lists.openid.net]
On Behalf Of Preibisch, Sascha H
Sent: Wednesday, July 20, 2016 5:53 AM
To: Openid-specs-fapi at lists.openid.net
Subject: [Openid-specs-fapi] API-ID's

 

Hi!

 

The spec specifies error codes for API errors. 

 

I am suggesting to also specify an API-ID for each specified API.

 

For example, the "/account" API could have an identifier such as "100000".

 

In error cases, an API would not only return the error code (e.g.: 701) but
also the API-ID:

*	error: 100000701 or 100000-701

That value could be used by a developer and search for it in the
documentation. It would make debugging much easier.

 

As I have experienced, developers sometimes do not really know which API
failed. Especially if they use libraries that call many API's at once.

 

I would like to know what others think about the idea.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openid.net/pipermail/openid-specs-fapi/attachments/20160720/222ec100/attachment.html>