Skip to content

Commit

Permalink
Make dag_run_id nullable in openapi.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
jdddog committed Aug 18, 2023
1 parent 724bfd7 commit 65b48c9
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 52 deletions.
2 changes: 1 addition & 1 deletion docs/api/DatasetRelease.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
</tr>
<tr>
<td><strong>dag_run_id</strong></td>
<td><strong>str</strong></td>
<td><strong>str, none_type</strong></td>
<td></td>
<td>[optional] </td>
</tr>
Expand Down
25 changes: 0 additions & 25 deletions docs/api/ObservatoryApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,11 +154,6 @@ void (empty response body)
<td>DatasetRelease deleted</td>
<td> - </td>
</tr>
<tr>
<td><strong>401</strong></td>
<td>API key is missing or invalid</td>
<td> * WWW_Authenticate - <br> </td>
</tr>

</tbody>
</table></div>
Expand Down Expand Up @@ -277,11 +272,6 @@ with observatory.api.client.ApiClient(configuration) as api_client:
<td>bad input parameter</td>
<td> - </td>
</tr>
<tr>
<td><strong>401</strong></td>
<td>API key is missing or invalid</td>
<td> * WWW_Authenticate - <br> </td>
</tr>

</tbody>
</table></div>
Expand Down Expand Up @@ -406,11 +396,6 @@ with observatory.api.client.ApiClient(configuration) as api_client:
<td>bad input parameter</td>
<td> - </td>
</tr>
<tr>
<td><strong>401</strong></td>
<td>API key is missing or invalid</td>
<td> * WWW_Authenticate - <br> </td>
</tr>

</tbody>
</table></div>
Expand Down Expand Up @@ -538,11 +523,6 @@ with observatory.api.client.ApiClient(configuration) as api_client:
<td>DatasetRelease created, returning the created object with an id</td>
<td> - </td>
</tr>
<tr>
<td><strong>401</strong></td>
<td>API key is missing or invalid</td>
<td> * WWW_Authenticate - <br> </td>
</tr>

</tbody>
</table></div>
Expand Down Expand Up @@ -675,11 +655,6 @@ with observatory.api.client.ApiClient(configuration) as api_client:
<td>DatasetRelease created, returning the created object with an id</td>
<td> - </td>
</tr>
<tr>
<td><strong>401</strong></td>
<td>API key is missing or invalid</td>
<td> * WWW_Authenticate - <br> </td>
</tr>

</tbody>
</table></div>
Expand Down
25 changes: 2 additions & 23 deletions docs/api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,6 @@ paths:
$ref: '#/definitions/DatasetRelease'
400:
description: bad input parameter
401:
description: API key is missing or invalid
$ref: '#/responses/UnauthorizedError'
post:
tags:
- Observatory
Expand All @@ -82,9 +79,6 @@ paths:
description: DatasetRelease created, returning the created object with an id
schema:
$ref: '#/definitions/DatasetRelease'
401:
description: API key is missing or invalid
$ref: '#/responses/UnauthorizedError'
put:
tags:
- Observatory
Expand Down Expand Up @@ -113,9 +107,6 @@ paths:
description: DatasetRelease created, returning the created object with an id
schema:
$ref: '#/definitions/DatasetRelease'
401:
description: API key is missing or invalid
$ref: '#/responses/UnauthorizedError'
delete:
tags:
- Observatory
Expand All @@ -136,9 +127,6 @@ paths:
responses:
200:
description: DatasetRelease deleted
401:
description: API key is missing or invalid
$ref: '#/responses/UnauthorizedError'

/v1/dataset_releases:
get:
Expand Down Expand Up @@ -170,9 +158,6 @@ paths:
$ref: '#/definitions/DatasetRelease'
400:
description: bad input parameter
401:
description: API key is missing or invalid
$ref: '#/responses/UnauthorizedError'

definitions:
DatasetRelease:
Expand All @@ -189,6 +174,7 @@ definitions:
dag_run_id:
type: string
example: "YYYY-MM-DDTHH:mm:ss.ssssss"
x-nullable: true
data_interval_start:
type: string
format: date-time
Expand Down Expand Up @@ -240,11 +226,4 @@ definitions:
example: {'view-id': '830'}
minLength: 1
maxLength: 512
x-nullable: true

responses:
UnauthorizedError:
description: API key is missing or invalid
headers:
WWW_Authenticate:
type: string
x-nullable: true
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ def openapi_types():
'id': (int,), # noqa: E501, F821
'dag_id': (str,), # noqa: E501, F821
'dataset_id': (str,), # noqa: E501, F821
'dag_run_id': (str,), # noqa: E501, F821
'dag_run_id': (str, none_type,), # noqa: E501, F821
'data_interval_start': (datetime, none_type,), # noqa: E501, F821
'data_interval_end': (datetime, none_type,), # noqa: E501, F821
'snapshot_date': (datetime, none_type,), # noqa: E501, F821
Expand Down Expand Up @@ -162,7 +162,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
id (int): [optional] # noqa: E501
dag_id (str): [optional] # noqa: E501
dataset_id (str): [optional] # noqa: E501
dag_run_id (str): [optional] # noqa: E501
dag_run_id (str, none_type): [optional] # noqa: E501
data_interval_start (datetime, none_type): [optional] # noqa: E501
data_interval_end (datetime, none_type): [optional] # noqa: E501
snapshot_date (datetime, none_type): [optional] # noqa: E501
Expand Down Expand Up @@ -262,7 +262,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
id (int): [optional] # noqa: E501
dag_id (str): [optional] # noqa: E501
dataset_id (str): [optional] # noqa: E501
dag_run_id (str): [optional] # noqa: E501
dag_run_id (str, none_type): [optional] # noqa: E501
data_interval_start (datetime, none_type): [optional] # noqa: E501
data_interval_end (datetime, none_type): [optional] # noqa: E501
snapshot_date (datetime, none_type): [optional] # noqa: E501
Expand Down
1 change: 1 addition & 0 deletions observatory-api/observatory/api/server/openapi.yaml.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ definitions:
dag_run_id:
type: string
example: "YYYY-MM-DDTHH:mm:ss.ssssss"
x-nullable: true
data_interval_start:
type: string
format: date-time
Expand Down

0 comments on commit 65b48c9

Please sign in to comment.