Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.19 KB

CHANGELOG.md

File metadata and controls

61 lines (40 loc) · 2.19 KB

HEAD

Changes

  • New media types: All responses are now either application/vnd.grid5000.collection+json or application/vnd.grid5000.item+json (this is still JSON formatted payload). When you POST or PUT content, you can use application/json format or application/x-www-form-urlencoded.

  • /grid5000 prefix has been removed from URIs. For instance, /grid5000/sites/rennes/jobs becomes /sites/rennes/jobs.

  • XML output is no longer supported for the Reference API.

  • /sites/{{site_id}}/status is no longer a collection. Instead, there is now a nodes key which returns a hash with

      {hostname => {:soft => soft_state, :hard => hard_state, :reservations => [...]}}
    
  • In /sites/{{site_id}}/jobs, a lot more details are returned for each job.

  • In job description: user_uid is replaced by user. user_uid is still available but is going to be deprecated and removed in a future revision. site_uid is removed. A resources_by_type property is now available, which is a dictionary of the resources assigned to the job (cores, vlans, subnets), grouped by the type of the resource.

  • JSON payloads are no longer pretty by default. Use ?pretty=yes or add the HTTP headers X-Rack-PrettyJSON: yes to your requests if you want pretty output.

  • Notifications API is now available. This lets you send notifications via SMTP (email), XMPP (jabber), or HTTP. The Deployments API use it to send notifications when a deployments ends. You can now use it for yourself.

      $ curl -kni https://api.grid5000.fr/sid/notifications \
      -d "to[]=mailto:[email protected]&body=My Message"
    
  • Internally, the API is now released as a Debian package, for easy installation.

  • Latest stable API is now available under the https://api.grid5000.fr/stable alias.

Gotchas

  • Metrology API returns links with bad media type.

  • Vlan API (on the sites that support it) returns bad links.

  • Documentation on Restfully is needed.

These will be fixed ASAP.

2.x

Previously split into lots of small APIs. CHANGELOG will start from here.