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

[DON'T MERGE - TESTING] Add Artifacts Section to Swagger Documentation - #2

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

[DON'T MERGE - TESTING] Add Artifacts Section to Swagger Documentation#2
epamLDadayan wants to merge 1 commit into
releasefrom
update-artifacts-swagger_v1

Conversation

@epamLDadayan

Copy link
Copy Markdown

Summary

This pull request adds the "Artifacts" section to the Swagger documentation. The following endpoints have been documented:

  • List Artifacts
  • Get Artifact
  • Create Artifact
  • Create Bucket
  • List Buckets
  • Delete Artifacts
  • Delete Artifact

Changes

  • Replaced integration_id and is_local with configuration_title where applicable.
  • Added detailed request and response schemas for each endpoint.

Notes

  • This PR is based on the release branch and should be merged back into it.

Breaking Changes

  • The parameters integration_id and is_local have been removed and replaced with configuration_title.

Copilot AI review requested due to automatic review settings August 3, 2025 13:35

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 adds comprehensive Swagger documentation for the Artifacts API, documenting seven key endpoints for managing artifacts and buckets. The documentation introduces a new parameter configuration_title to replace the deprecated integration_id and is_local parameters.

  • Adds OpenAPI 3.0 specification for Artifacts API endpoints
  • Documents CRUD operations for both artifacts and buckets
  • Replaces deprecated parameters with configuration_title query parameter
Comments suppressed due to low confidence (1)

swagger.yaml:157

  • Parameter name 'filename' is inconsistent with 'file_name' used in the GET artifact endpoint (line 68). Use consistent naming convention throughout the API.
        - name: filename

Comment thread swagger.yaml
Comment on lines +116 to +137
/artifacts/artifacts/default/{project_id}/{bucket_name}:
delete:
summary: Delete Artifacts
parameters:
- name: project_id
in: path
required: true
schema:
type: string
- name: bucket_name
in: path
required: true
schema:
type: string
- name: configuration_title
in: query
required: false
schema:
type: string
responses:
'204':
description: Artifacts deleted successfully

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.

This path is identical to line 7, creating a duplicate endpoint definition. The DELETE operation should be merged with the existing GET and POST operations under the same path.

Suggested change
/artifacts/artifacts/default/{project_id}/{bucket_name}:
delete:
summary: Delete Artifacts
parameters:
- name: project_id
in: path
required: true
schema:
type: string
- name: bucket_name
in: path
required: true
schema:
type: string
- name: configuration_title
in: query
required: false
schema:
type: string
responses:
'204':
description: Artifacts deleted successfully
# (Remove lines 116–137 entirely)

Copilot uses AI. Check for mistakes.
Comment thread swagger.yaml
responses:
'204':
description: Artifacts deleted successfully
/artifacts/artifact/default/{project_id}/{bucket_name}:

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 DELETE artifact endpoint path is missing the {file_name} path parameter that exists in the GET artifact endpoint (line 54). This creates an inconsistent API design where deletion requires filename as a query parameter instead of a path parameter.

Suggested change
/artifacts/artifact/default/{project_id}/{bucket_name}:
/artifacts/artifact/default/{project_id}/{bucket_name}/{file_name}:

Copilot uses AI. Check for mistakes.
@epamLDadayan epamLDadayan changed the title Add Artifacts Section to Swagger Documentation [DON'T MERGE - TESTING] Add Artifacts Section to Swagger Documentation 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