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

Improve documentation of "create tag" API #7112

Merged
merged 4 commits into from
Dec 10, 2023

Conversation

arielshaqed
Copy link
Contributor

Closes #7103.

@arielshaqed arielshaqed requested a review from N-o-Z December 4, 2023 14:18
Copy link

github-actions bot commented Dec 4, 2023

♻️ PR Preview 07e015b has been successfully destroyed since this PR has been closed.

🤖 By surge-preview

api/swagger.yml Outdated
ref:
type: string
description: reference to commit to tag
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
description: reference to commit to tag
description: commit reference the tag will point to

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed to something shorter & I hope better.

Copy link
Member

@N-o-Z N-o-Z left a comment

Choose a reason for hiding this comment

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

The ref description felt a little bit confusing

Copy link
Contributor Author

@arielshaqed arielshaqed left a comment

Choose a reason for hiding this comment

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

Thanks! PTAL...

api/swagger.yml Outdated
ref:
type: string
description: reference to commit to tag
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed to something shorter & I hope better.

@arielshaqed arielshaqed added area/API Improvements or additions to the API docs Improvements or additions to documentation exclude-changelog PR description should not be included in next release changelog minor-change Used for PRs that don't require issue attached labels Dec 10, 2023
@arielshaqed arielshaqed requested a review from N-o-Z December 10, 2023 09:06
@arielshaqed
Copy link
Contributor Author

Thanks!

J. L. Picard: Enable autosquish!

@arielshaqed arielshaqed enabled auto-merge (squash) December 10, 2023 09:09
@arielshaqed arielshaqed merged commit 0787698 into master Dec 10, 2023
43 of 44 checks passed
@arielshaqed arielshaqed deleted the docs/7103-tag-creation-swagger-docs branch December 10, 2023 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/API Improvements or additions to the API docs Improvements or additions to documentation exclude-changelog PR description should not be included in next release changelog minor-change Used for PRs that don't require issue attached
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG]: Python SDK create tag returns conflict error
2 participants