README.md

ovh-api-services

Contains all AngularJS $resource for the OVHcloud API.

Install

$ yarn add ovh-api-services

Usage

import angular from 'angular';
import ovhApiServices from 'ovh-api-services';

angular.module('myApp', [ovhApiServices]);

Services

All services must return an AngularJS $resource and can be called by using:

Service	Engine	Library
v6	APIv6	n/a
Iceberg	Iceberg	@ovh-ux/ng-ovh-api-wrappers
Aapi	2API	n/a

How to get user informations?

OvhApiMe
  .v6()
  .get()
  .$promise
  .then((nichandle) => {
    console.log(nichandle);
    /*
    {
      "firstname": "John",
      "name": "Doe",
      …
    }
    */
  });

How to get a SSH Key detail?

OvhApiMe
  .SshKey()
  .v6()
  .get({
    keyName: 'YOUR_KEY_NAME',
  })
  .$promise
  .then((sshKey) => {
    console.log(sshKey);
    /*
    {
      "keyName": "test",
      "key": "ssh-rsa …",
      "default": false
    }
    */
  });

Structure

The files structure is defined as:

$ tree src/api/
.
└── me
    ├── sshKey
    │   ├── me-sshKey.service.js
    │   └── me-sshKey.v6.service.js
    ├── me.service.js
    └── me.v6.service.js

The directories structure must follow the structure of the API.

Test

$ yarn test

Related

• @ovh-ux/ng-ovh-api-wrappers - AngularJS component designed to configure API Endpoints.
• @ovh-ux/ng-ovh-swimming-poll - A poller to swim easily to success status.

Contributing

Always feel free to help out! Whether it's filing bugs and feature requests or working on some of the open issues, our contributing guide will help get you started.

License

BSD-3-Clause © OVH SAS