maiste / equinoxe Goto Github PK

The module should provide functionalities to get and update the user information.

It is possible to create tags on different machines.

Provide more functions to the API module:

• #14

It doesn't really make sense to have a package for the executable as it is only for internal manipulations.

Add some helpers to Ezjsonm to easily parse JSON

Provide an Equinoxe.Ezcurl Module.

Once the test system has been deployed, the library and the CLI can be released 🎉

Add more functions to the device API.

Add more functions to projects api.

The goal is to provide a module to check if the metro given has space to run a specific machine.

Maybe with Alcotest

Add more HTTP function to equinoxe -> ezcurl module:

• #10
• #11
• #12

As the new interface has been proposed, a new release can be made.

Access print the wrong json:

let access field json =
    try Ezjsonm.find json [ field ]
    with Not_found ->
      raise
        (Ezjsonm.Parse_error
           (`String field, Format.sprintf "access: field %s not found" field))

It must be:

 raise
        (Ezjsonm.Parse_error
           (json, Format.sprintf "access: field %s not found" field))

Allow to get a token an execute a simple action:

 $ equinoxe-cli user_id --token "path:/path/to/token" user_id
 > The user id related to this token is 5555-422222-*

To allow people deploying their own system, we need to be able to provide a iPXE system in Equinoxe.create

From #61 by @art-w:

You probably don't want to call this run on all the http calls, rather the Equinoxe api should also produce Lwt values when the backend requires it. To stay compatible with "direct style" I/O, you can abstract the monad in the backend:

type 'a m
val return : 'a -> 'a m
val bind : ('a -> 'b m) -> 'a m -> 'b m
(* ... *)
val post : t -> path:string -> Json.t -> Json.t m

Then the backend can instantiate with type 'a m = 'a Lwt.t or type 'a m = 'a (here's an example of what it might look like)

I'm not sure that Json.t = (Ezjsonm.value, ...) result is the right type for the input? (the body of the request could be a string or Ezjsonm.value, but the backend shouldn't care about an Error in the input?)

• The HTTP module should be abstract to hide to the user the content.
• The Json type should be updated to better fit the requirement. The result type might not be needed only from extraction. Maybe the result type should be used as follow `(Json.t, Json.error) result.

• Support another Http server with httpaf.

the command should be in Equinix format. For example:

$ equinix-cli /organizations/id <id>

This is related to #31 issue.

Add more functions to the organization API.

• Add a friendly API to interact with object.

Define a Functor API to build an easy to use API but with a specific HTTP system.

The API must:

• reflect the Equinix API Documentation