[Feature Request] - a "meta" resource ApiResourceRepresentation and request method getResourceRepresentationTable

19 views
Skip to first unread message

MON KEY

unread,
Jul 28, 2012, 8:42:54 PM7/28/12
to etsy-...@googlegroups.com
IWBN if there were a "meta" resource representation "ApiResourceRepresentation" and an Etsy API method "getResourceRepresentationTable" for requesting details re the canonical format of resource representations exposed by the Etsy API i.e something equivalent what "getMethodTable" does with "ApiMethod".

Ideally, the response of such a method would include for each resource's representation; its name, description, details about its fields and assocations (their names, visibilities, permissions, types, and descriptions), along with the names of its methods.

The JSON for such a response might look something like this:

 {
 "name":<REPRESENTATION-NAME>,
 "description":<REPRESENTATION-DESCRIPTION>,
 "fields":[
 {"name":<FIELD-NAME>,
  "visibility_level":<FIELD-VISIBILITY>,
  "permission_scope":<FIELD-PERMISSION>,
  "type":<FIELD-TYPE>,
  "description":<FIELD-DESCRIPTION>},
  ...
  ],
 "associations":[
 {"name":<ASSOCIATION-NAME>
  "visibility_level":<ASSOCIATION-VISIBILITY>,
  "permission_scope":<ASSOCIATION-PERMISSION>,
  "type":<ASSOCIATION-TYPE>,
  "description":<ASSOCIATION-DESCRIPTION>},
  ...
  ],
 "methods":[ <METHOD-NAME>, ... ]
}
 
Currently the only exposed mechanism for interrogating this type of information is by manually examining the documentation published beneath: http://www.etsy.com/developers/documentation/<FOO>

Having a networked mechanism for accessing this type of information would be a real help when bootstrapping development of new Etsy apps.
Likewise, it might also make it easier for existing app developers to track if/when the API changes representations of a resource.

Reply all
Reply to author
Forward
0 new messages