[PATCH v3 4/5] docs: Add missing series index schema

Daniel Axtens dja at axtens.net
Fri Nov 1 00:50:39 AEDT 2019


Huh. Do I understand correctly that this fixes a bug in the schema
description yaml/j2 files?

I think, if that's the case, that you need a Fixes tag, just above your
Signed-off.

I generate them by putting the following snippet in my ~/.gitconfig
file:

[core]
        abbrev = 12
[pretty]
        fixes = Fixes: %h (\"%s\")

and then using a shell alias that expands 'fixes <commit>' to
git log --oneline --format=fixes -n 1 <commit>

I haven't checked in great detail but I think this goes all the way back
to 7d8e24bc84bd ("docs: Start documenting API using OpenAPI")...

If you're able to check that and include it in the next revision, that
would be great. As it's a stand-alone fix, I'd also then be happy to
pull it in to master independently.

Hopefully I will get to the other two meatier patches tomorrow!

Regards,
Daniel

> Signed-off-by: Mete Polat <metepolat2000 at gmail.com>
> ---
>  docs/api/schemas/latest/patchwork.yaml | 5 +++++
>  docs/api/schemas/patchwork.j2          | 5 +++++
>  docs/api/schemas/v1.0/patchwork.yaml   | 5 +++++
>  docs/api/schemas/v1.1/patchwork.yaml   | 5 +++++
>  docs/api/schemas/v1.2/patchwork.yaml   | 5 +++++
>  5 files changed, 25 insertions(+)
>
> diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml
> index 4696900..cd33291 100644
> --- a/docs/api/schemas/latest/patchwork.yaml
> +++ b/docs/api/schemas/latest/patchwork.yaml
> @@ -1346,6 +1346,11 @@ components:
>            type: string
>            format: uri
>            readOnly: true
> +        series:
> +          title: Series URL
> +          type: string
> +          format: uri
> +          readOnly: true
>      Bundle:
>        required:
>          - name
> diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2
> index 4fc100e..6116578 100644
> --- a/docs/api/schemas/patchwork.j2
> +++ b/docs/api/schemas/patchwork.j2
> @@ -1353,6 +1353,11 @@ components:
>            type: string
>            format: uri
>            readOnly: true
> +        series:
> +          title: Series URL
> +          type: string
> +          format: uri
> +          readOnly: true
>      Bundle:
>        required:
>          - name
> diff --git a/docs/api/schemas/v1.0/patchwork.yaml b/docs/api/schemas/v1.0/patchwork.yaml
> index e6adfdd..ef3551d 100644
> --- a/docs/api/schemas/v1.0/patchwork.yaml
> +++ b/docs/api/schemas/v1.0/patchwork.yaml
> @@ -1219,6 +1219,11 @@ components:
>            type: string
>            format: uri
>            readOnly: true
> +        series:
> +          title: Series URL
> +          type: string
> +          format: uri
> +          readOnly: true
>      Bundle:
>        required:
>          - name
> diff --git a/docs/api/schemas/v1.1/patchwork.yaml b/docs/api/schemas/v1.1/patchwork.yaml
> index 6af697c..d984c5d 100644
> --- a/docs/api/schemas/v1.1/patchwork.yaml
> +++ b/docs/api/schemas/v1.1/patchwork.yaml
> @@ -1219,6 +1219,11 @@ components:
>            type: string
>            format: uri
>            readOnly: true
> +        series:
> +          title: Series URL
> +          type: string
> +          format: uri
> +          readOnly: true
>      Bundle:
>        required:
>          - name
> diff --git a/docs/api/schemas/v1.2/patchwork.yaml b/docs/api/schemas/v1.2/patchwork.yaml
> index 2ced470..30cadcc 100644
> --- a/docs/api/schemas/v1.2/patchwork.yaml
> +++ b/docs/api/schemas/v1.2/patchwork.yaml
> @@ -1346,6 +1346,11 @@ components:
>            type: string
>            format: uri
>            readOnly: true
> +        series:
> +          title: Series URL
> +          type: string
> +          format: uri
> +          readOnly: true
>      Bundle:
>        required:
>          - name
> -- 
> 2.23.0
>
> _______________________________________________
> Patchwork mailing list
> Patchwork at lists.ozlabs.org
> https://lists.ozlabs.org/listinfo/patchwork


More information about the Patchwork mailing list