[katello-devel] Proposal: use API documentation for param_rules

[Ivan Necas]

----- Original Message -----
> On 01/02/13 03:45 PM, Ivan Necas wrote:
> > Hi there,
> >
> > When you look at our API controllers today: you might notice one
> > duplicity quite often:
> >
> > 1. There is param_rules method defined, which lists all the params
> > that are acceptable for given action
> >
> > 2. There is API documenation, listing the parmas that are
> > acceptable.
> >
> > Proposal:
> >
> > Use the API documentatoin to produce the param_rules. Benefits:
> >
> > 1. code duplicates reduction
> > 2. more accurate API documentation
> >
> > Opinions?
> 
> Don't like the idea. Let's not introduce *ANY* code generation into
> the
> codebase used by living/breathing developers. Code takes precedence
> over
> docs, not the other way around.

We clearly didn't understand each other: no code would be generated. It's
just reusing the data that are in the documenation anyway. The trick is
our API docs is the code.

-- Ivan

> 
> 
> -d
> 
> >
> > -- Ivan
> >
> > _______________________________________________
> > katello-devel mailing list
> > katello-devel at redhat.com
> > https://www.redhat.com/mailman/listinfo/katello-devel
> 
> _______________________________________________
> katello-devel mailing list
> katello-devel at redhat.com
> https://www.redhat.com/mailman/listinfo/katello-devel
>