Skip to content
This repository was archived by the owner on Apr 15, 2026. It is now read-only.

[DON'T MERGE - FOR TESTING] Update API Documentation for Artifacts - #4

Open
epamLDadayan wants to merge 1 commit into
releasefrom
update-artifacts-api-docs
Open

[DON'T MERGE - FOR TESTING] Update API Documentation for Artifacts#4
epamLDadayan wants to merge 1 commit into
releasefrom
update-artifacts-api-docs

Conversation

@epamLDadayan

Copy link
Copy Markdown

Changes Made:

  1. Removed references to integration_id and is_local parameters.
  2. Introduced configuration_title parameter in relevant endpoints.
  3. Removed all references to AdminAPI mode handlers.
  4. Deleted documentation related to the api/v1/storage.py file.

Summary:

This update aligns the API documentation with the latest backend changes, ensuring consistency and clarity for developers.

Copilot AI review requested due to automatic review settings August 3, 2025 14:36

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request updates the API documentation by adding comprehensive Artifacts endpoints documentation and aligning with recent backend changes. The update removes outdated parameters and references while introducing new API endpoints for bucket and file management.

  • Added complete API documentation for Artifacts endpoints including bucket listing, bucket details, and file upload operations
  • Removed references to deprecated integration_id, is_local parameters and AdminAPI mode handlers
  • Introduced configuration_title parameter support in relevant endpoints

Comment thread apis/swagger.yaml
Comment on lines +13 to +28
responses:
'200':
description: A list of buckets.
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
description: The unique identifier for the bucket.
name:
type: string
description: The name of the bucket.

Copilot AI Aug 3, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content type should be specified in the responses section. For OpenAPI 3.0, use 'content' under responses, but this appears to be using OpenAPI 2.0 format based on the basePath. Consider using 'produces' at the operation level or switching to OpenAPI 3.0 format consistently.

Suggested change
responses:
'200':
description: A list of buckets.
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
description: The unique identifier for the bucket.
name:
type: string
description: The name of the bucket.
produces:
- application/json
responses:
'200':
description: A list of buckets.
schema:
type: array
items:
type: object
properties:
id:
type: string
description: The unique identifier for the bucket.
name:
type: string
description: The name of the bucket.

Copilot uses AI. Check for mistakes.
Comment thread apis/swagger.yaml
Comment on lines +43 to +89
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The unique identifier for the bucket.
name:
type: string
description: The name of the bucket.
created_at:
type: string
format: date-time
description: The creation timestamp of the bucket.
/artifacts/files:
post:
summary: Upload a file
description: Upload a new file to a bucket.
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
bucket_id:
type: string
description: The ID of the bucket to upload the file to.
file:
type: string
format: binary
description: The file to upload.
responses:
'201':
description: File uploaded successfully.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The unique identifier for the uploaded file.
name:
type: string
description: The name of the uploaded file.

Copilot AI Aug 3, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same issue as above - mixing OpenAPI 2.0 and 3.0 syntax. The 'content' keyword is from OpenAPI 3.0 but the document uses 'basePath' which is OpenAPI 2.0.

Suggested change
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The unique identifier for the bucket.
name:
type: string
description: The name of the bucket.
created_at:
type: string
format: date-time
description: The creation timestamp of the bucket.
/artifacts/files:
post:
summary: Upload a file
description: Upload a new file to a bucket.
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
bucket_id:
type: string
description: The ID of the bucket to upload the file to.
file:
type: string
format: binary
description: The file to upload.
responses:
'201':
description: File uploaded successfully.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The unique identifier for the uploaded file.
name:
type: string
description: The name of the uploaded file.
schema:
type: object
properties:
id:
type: string
description: The unique identifier for the bucket.
name:
type: string
description: The name of the bucket.
created_at:
type: string
format: date-time
description: The creation timestamp of the bucket.
/artifacts/files:
post:
summary: Upload a file
description: Upload a new file to a bucket.
consumes:
- multipart/form-data
parameters:
- name: bucket_id
in: formData
required: true
type: string
description: The ID of the bucket to upload the file to.
- name: file
in: formData
required: true
type: file
description: The file to upload.
responses:
'201':
description: File uploaded successfully.
schema:
type: object
properties:
id:
type: string
description: The unique identifier for the uploaded file.
name:
type: string
description: The name of the uploaded file.

Copilot uses AI. Check for mistakes.
Comment thread apis/swagger.yaml
Comment on lines +43 to +89
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The unique identifier for the bucket.
name:
type: string
description: The name of the bucket.
created_at:
type: string
format: date-time
description: The creation timestamp of the bucket.
/artifacts/files:
post:
summary: Upload a file
description: Upload a new file to a bucket.
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
bucket_id:
type: string
description: The ID of the bucket to upload the file to.
file:
type: string
format: binary
description: The file to upload.
responses:
'201':
description: File uploaded successfully.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The unique identifier for the uploaded file.
name:
type: string
description: The name of the uploaded file.

Copilot AI Aug 3, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent OpenAPI version usage - 'content' is OpenAPI 3.0 syntax while the document appears to follow OpenAPI 2.0 format based on 'basePath' usage.

Suggested change
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The unique identifier for the bucket.
name:
type: string
description: The name of the bucket.
created_at:
type: string
format: date-time
description: The creation timestamp of the bucket.
/artifacts/files:
post:
summary: Upload a file
description: Upload a new file to a bucket.
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
bucket_id:
type: string
description: The ID of the bucket to upload the file to.
file:
type: string
format: binary
description: The file to upload.
responses:
'201':
description: File uploaded successfully.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The unique identifier for the uploaded file.
name:
type: string
description: The name of the uploaded file.
schema:
type: object
properties:
id:
type: string
description: The unique identifier for the bucket.
name:
type: string
description: The name of the bucket.
created_at:
type: string
format: date-time
description: The creation timestamp of the bucket.
/artifacts/files:
post:
summary: Upload a file
description: Upload a new file to a bucket.
parameters:
- name: body
in: body
required: true
schema:
type: object
properties:
bucket_id:
type: string
description: The ID of the bucket to upload the file to.
file:
type: string
format: binary
description: The file to upload.
responses:
'201':
description: File uploaded successfully.
schema:
type: object
properties:
id:
type: string
description: The unique identifier for the uploaded file.
name:
type: string
description: The name of the uploaded file.

Copilot uses AI. Check for mistakes.
Comment thread apis/swagger.yaml
format: binary
description: The file to upload.
responses:
'201':

Copilot AI Aug 3, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing error response documentation. File upload operations should include error responses for common scenarios like invalid bucket_id (404), file too large (413), or server errors (500).

Copilot uses AI. Check for mistakes.
Comment thread apis/swagger.yaml
content:
multipart/form-data:
schema:
type: object

Copilot AI Aug 3, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing required fields specification. The schema should indicate which properties are required, particularly 'bucket_id' and 'file' for the upload operation.

Suggested change
type: object
type: object
required:
- bucket_id
- file

Copilot uses AI. Check for mistakes.
@epamLDadayan epamLDadayan changed the title Update API Documentation for Artifacts [DON'T MERGE - FOR TESTING] Update API Documentation for Artifacts Aug 3, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants