Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Lack of documentation #17
Due to many other things to do, I have to admit that the documentation has less priority. Would you like to help? I would need to know where you've been stuck when trying to use this library. So, what would you miss beyond a basic introduction? I'm not sure if the complete api should be documented, because most of it should be conform to the official Docker remote api.
I'm creating the client like this
Is that correct? Am I missing something?!
Also, have you implemented any method to generate containerConfig, as provided by Spotify's API?
For auth/login, the default
On the other question for a more explicit api: The docker-client doesn't provide any types or interfaces for the containerConfig or other payload. So the best way is to understand the remote api and manually pass a map with your container config. An example can be found in the integration tests as well: https://github.com/gesellix-docker/docker-client/blob/master/src/integrationTest/groovy/de/gesellix/docker/client/DockerClientImplIntegrationSpec.groovy#L390
I don't prefer adding explicit interfaces to the docker-client because I'd like to stay compatible to old and even new api versions. In my experience the docker-client didn't have any issues with api changes and I would expect a user to understand which properties to use.
If you prefer some more explicit types or some kind of "help" via the docker client's api, I would suggest you to have a look at the docker-java library. It is well maintained and supports current api versions, but there are two main differences to my docker-client implementation: