Skip to content

fix(IAM Policy Management): update examples format for doc generation #238

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jan 30, 2024
Merged

fix(IAM Policy Management): update examples format for doc generation #238

merged 2 commits into from
Jan 30, 2024

Conversation

swcolley
Copy link
Contributor

PR summary

Issue: https://github.ibm.com/IAM/AM-issues/issues/2001

Updating examples so that the API doc generation includes the etag response header.

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

No behavior change.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Ran examples to verify changes:

pytest examples/test_iam_policy_management_v1_examples.py 
==================================================================== test session starts ====================================================================
platform darwin -- Python 3.10.12, pytest-7.2.0, pluggy-1.0.0
rootdir: /Users/shaunsmacibm/Desktop/cloud-platform/iam/sdk/platform-services-python-sdk
plugins: cov-2.12.1
collected 28 items                                                         

examples/test_iam_policy_management_v1_examples.py ............................                                                                       [100%]

==================================================================== 28 passed in 16.19s ====================================================================
```

@swcolley
Copy link
Contributor Author

I'm not sure why the lint check is failing, it is passing locally:

Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)

black --check ibm_platform_services test/unit test/integration examples
All done! ✨ 🍰 ✨
84 files would be left unchanged.

@padamstx padamstx self-requested a review January 30, 2024 21:25
@padamstx padamstx self-assigned this Jan 30, 2024
padamstx
padamstx approved these changes Jan 30, 2024
View reviewed changes
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 d4903ce into main Jan 30, 2024
@padamstx padamstx deleted the etagExampleFix branch January 30, 2024 22:21
ibm-devx-sdk pushed a commit that referenced this pull request Jan 30, 2024
@semantic-release-bot
chore(release): 0.49.2 release notes
92e9841 
## [0.49.2](v0.49.1...v0.49.2) (2024-01-30)

### Bug Fixes

* **IAM Policy Management:** update examples format for doc generation ([#238](#238)) ([d4903ce](d4903ce))
@ibm-devx-sdk
Copy link

🎉 This PR is included in version 0.49.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@padamstx padamstx padamstx approved these changes

Assignees

@padamstx padamstx

Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@swcolley @ibm-devx-sdk @padamstx