Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Added deprecated API indication in the API doc#6545

Merged
yadvr merged 2 commits intoapache:mainapache/cloudstack:mainfrom
shapeblue:AddedDeprecatedAPIindicationInAPIdocshapeblue/cloudstack:AddedDeprecatedAPIindicationInAPIdocCopy head branch name to clipboard
Jul 13, 2022
Merged

Added deprecated API indication in the API doc#6545
yadvr merged 2 commits intoapache:mainapache/cloudstack:mainfrom
shapeblue:AddedDeprecatedAPIindicationInAPIdocshapeblue/cloudstack:AddedDeprecatedAPIindicationInAPIdocCopy head branch name to clipboard

Conversation

@harikrishna-patnala
Copy link
Contributor

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

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-patnala harikrishna-patnala added this to the 4.18.0.0 milestone Jul 12, 2022
@boring-cyborg boring-cyborg bot added the Python Warning... Python code Ahead! label Jul 12, 2022
@harikrishna-patnala harikrishna-patnala changed the title Added deprecated ap iindication in ap idoc Added deprecated API indication in the API doc Jul 12, 2022
@acs-robot
Copy link

acs-robot commented Jul 12, 2022

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

yadvr
yadvr reviewed Jul 12, 2022
View reviewed changes
.github/workflows/codecov.yml Outdated Show resolved Hide resolved
yadvr
yadvr reviewed Jul 12, 2022
View reviewed changes
tools/apidoc/generatetoc_header.xsl Outdated Show resolved Hide resolved
@yadvr
Copy link
Member

yadvr commented Jul 12, 2022

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-patnala force-pushed the AddedDeprecatedAPIindicationInAPIdoc branch from 4303c68 to c2b20c1 Compare July 12, 2022 04:02
@harikrishna-patnala
Copy link
Contributor Author

harikrishna-patnala commented Jul 12, 2022

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
Copy link
Member

yadvr commented Jul 12, 2022

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-patnala force-pushed the AddedDeprecatedAPIindicationInAPIdoc branch from c2b20c1 to 3bd8568 Compare July 12, 2022 04:08
@harikrishna-patnala harikrishna-patnala force-pushed the AddedDeprecatedAPIindicationInAPIdoc branch from 3bd8568 to 8786243 Compare July 12, 2022 04:09
@harikrishna-patnala
Copy link
Contributor Author

harikrishna-patnala commented Jul 12, 2022

@blueorangutan package

@blueorangutan
Copy link

blueorangutan commented Jul 12, 2022

@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
Copy link

sonarqubecloud bot commented Jul 12, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

0.0% 0.0% Coverage
0.0% 0.0% Duplication

@blueorangutan
Copy link

blueorangutan commented Jul 12, 2022

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

sureshanaparti
sureshanaparti approved these changes Jul 12, 2022
View reviewed changes
Copy link
Contributor

@sureshanaparti sureshanaparti left a comment

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:main Jul 13, 2022
@yadvr yadvr deleted the AddedDeprecatedAPIindicationInAPIdoc branch July 13, 2022 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yadvr yadvr yadvr approved these changes

@sureshanaparti sureshanaparti sureshanaparti approved these changes

Assignees

No one assigned

Labels

Python Warning... 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
Morty Proxy This is a proxified and sanitized view of the page, visit original site.