[Kimchi-devel] [PATCH] [API Docs] Keep Document Consistent with Code Logic

[Paulo Ricardo Paz Vital]

Hongliang, the issue is not in the API.json, but in the controller
(backend) side. There is a wrong field name in the parameters list
available to be updated.

Please, re-send your patch, discarding this changes and following the
changes in [1]. With this change your patch "[PATCH v2 0/4] Host
Repository Management Support" will not print the error "KCHAPI0004E:
Parameters is_mirror are not allowed to be updated in repository" when
editing a repository.

[1] http://fpaste.org/84412/55975313/

Thanks and best regards,
-- 
Paulo Ricardo Paz Vital <pvital at linux.vnet.ibm.com>
IBM Linux Technology Center

On Tue, 2014-03-11 at 21:06 +0800, Sheldon wrote:
> On 03/04/2014 06:15 PM, Hongliang Wang wrote:
> > is_mirror field is not allowed to update so remove the lines in
> > API document.
> >
> > Signed-off-by: Hongliang Wang <hlwang at linux.vnet.ibm.com>
> > ---
> >   docs/API.md | 2 --
> >   1 file changed, 2 deletions(-)
> >
> > diff --git a/docs/API.md b/docs/API.md
> > index fc39c65..c24af9e 100644
> > --- a/docs/API.md
> > +++ b/docs/API.md
> > @@ -891,8 +891,6 @@ repository.
> >       * baseurl *(optional)*: URL to the repodata directory when
> >   "is_mirror" is false. Otherwise, it can be URL to the mirror system for
> >   YUM. Can be an http://, ftp:// or file://  URL.
> > -    * is_mirror *(optional)*: Set the given URI of baseurl as a mirror
> > -list, instead of use baseurl in repository configuration.
> >       * url_args *(optional)*: Arguments to be passed to baseurl, like the
> >   list of APT repositories provided by the same baseurl.
> >       * gpgcheck *(optional)*: Indicates if a GPG signature check on the
> should also remove it from API.json？
> $ git diff
> diff --git a/src/kimchi/API.json b/src/kimchi/API.json
> index 6e932ed..ab83594 100644
> --- a/src/kimchi/API.json
> +++ b/src/kimchi/API.json
> @@ -568,10 +568,6 @@
> "type": "string",
> "error": "KCHREPOS0002E"
> },
> - "is_mirror": {
> - "description": "Set the given URI of baseurl as a mirror list",
> - "type": "boolean"
> - },
> "url_args": {
> "description": "Arguments to be passed to baseurl, like the list of APT 
> repositories provided by the same baseurl.",
> "type": "string",
> 
>