Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge result summary deprecation #5119

Merged
merged 2 commits into from
Jan 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 24 additions & 17 deletions api/swagger.yml
Original file line number Diff line number Diff line change
Expand Up @@ -176,28 +176,33 @@ components:
items:
$ref: "#/components/schemas/Repository"

MergeResultSummary:
type: object
properties:
added:
type: integer
Comment on lines +182 to +183
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
added:
type: integer
added:
type: integer
deprecated: true
description: Deprecated; inaccurate and will be removed.

(Also on all other properties, of course.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@arielshaqed updated the PR with field level deprecation - note that I kept the summary as optional as I don't think we will set an empty structure if we keep it as required.

deprecated: true
description: "Deprecated: inaccurate and will be removed."
removed:
type: integer
deprecated: true
description: "Deprecated: inaccurate and will be removed."
changed:
type: integer
deprecated: true
description: "Deprecated: inaccurate and will be removed."
conflict:
type: integer
deprecated: true
description: "Deprecated: inaccurate and will be removed."

MergeResult:
type: object
required:
- summary
- reference
properties:
summary:
type: object
required:
- added
- removed
- changed
- conflict
properties:
added:
type: integer
removed:
type: integer
changed:
type: integer
conflict:
type: integer
$ref: "#/components/schemas/MergeResultSummary"
reference:
type: string

Expand Down Expand Up @@ -2635,7 +2640,9 @@ paths:
404:
$ref: "#/components/responses/NotFound"
409:
description: conflict
description: |
Conflict
Deprecated: content schema will return Error format and not an empty MergeResult
content:
application/json:
schema:
Expand Down
52 changes: 28 additions & 24 deletions clients/java/api/openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion clients/java/docs/MergeResult.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions clients/java/docs/MergeResultSummary.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion clients/java/docs/RefsApi.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions clients/java/src/main/java/io/lakefs/clients/api/RefsApi.java

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion clients/python/docs/MergeResult.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions clients/python/docs/MergeResultSummary.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion clients/python/docs/RefsApi.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading