OpenAPI doesn't appear to support versioning natively, suggesting
instead that separate documents are kept. Rather than doing this
manually, let's use a templating tool - Jinja2, in this case - to
generate these document for us from a single master document.
Signed-off-by: Stephen Finucane <step...@that.guru>
---
.gitignore | 1 +
docs/api/schemas/generate_schema.py | 29 +++++++++++++++++
.../schemas/{patchwork.yaml => patchwork.j2} | 31 +++++++++++++++++--
3 files changed, 59 insertions(+), 2 deletions(-)
create mode 100644 docs/api/schemas/generate_schema.py
rename docs/api/schemas/{patchwork.yaml => patchwork.j2} (98%)
diff --git a/.gitignore b/.gitignore
index a33d1029..da53b382 100644
--- a/.gitignore
+++ b/.gitignore
@@ -44,6 +44,7 @@ htmlcov/
# Sphinx stuff
/docs/_build
+/docs/api/schemas/v*
# Selenium test artifacts
/selenium.log
diff --git a/docs/api/schemas/generate_schema.py
b/docs/api/schemas/generate_schema.py
new file mode 100644
index 00000000..65d4ed82
--- /dev/null
+++ b/docs/api/schemas/generate_schema.py
@@ -0,0 +1,29 @@
+#!/usr/bin/env python3
+
+import os
+
+import jinja2
+
+ROOT_DIR = os.path.dirname(os.path.realpath(__file__))
+VERSIONS = [(1, 0), (1, 1)]
+
+
+def generate_schema():
+ env = jinja2.Environment(
+ loader=jinja2.FileSystemLoader(ROOT_DIR),
+ trim_blocks=True,
+ lstrip_blocks=True)
+ template = env.get_template('patchwork.j2')
+
+ for version in VERSIONS:
+ version_dir = os.path.join(ROOT_DIR, 'v%d.%d' % version)
+
+ if not os.path.exists(version_dir):
+ os.mkdir(version_dir)
+
+ with open(os.path.join(version_dir, 'patchwork.yaml'), 'wb') as fh:
+ template.stream(version=version).dump(fh, encoding='utf-8')
+
+
+if __name__ == '__main__':
+ generate_schema()
diff --git a/docs/api/schemas/patchwork.yaml b/docs/api/schemas/patchwork.j2
similarity index 98%
rename from docs/api/schemas/patchwork.yaml
rename to docs/api/schemas/patchwork.j2
index cf78a87f..752a9c5e 100644
--- a/docs/api/schemas/patchwork.yaml
+++ b/docs/api/schemas/patchwork.j2
@@ -1,3 +1,6 @@
+{# You can obviously ignore the below when editing this template #}
+# DO NOT EDIT THIS FILE. It is generated from a template. Changes should be
+# proposed against the template.
openapi: '3.0.0'
info:
title: Patchwork API
@@ -9,7 +12,7 @@ info:
license:
name: GPL v2 License
url: https://www.gnu.org/licenses/gpl-2.0.html
- version: '1.1'
+ version: '{{ "%d.%d"|format(*version) }}'
paths:
/api/:
get:
@@ -1137,11 +1140,13 @@ components:
type: string
format: uri
readOnly: true
+{% if version == '1.0' %}
web_url:
title: Web url
type: string
format: uri
readOnly: true
+{% endif %}
project:
$ref: '#/components/schemas/ProjectEmbedded'
name:
@@ -1256,11 +1261,13 @@ components:
title: ID
type: integer
readOnly: true
+{% if version > (1, 0) %}
web_url:
title: Web url
type: string
format: uri
readOnly: true
+{% endif %}
msgid:
title: Msgid
type: string
@@ -1302,11 +1309,13 @@ components:
type: string
format: uri
readOnly: true
+{% if version > (1, 0) %}
web_url:
title: Web url
type: string
format: uri
readOnly: true
+{% endif %}
project:
$ref: '#/components/schemas/ProjectEmbedded'
msgid:
@@ -1326,18 +1335,22 @@ components:
minLength: 1
submitter:
$ref: '#/components/schemas/PersonEmbedded'
+{% if version > (1, 0) %}
mbox:
title: Mbox
type: string
format: uri
readOnly: true
+{% endif %}
series:
$ref: '#/components/schemas/SeriesEmbedded'
+{% if version > (1, 0) %}
comments:
title: Comments
type: string
format: uri
readOnly: true
+{% endif %}
CoverLetterDetail:
allOf:
- $ref: '#/components/schemas/CoverLetterList'
@@ -1506,11 +1519,13 @@ components:
type: string
format: uri
readOnly: true
+{% if version > (1, 0) %}
web_url:
title: Web url
type: string
format: uri
readOnly: true
+{% endif %}
project:
$ref: '#/components/schemas/ProjectEmbedded'
msgid:
@@ -1566,11 +1581,13 @@ components:
readOnly: true
series:
$ref: '#/components/schemas/SeriesEmbedded'
+{% if version > (1, 0) %}
comments:
title: Comments
type: string
format: uri
readOnly: true
+{% endif %}
check:
title: Check
type: string
@@ -1725,6 +1742,7 @@ components:
$ref: '#/components/schemas/UserEmbedded'
readOnly: true
uniqueItems: true
+{% if version > (1, 0) %}
subject_match:
title: Subject match
description: Regex to match the subject against if only part of
emails
@@ -1735,6 +1753,7 @@ components:
type: string
readOnly: true
minLength: 1
+{% endif %}
Series:
type: object
properties:
@@ -1747,11 +1766,13 @@ components:
type: string
format: uri
readOnly: true
+{% if version > (1, 0) %}
web_url:
title: Web url
type: string
format: uri
readOnly: true
+{% endif %}
project:
$ref: '#/components/schemas/ProjectEmbedded'
name:
@@ -1889,11 +1910,13 @@ components:
type: string
format: uri
readOnly: true
+{% if version > (1, 0) %}
web_url:
title: Web url
type: string
format: uri
readOnly: true
+{% endif %}
msgid:
title: Msgid
type: string
@@ -1926,11 +1949,13 @@ components:
type: string
format: uri
readOnly: true
+{% if version > (1, 0) %}
web_url:
title: Web url
type: string
format: uri
readOnly: true
+{% endif %}
msgid:
title: Msgid
type: string
@@ -2040,11 +2065,13 @@ components:
type: string
format: uri
readOnly: true
+{% if version > (1, 0) %}
web_url:
title: Web url
type: string
format: uri
readOnly: true
+{% endif %}
name:
title: Name
description: An optional name to associate with the series, e.g.
"John's PCI
@@ -2177,4 +2204,4 @@ components:
type: string
readOnly: true
servers:
-- url: 'https://patchwork.ozlabs.org/api/1.1'
+- url: 'https://patchwork.ozlabs.org/api/{{ "%d.%d"|format(*version) }}'
--
2.17.2
_______________________________________________
Patchwork mailing list
Patchwork@lists.ozlabs.org
https://lists.ozlabs.org/listinfo/patchwork
