Re: [foreman-dev] RFC for foreman_api_v3

2016-08-26 Thread Tomas Strachota 

On 08/26/2016 10:39 AM, Daniel Lobato Garcia wrote:

On 08/26, Joseph Magen wrote:

Hi all,

I created a RFC for a plugin called foreman_api_v3
 and
the initial repo at github.com/isratrade/foreman_api_v3. If the community
accepts, I am happy to move this repo to theforeman/foreman_api_v3

I choose to make this a plugin rather than a PR so it is optional for users
and doesn't affect the core code. The initial repo only includes the GET
`index` and `show` actions. The PUT/PATCH/POST/DELETE actions need to be
added. Also, there are currently no functional tests in the repo, so a lot
more work needs to be done.


Given more testing, and full functionality, I don't see why not making
this part of Foreman itself vs a plugin. Using json:api sounds great to
me, so thanks for doing it.

Having said that (and derailing a bit), I would want v3 not only to
comply with json:api but also to be documented with http://swagger.io/
instead. This gives us:


I'm not very familiar with swagger. Would that mean replacing apipie 
completely or exporting from apipie to swagger's format?




 - automated, better docs than what we have (example
   http://petstore.swagger.io/#!/pet/updatePet)
 - automated tests to ensure docs do what they say
 - generates an SDK for the API in many languages
   automatically through https://github.com/swagger-api/swagger-codegen

--
Daniel Lobato Garcia

@dLobatog
blog.daniellobato.me
daniellobato.me

GPG: http://keys.gnupg.net/pks/lookup?op=get=0x7A92D6DD38D6DE30
Keybase: https://keybase.io/elobato



--
You received this message because you are subscribed to the Google Groups 
"foreman-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to foreman-dev+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Re: [foreman-dev] RFC for foreman_api_v3

2016-08-26 Thread Dominic Cleal 
On 26/08/16 06:58, Joseph Magen wrote:
> I created a RFC for a plugin called foreman_api_v3
>  and
> the initial repo at github.com/isratrade/foreman_api_v3
> . If the community accepts,
> I am happy to move this repo to theforeman/foreman_api_v3
> 
> I choose to make this a plugin rather than a PR so it is optional for
> users and doesn't affect the core code.

Please consider calling it something else that won't cause confusion for
users with Foreman's own API versioning.

-- 
Dominic Cleal
domi...@cleal.org

-- 
You received this message because you are subscribed to the Google Groups 
"foreman-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to foreman-dev+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.