Apply suggestions from code review

Co-authored-by: Dan Brian <[email protected]>
digitalocean · Feb 20, 2025 · 9828951 · 9828951
1 parent 9c7c1fb
commit 9828951
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 12 deletions.
diff --git a/specification/DigitalOcean-public.v2.yaml b/specification/DigitalOcean-public.v2.yaml
@@ -467,9 +467,9 @@ tags:
 
   - name: Spaces Keys
     description: |-
-      Spaces keys are used to authenticate requests to DigitalOcean Spaces Buckets. By
-      sending requests to the `/v2/spaces/keys` endpoint, you can list, create, or
-      update, delete Spaces keys.
+      Spaces keys authenticate requests to DigitalOcean Spaces Buckets.
+      You can create, list, update, or delete Spaces keys by sending requests to
+      to the `/v2/spaces/keys` endpoint.
 
   - name: SSH Keys
     description: Manage SSH keys available on your account.

diff --git a/specification/resources/spaces/models/key.yml b/specification/resources/spaces/models/key.yml
@@ -3,19 +3,19 @@ type: object
 properties:
   name:
     type: string
-    description: The name of your access key.
+    description: The access key's name.
     example: "my-access-key"
 
   grants:
     type: array
-    description: The grants set to this access key.
+    description: The list of permissions for the access key.
     items:
       $ref: 'grant.yml'
     default: []
 
   access_key:
     type: string
-    description: The access key.
+    description: An encrypted string used to access a bucket. 
     example: DOACCESSKEYEXAMPLE
     readOnly: true
 

diff --git a/specification/resources/spaces/models/key_create_response.yml b/specification/resources/spaces/models/key_create_response.yml
@@ -3,7 +3,7 @@ allOf:
     properties:
       secret_key:
         type: string
-        description: The secret key. This is the only time the secret key will be returned.
+        description: The secret key used to access the bucket. We return secret keys only once upon creation. Make sure to copy the key and securely store it.
         example: DOSECRETKEYEXAMPLE
         readOnly: true
 

diff --git a/specification/resources/spaces/parameters.yml b/specification/resources/spaces/parameters.yml
@@ -1,7 +1,7 @@
 access_key_name:
   in: path
   name: access_key
-  description: The name of your access key.
+  description: The access key's name.
   required: true
   schema:
     type: string
@@ -31,7 +31,7 @@ name:
   in: query
   name: name
   required: false
-  description: The name of the access key.
+  description: The access key's name.
   schema:
     type: string
   example: my-access-key
@@ -40,7 +40,7 @@ bucket:
   in: query
   name: bucket
   required: false
-  description: The name of the bucket.
+  description: The bucket's name.
   schema:
     type: string
   example: my-bucket

diff --git a/specification/resources/spaces/responses/key_create.yml b/specification/resources/spaces/responses/key_create.yml
@@ -1,5 +1,5 @@
 description: >-
-  The response will be a JSON object
+  A JSON response containing details about the new key.
 
 headers:
   ratelimit-limit:

diff --git a/specification/resources/spaces/responses/key_list.yml b/specification/resources/spaces/responses/key_list.yml
@@ -1,5 +1,5 @@
 description: >-
-  The result will be a JSON object with a `keys` key.
+  A JSON response containing a list of keys.
 
 headers:
   ratelimit-limit: