8000 Add XR apis to sdk by sandeep-paliwal · Pull Request #20 · adobe/aio-lib-console · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add XR apis to sdk #20

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

Closed
wants to merge 13 commits into from
Closed

Conversation

sandeep-paliwal
Copy link
Contributor
@sandeep-paliwal sandeep-paliwal commented Apr 14, 2021

XR APIs for console sdk
TODO add e2e tests once APIs are live

Before merge, revert these changes

  • re-add npm test (git revert 274dd69)

Description

Related Issue

Motivation and Context

How Has This Been Tested?

TODO

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Added unit tests
Updated api.json
TODO - update param JSdoc definitions
@codecov
Copy link
codecov bot commented Apr 14, 2021

Codecov Report

Merging #20 (f8b427d) into master (2d1f258) will not change coverage.
The diff coverage is 100.00%.

❗ Current head f8b427d differs from pull request most recent head 274dd69. Consider uploading reports for the commit 274dd69 to get more accurate results
Impacted file tree graph

@@            Coverage Diff            @@
##            master       #20   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines          487       458   -29     
  Branches        15        16    +1     
=========================================
- Hits           487       458   -29     
Impacted Files Coverage Δ
src/SDKErrors.js 100.00% <100.00%> (ø)
src/index.js 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2d1f258...274dd69. Read the comment docs.

Copy link
Member
@moritzraho moritzraho left a comment

Choose a reason for hiding this comment

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

Looking good so far, quite a big change 🙂

We need two more things to make this complete:

  • e2e tests for the new endpoints, you can prepare them now but not run until ext reg is up
  • remove old app registry apis + also remove atlaspolicy apis

@sandeep-paliwal
Copy link
Contributor Author

Thanks @moritzraho for the comments.
I will add the e2e tests.
I guess old registry APIs we should deprecate, and once they are decommissioned, then we should remove them from SDK.
WDYT?

@moritzraho
Copy link
Member
moritzraho commented Apr 15, 2021

@sandeep-paliwal good thoughts but no one is using this api in the sdk. We discussed this with @meryllblanchet and @fmeschbe I think it is safe to delete those apis.
Also app registry api will not be kept once moving to ext reg (I think)

@meryllblanchet
Copy link

@sandeep-paliwal @moritzraho these APIs should not be exposed within the library and do not serve any 3rd party extensibility purpose. No deprecation needed IMO.

cc @fmeschbe

Removed old app registry APIs and related tests.
src/index.js Outdated
* @param {number} [options.pageSize] page size
* @returns {Promise<Response>} the response
*/
async getAllExtensionPoints (organizationId, xpId, options = {}) {
Copy link
Contributor

Choose a reason for hiding this comment

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

It's probably early without the API working but we will need to make xpId optional and set the default as per https://adobeio.slack.com/archives/CSCQ8CQQJ/p1617827196029200?thread_ts=1617781290.014700&cid=CSCQ8CQQJ

Copy link
Contributor Author

Choose a reason for hiding this comment

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

xpId was a required param as per the shared swagger spec. Anyway there is new spec available and we will need to make changes to SDK as per that.

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like there is no change to the param in this API. We should still make this change IMO.

sandeep-paliwal and others added 6 commits April 22, 2021 19:45
Updated tests.
Updated docs.
Updated unit tests
Added e2e tests
removed previously added apis from spec and they are not part of transporter API now.
Updated docs.
@shazron
Copy link
Member
shazron commented Jun 29, 2021

@sandeep-paliwal can you get this change into your PR branch: https://github.com/adobe/aio-lib-console/pull/21/files Jesse put it against master so it can't be merged via Github into this PR

shazron added 2 commits June 29, 2021 23:56
to run tests manually, use `npm run unit-tests` instead.
@shazron
Copy link
Member
shazron commented Jun 29, 2021

Moved to #22. Please review any pending changes due to review in this PR that needs to be migrated to the new PR.
The new PR now exists in the main repo, for publishing permission issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants
0