search

netconf-wg / restconf

9 stars 4 forks source link

Use of module name in API resource #65

Closed abierman closed 8 years ago

abierman commented 8 years ago

The GET method is inconsistent for the API resource

https://tools.ietf.org/html/draft-ietf-netconf-restconf-13#appendix-D.1.1

Example shows GET /restconf

Response shows "ietf-restconf:restconf" as the element or object name.

Does this mean the server MUST accept the request GET /ietf-restconf:restconf

Are clients supposed to use the long form?

Should .well-known return the long or short version?

Propose:

   Target URI MUST use short form only, exactly as returned by .well-known
    Server SHOULD return module name ietf-restconf in the response
abierman commented 8 years ago

must send ietf-restconf:restconf

abierman commented 8 years ago

Added text to API resource section

The {+restconf} entry point resource name used in responses
 MUST identify the "ietf-restconf" YANG module.
 For example, a request to GET the entry point "/restconf"
 in JSON format will return a representation of
  the API resource named "ietf-restconf:restconf".
abierman commented 8 years ago

fixed in draft 15