Skip to content

Commit

Permalink
Update spec
Browse files Browse the repository at this point in the history
  • Loading branch information
Cito committed Mar 20, 2024
1 parent 51b85c0 commit ba8a3f1
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ The service requires the following configuration parameters:

- **Items** *(string)*

- **`auth_check_claims`** *(object)*: A dict of all GHGA internal claims that shall be verified. Default: `{"name": null, "email": null, "iat": null, "exp": null}`.
- **`auth_check_claims`** *(object)*: A dict of all GHGA internal claims that shall be verified. Default: `{"id": null, "name": null, "email": null, "iat": null, "exp": null}`.

- **`auth_map_claims`** *(object)*: A mapping of claims to attributes in the GHGA auth context. Can contain additional properties. Default: `{}`.

Expand Down
1 change: 1 addition & 0 deletions config_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@
},
"auth_check_claims": {
"default": {
"id": null,
"name": null,
"email": null,
"iat": null,
Expand Down
1 change: 1 addition & 0 deletions example_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ auth_check_claims:
email: null
exp: null
iat: null
id: null
name: null
auth_key: '{}'
auth_map_claims: {}
Expand Down
24 changes: 24 additions & 0 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ components:
description: The ID of the data steward who made the status change
title: Changed By
dataset_id:
description: ID of the dataset for which access is requested
title: Dataset Id
type: string
email:
Expand All @@ -35,6 +36,13 @@ components:
description: ID of the access request
title: Id
type: string
iva_id:
anyOf:
- type: string
- type: 'null'
description: ID of the IVA to be used for this request, but this can also
be specified later
title: Iva Id
request_created:
description: Creation date of the access request
format: date-time
Expand All @@ -57,6 +65,7 @@ components:
description: Last change date of the status of this request
title: Status Changed
user_id:
description: ID of the user who requests access
title: User Id
type: string
required:
Expand Down Expand Up @@ -86,17 +95,26 @@ components:
title: Access Starts
type: string
dataset_id:
description: ID of the dataset for which access is requested
title: Dataset Id
type: string
email:
description: Contact e-mail address of the requester
title: Email
type: string
iva_id:
anyOf:
- type: string
- type: 'null'
description: ID of the IVA to be used for this request, but this can also
be specified later
title: Iva Id
request_text:
description: Text note submitted with the request
title: Request Text
type: string
user_id:
description: ID of the user who requests access
title: User Id
type: string
required:
Expand All @@ -112,6 +130,12 @@ components:
additionalProperties: false
description: All data that describes an access request patch.
properties:
iva_id:
anyOf:
- type: string
- type: 'null'
description: ID of the IVA to be used for this request
title: Iva Id
status:
allOf:
- $ref: '#/components/schemas/AccessRequestStatus'
Expand Down
2 changes: 1 addition & 1 deletion tests/test_repository.py
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ async def grant_download_access(
)


dao = AccessRequestDaoDummy() # type: ignore
dao = AccessRequestDaoDummy() # pyright: ignore
event_publisher = EventPublisherDummy()
access_grants = AccessGrantsDummy()

Expand Down

0 comments on commit ba8a3f1

Please sign in to comment.