InitialApiDefinitions: Renames and status code updates after review

Signed-off-by: Gabe Goodhart <[email protected]>
instructlab · Jun 10, 2024 · e9bd599 · e9bd599
1 parent 0507301
commit e9bd599
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 16 deletions.
diff --git a/api-definitions/common/file-pointer.yaml → api-definitions/common/file-path.yaml b/api-definitions/common/file-pointer.yaml → api-definitions/common/file-path.yaml
@@ -11,25 +11,25 @@ schemas:
         type: string
         description: The name of the file on disk
 
-  S3Path:
+  ObjectStoragePath:
     allOf:
-      - $ref: './s3-connection.yaml#/schemas/Bucket'
+      - $ref: './object-storage-connection.yaml#/schemas/Bucket'
       - type: object
-        description: 'Pointer to a path within an s3 bucket'
+        description: 'Path within an object storage bucket'
         required: ['path']
         properties:
           path:
             type: string
             description: The path within the bucket
 
-  FilePointer:
-    description: Pointer to an individual file
+  FilePath:
+    description: Path to an individual file
     oneOf:
       - $ref: '#/schemas/LocalPath'
-      - $ref: '#/schemas/S3Path'
+      - $ref: '#/schemas/ObjectStoragePath'
 
-  DirectoryPointer:
-    description: Pointer to a directory
+  DirectoryPath:
+    description: Path to a directory
     oneOf:
       - $ref: '#/schemas/LocalPath'
-      - $ref: '#/schemas/S3Path'
+      - $ref: '#/schemas/ObjectStoragePath'
diff --git a/api-definitions/common/s3-connection.yaml → ...ons/common/object-storage-connection.yaml b/api-definitions/common/s3-connection.yaml → ...ons/common/object-storage-connection.yaml
@@ -25,12 +25,12 @@ schemas:
 
   Service:
     type: object
-    description: Pointer to an s3 service
+    description: Pointer to an object storage service
     required: ['endpoint', 'credentials']
     properties:
       endpoint:
         type: string
-        description: The qualified endpoint of the s3 service (http://, https://)
+        description: The qualified endpoint of the object storage service (http://, https://)
       credentials:
         oneOf:
           - $ref: '#/schemas/HMACCredentials'
@@ -43,7 +43,7 @@ schemas:
     allOf:
       - $ref: '#/schemas/Service'
       - type: object
-        description: Pointer to an s3 bucket
+        description: Pointer to an object storage bucket
         required: ['bucket']
         properties:
           bucket:

diff --git a/api-definitions/platform/synthetic-data-generations.yaml b/api-definitions/platform/synthetic-data-generations.yaml
@@ -14,7 +14,7 @@ paths:
             schema:
               $ref: '#/components/schemas/SDGJobBody'
       responses:
-        "200":
+        "201":
           description: A successfully submitted job
           content:
             application/json:
@@ -62,7 +62,7 @@ components:
       properties:
         output_directory:
           description: Location to place the output in
-          $ref: '../common/file-pointer.yaml#/schemas/DirectoryPointer'
+          $ref: '../common/file-path.yaml#/schemas/DirectoryPath'
 
         tasks:
           description: Mapping from task name to task config. The config will be validated against the task's config schema.
@@ -74,8 +74,8 @@ components:
         seed_data:
           description: The file or directory containing the seed data
           oneOf:
-            - $ref: '../common/file-pointer.yaml#/schemas/FilePointer'
-            - $ref: '../common/file-pointer.yaml#/schemas/DirectoryPointer'
+            - $ref: '../common/file-path.yaml#/schemas/FilePath'
+            - $ref: '../common/file-path.yaml#/schemas/DirectoryPath'
 
     SDGTaskDefinition:
       type: object