Skip to content

Commit d5ba280

Browse files
pvbouwelPeter Van Bouwel
and
Peter Van Bouwel
authored
doc: use AWS vocabulary in AWS example (Open-EO#554)
When using AWS S3 buckets (provided by AWS or by another S3-compliant provider) in most cases access is not controlled using username & password combination but instead an aws_access_key_id & aws_secret_access_key (optionally an aws_session_token). Co-authored-by: Peter Van Bouwel <peter.vanbouwel@vito.be>
1 parent 0f81fd8 commit d5ba280

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

extensions/workspaces/openapi.yaml

+12-7
Original file line numberDiff line numberDiff line change
@@ -114,15 +114,19 @@ paths:
114114
title: Amazon S3
115115
description: >-
116116
Amazon S3 is a cloud storage service provided by Amazon Web Services.
117+
It provides storage containers which are called buckets.
117118
intents:
118119
- create
119120
- register
120121
parameters:
121-
username:
122-
title: Username
122+
aws_access_key_id:
123+
title: AWS access key
123124
type: string
124-
password:
125-
title: Password
125+
aws_secret_access_key:
126+
title: AWS secret key associated with the access key.
127+
type: string
128+
bucket_name:
129+
title: Bucket name
126130
type: string
127131
links: []
128132
/workspaces:
@@ -374,13 +378,14 @@ components:
374378
workspace_parameters:
375379
type: object
376380
description: >-
377-
Additional parameters to register the workspace as defined in `GET /workspace_types`.
381+
Additional parameters to register the workspace as defined in `GET /workspace_providers`.
378382
The structure is not specified by the API.
379383
additionalProperties:
380384
description: Any type
381385
example:
382-
username: john_doe
383-
password: secret123
386+
aws_access_key_id: AKIAI0A0FAKE0EXAMPLE
387+
aws_secret_access_key: TheKey1CorrespondingtoAccessKey.
388+
bucket_name: my-bucket123
384389
workspace_properties:
385390
type: object
386391
description: >-

0 commit comments

Comments
 (0)