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

Update README based on regenerated code #164

Merged
merged 1 commit into from
Oct 23, 2024

Conversation

rohanshah18
Copy link
Contributor

Problem

Regenerating the code based on new OAS caused changes in imports, so the examples in the README needs to be updated accordingly.

Solution

Changes include:

  1. Updating import statements since inference is now broken out of control, so the paths for the openAPI generated model classes like ApiException, IndexModel, etc. were updated.
  2. Import statement was missing for an example or two

Type of Change

  • 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 not work as expected)
  • This change requires a documentation update
  • Infrastructure change (CI configs, etc)
  • Non-code change (docs, etc)
  • None of the above: (explain here)

Test Plan

No code changes so integration tests should run successfully.

README.md Show resolved Hide resolved
@rohanshah18 rohanshah18 marked this pull request as ready for review October 23, 2024 23:30
README.md Show resolved Hide resolved
@rohanshah18 rohanshah18 merged commit 717a068 into rshah/release-candidate/2024-10 Oct 23, 2024
7 checks passed
@rohanshah18 rohanshah18 deleted the rshah/updateReadme branch October 23, 2024 23:53
rohanshah18 added a commit that referenced this pull request Oct 24, 2024
## Problem

Regenerating the code based on new OAS caused changes in imports, so the
examples in the README needs to be updated accordingly.

## Solution

Changes include: 
1. Updating import statements since inference is now broken out of
control, so the paths for the openAPI generated model classes like
`ApiException`, `IndexModel`, etc. were updated.
2. Import statement was missing for an example or two

## Type of Change

- [ ] 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 not work as expected)
- [ ] This change requires a documentation update
- [ ] Infrastructure change (CI configs, etc)
- [X] Non-code change (docs, etc)
- [ ] None of the above: (explain here)

## Test Plan

No code changes so integration tests should run successfully.
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.

2 participants