From peterd at iea-software.com Tue Mar 15 16:14:43 2011 From: peterd at iea-software.com (Peter Deacon) Date: Tue, 15 Mar 2011 13:14:43 -0700 (Pacific Daylight Time) Subject: [arin-tech-discuss] REST API comments In-Reply-To: <9E818434-B036-46D5-B4AD-2CCB02DC6A4E@corp.arin.net> References: <9E818434-B036-46D5-B4AD-2CCB02DC6A4E@corp.arin.net> Message-ID: Thoughts on https://www.arin.net/resources/restful-interfaces.html There are still some problems with middleware and firewalls that just will not accept unusual verbs (PUT,DELETE..etc) Please consider including method overrides for PUT/DELETE in the documentation such as sending a variable named "method" with the requests or including a header... X-HTTP-Method-Override to work around these problems. The practice of collapsing API application response into http status codes is also popular but sadly has potential to cause problems if one is not very careful. Layered responses from both HTTP and the HTTP application provide the application with much better feedback than an HTTP layer response alone. For example if I mess up my local URL configuration or later introduce a firewall or proxy change my application may end up with a 404 from something else (Not ARIN) entirely. The application may then be confused into thinking the 404 response was actually from Arin...possibly further using this feedback to make incorrect assumptions about the state of records being managed. Likewise on your side if your server or middleware has a problem is it possible for the status codes of the server or intermediate layers to ever overlap with the application and cause the same confusion? If instead the application were to always depend on an application layer status the disambiguity and potential for problems is reduced. Here recommend always sending ErrorPayload not just for generic status and recommend in documentation the application check for ErrorPayload preferably taking no internal action against an error response if ErrorPayload is not present. ~P From markk at arin.net Thu Mar 17 14:08:10 2011 From: markk at arin.net (Mark Kosters) Date: Thu, 17 Mar 2011 18:08:10 +0000 Subject: [arin-tech-discuss] ARIN API Provisioning Changes Message-ID: Hi ARIN has recently made updates to its RESTful Provisioning API. You can find the new RESTful methods and payloads documentation at: https://www.arin.net/resources/restful-interfaces.html In addition, attached to this message is a version with changes tracked, to help you in identifying what specifically changed from the previous release. ARIN is releasing production code on March 19 that matches this version of the RESTful Provisioning API. Regards, Mark Kosters Chief Technical Officer American Registry for Internet Numbers (ARIN) -------------- next part -------------- A non-text attachment was scrubbed... Name: rest_payloads_public-ChangesTracked.pdf Type: application/pdf Size: 251463 bytes Desc: rest_payloads_public-ChangesTracked.pdf URL: -------------- next part -------------- A non-text attachment was scrubbed... Name: rest_methods_public-ChangesTracked.pdf Type: application/pdf Size: 176112 bytes Desc: rest_methods_public-ChangesTracked.pdf URL: