Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Human URL, Machine URL #9

Open
OriPekelman opened this issue May 30, 2014 · 0 comments
Open

Human URL, Machine URL #9

OriPekelman opened this issue May 30, 2014 · 0 comments
Labels

Comments

@OriPekelman
Copy link

Both attributes are ambiguous. This is about documentation. I imagined MachineURL to be the initial entry point of the API.

Please think about the Hypermedia crowd where the API is the "Machine Readable" documentation.

        "documentation":{
        "humanURL": "https://api-commons.3scale.net/docs",
        "machineURL": "http://api.apicommons.org/swagger-spec.json"
        },

Please consider some API provider will provide multiple metadata / documentation formats.

Better provide an array of entry points. Which you basically have with the "urls" element. But better call this links and instead of "URL" use the more common "href" attribute name. Something like

 "links":
 {
   "documentation":
   [
     {
       "type":"text/html",
       "href":"https://api-commons.3scale.net/docs",
       "title":"Human readable docs",
       "titles":
       {
         "en-us":"Human readable docs",
         "fr-fr":"Documentation à visée humaine"
       }
     },
 {
       "type":"application/json+swagger",
       "href":"https://api-commons.3scale.net/docs",
       "title":"Swagger formatted documention",
       "titles":
       {
         "en-us":"Swagger format docs",
         "fr-fr":"documentation en mode swagger"
       }
     },
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants