From dea6ffc48e695081b04fd727e7700edf6a988d8f Mon Sep 17 00:00:00 2001 From: Benjamin Webb <40066515+webb-ben@users.noreply.github.com> Date: Tue, 16 May 2023 21:01:45 -0400 Subject: [PATCH] Create separate tag for jobs in OAS (#1246) Move paths for `/jobs**` from server tag to separate tag when generating OpenAPI document --- pygeoapi/openapi.py | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/pygeoapi/openapi.py b/pygeoapi/openapi.py index af15630..44745e2 100644 --- a/pygeoapi/openapi.py +++ b/pygeoapi/openapi.py @@ -1207,7 +1207,7 @@ def get_oas_30(cfg): 'get': { 'summary': 'Retrieve jobs list', 'description': 'Retrieve a list of jobs', - 'tags': ['server'], + 'tags': ['jobs'], 'operationId': 'getJobs', 'responses': { '200': {'$ref': '#/components/responses/200'}, @@ -1221,7 +1221,7 @@ def get_oas_30(cfg): 'get': { 'summary': 'Retrieve job details', 'description': 'Retrieve job details', - 'tags': ['server'], + 'tags': ['jobs'], 'parameters': [ name_in_path, {'$ref': '#/components/parameters/f'} @@ -1236,7 +1236,7 @@ def get_oas_30(cfg): 'delete': { 'summary': 'Cancel / delete job', 'description': 'Cancel / delete job', - 'tags': ['server'], + 'tags': ['jobs'], 'parameters': [ name_in_path ], @@ -1253,7 +1253,7 @@ def get_oas_30(cfg): 'get': { 'summary': 'Retrieve job results', 'description': 'Retrive job resiults', - 'tags': ['server'], + 'tags': ['jobs'], 'parameters': [ name_in_path, {'$ref': '#/components/parameters/f'} @@ -1267,6 +1267,12 @@ def get_oas_30(cfg): } } + tag = { + 'name': 'jobs', + 'description': 'Process jobs', + } + oas['tags'].insert(1, tag) + oas['paths'] = paths return oas