Skip to content

Added deprecated API indication in the API doc - #6545

Merged
yadvr merged 2 commits into
apache:mainfrom
shapeblue:AddedDeprecatedAPIindicationInAPIdoc
Jul 13, 2022
Merged

Added deprecated API indication in the API doc#6545
yadvr merged 2 commits into
apache:mainfrom
shapeblue:AddedDeprecatedAPIindicationInAPIdoc

Conversation

@harikrishna-patnala

@harikrishna-patnalaharikrishna-patnala commented Jul 12, 2022•
edited
Loading

Copy link
Copy Markdown
Member

Description

There are a few deprecated APIs and API documentation is missing that information. We have now added an indication to the deprecated APIs with (D) in the API documentation as below

image

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

  • Major
  • Minor

Bug Severity

  • BLOCKER
  • Critical
  • Major
  • Minor
  • Trivial

Screenshots (if appropriate):

How Has This Been Tested?

@harikrishna-patnalaharikrishna-patnala added this to the 4.18.0.0 milestone Jul 12, 2022
@boring-cyborgboring-cyborgBot added the Python Warning... Python code Ahead! label Jul 12, 2022
@harikrishna-patnalaharikrishna-patnala changed the title Added deprecated ap iindication in ap idocAdded deprecated API indication in the API docJul 12, 2022
@acs-robot

acs-robot commented Jul 12, 2022

Copy link
Copy Markdown

Found UI changes, kicking a new UI QA build
@blueorangutan ui

yadvr
yadvr reviewed Jul 12, 2022
View reviewed changes
Comment thread.github/workflows/codecov.yml Outdated
yadvr
yadvr reviewed Jul 12, 2022
View reviewed changes
Comment threadtools/apidoc/generatetoc_header.xsl Outdated
@yadvr

yadvr commented Jul 12, 2022

Copy link
Copy Markdown
Member

LGTM didn't test it, worth checking why some APIs are marked deprecated such as listVirtualMachinesMetrics which is very much used in the metrics view @harikrishna-patnala ?

@harikrishna-patnala
harikrishna-patnalaforce-pushed the AddedDeprecatedAPIindicationInAPIdoc branch from 4303c68 to c2b20c1CompareJuly 12, 2022 04:02
@harikrishna-patnala

harikrishna-patnala commented Jul 12, 2022

Copy link
Copy Markdown
MemberAuthor

LGTM didn't test it, worth checking why some APIs are marked deprecated such as listVirtualMachinesMetrics which is very much used in the metrics view @harikrishna-patnala ?

It was marked as deprecated in this PR #5984. looks like there is a new API ListVMsUsageHistoryCmd.

@yadvr

yadvr commented Jul 12, 2022

Copy link
Copy Markdown
Member

If from PR #5984, the new API returns current metrics with the same response/format that it can be deprecated otherwise probably not.

@harikrishna-patnala
harikrishna-patnalaforce-pushed the AddedDeprecatedAPIindicationInAPIdoc branch from c2b20c1 to 3bd8568CompareJuly 12, 2022 04:08
@harikrishna-patnala
harikrishna-patnalaforce-pushed the AddedDeprecatedAPIindicationInAPIdoc branch from 3bd8568 to 8786243CompareJuly 12, 2022 04:09
@harikrishna-patnala

harikrishna-patnala commented Jul 12, 2022

Copy link
Copy Markdown
MemberAuthor

@blueorangutan package

@blueorangutan

blueorangutan commented Jul 12, 2022

Copy link
Copy Markdown

@harikrishna-patnala a Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

@sonarqubecloud

sonarqubecloudBot commented Jul 12, 2022

Copy link
Copy Markdown

Kudos, SonarCloud Quality Gate passed! Quality Gate passed

BugA0 Bugs
VulnerabilityA0 Vulnerabilities
Security HotspotA0 Security Hotspots
Code SmellA0 Code Smells

0.0%0.0% Coverage
0.0%0.0% Duplication

@blueorangutan

blueorangutan commented Jul 12, 2022

Copy link
Copy Markdown

Packaging result: ✔️ el7 ✔️ el8 ✔️ debian ✔️ suse15. SL-JID 3750

sureshanaparti
sureshanaparti approved these changes Jul 12, 2022
View reviewed changes

@sureshanapartisureshanaparti left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

changes LGTM

@yadvr
yadvr merged commit 12ecfa8 into apache:mainJul 13, 2022
@yadvr
yadvr deleted the AddedDeprecatedAPIindicationInAPIdoc branch July 13, 2022 10:04
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yadvryadvryadvr approved these changes
@sureshanapartisureshanapartisureshanaparti approved these changes

Assignees

No one assigned

Labels

PythonWarning... Python code Ahead!

Projects

None yet

Milestone

4.18.0.0

Development

Successfully merging this pull request may close these issues.

5 participants

@harikrishna-patnala@acs-robot@yadvr@blueorangutan@sureshanaparti