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

docs: fix documentation #127

Merged
merged 4 commits into from
Sep 6, 2021
Merged

docs: fix documentation #127

merged 4 commits into from
Sep 6, 2021

Conversation

Andras-Csanyi
Copy link
Contributor

@Andras-Csanyi Andras-Csanyi commented Sep 3, 2021

PR summary

PR Checklist

Please make sure that your PR fulfills the following requirements:

  • The commit message follows the Angular Commit Message Guidelines.
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Current vs new behavior

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@Andras-Csanyi
Copy link
Contributor Author

Missing examples:

    "/v1/profiles": {},
    "/v1/profiles/{profile-id}": {},
    "/v1/profiles/{profile-id}/rules": {},
    "/v1/profiles/{profile-id}/rules/{rule-id}": {},
    "/v1/profiles/{profile-id}/links": {},
    "/v1/profiles/{profile-id}/links/{link-id}": {},

@codecov
Copy link

codecov bot commented Sep 3, 2021

Codecov Report

Merging #127 (767c08e) into main (40b8c30) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##              main      #127    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           21        21            
  Lines         3302      3464   +162     
  Branches       402       418    +16     
==========================================
+ Hits          3302      3464   +162     
Impacted Files Coverage Δ
iam-identity/v1.ts 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 0463aea...767c08e. Read the comment docs.

@Andras-Csanyi
Copy link
Contributor Author

@pooraniss-ibm The modified documentation tags were the problem. The generated example files on my machine look good. Once these PRs are merged in you can re-gen the example files. The reason I skip it now that the node sdk missing a few examples (see previous comment on this PR) and I don't know whether it is by mistaken or not.

@pooraniss-ibm
Copy link
Member

pooraniss-ibm commented Sep 6, 2021

@Andras-Csanyi
"node sdk missing a few examples"
sorry I double checked it, I don't think any examples are missing from the examples file (they begin from line no.519), they do include all of them related to trusted profiles.
cc: @padamstx

Copy link
Member

@padamstx padamstx left a comment

Choose a reason for hiding this comment

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

LGTM

@padamstx padamstx merged commit 7f051f0 into main Sep 6, 2021
@padamstx padamstx deleted the fix_documentation branch September 6, 2021 15:03
@ibm-devx-sdk
Copy link

🎉 This PR is included in version 0.20.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

4 participants