Skip to content

Commit

Permalink
doc: use AWS vocabulary in AWS example (#554)
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
pvbouwel and Peter Van Bouwel authored Dec 18, 2024
1 parent 0f81fd8 commit d5ba280
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions extensions/workspaces/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -114,15 +114,19 @@ paths:
title: Amazon S3
description: >-
Amazon S3 is a cloud storage service provided by Amazon Web Services.
It provides storage containers which are called buckets.
intents:
- create
- register
parameters:
username:
title: Username
aws_access_key_id:
title: AWS access key
type: string
password:
title: Password
aws_secret_access_key:
title: AWS secret key associated with the access key.
type: string
bucket_name:
title: Bucket name
type: string
links: []
/workspaces:
Expand Down Expand Up @@ -374,13 +378,14 @@ components:
workspace_parameters:
type: object
description: >-
Additional parameters to register the workspace as defined in `GET /workspace_types`.
Additional parameters to register the workspace as defined in `GET /workspace_providers`.
The structure is not specified by the API.
additionalProperties:
description: Any type
example:
username: john_doe
password: secret123
aws_access_key_id: AKIAI0A0FAKE0EXAMPLE
aws_secret_access_key: TheKey1CorrespondingtoAccessKey.
bucket_name: my-bucket123
workspace_properties:
type: object
description: >-
Expand Down

0 comments on commit d5ba280

Please sign in to comment.