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.

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

[DocumentIntelligence] Missing changes in changelog, samples and release note for GA 1.0.0 #32326

Closed
4 of 5 tasks
vsantele opened this issue Dec 20, 2024 · 3 comments
Closed
4 of 5 tasks

[DocumentIntelligence] Missing changes in changelog, samples and release note for GA 1.0.0 #32326

vsantele opened this issue Dec 20, 2024 · 3 comments
Assignees
@HarshaNalluru
Labels
Client This issue points to a problem in the data-plane of the library. Cognitive - Form Recognizer customer-reported Issues that are reported by GitHub users external to the Azure organization. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that

Comments

@vsantele
Copy link
Contributor

  • Package Name: @azure-rest/ai-document-intelligence-rest
  • Package Version: 1.0.0
  • Operating system: Not relevant
  • Is the bug related to documentation in

Describe the bug
In version 1.0.0, some types are renamed but not all are documented.

They are all from ‎sdk/documentintelligence/ai-document-intelligence-rest/src/outputModels.ts

  • AnalyzeResultOperationOutput -> AnalyzeOperationOuput
    • Old references in samples and readme
    • Not present in changelog and release note

Minor misses:

  • FontWeightOutput -> DocumentFontWeightOutput
    • Not present in changelog and release note
  • FontStyleOutput -> DocumentFontStyleOutput
    • Not present in changelog and release note
  • DocumentOutput -> AnalyzedDocumentOutput
    • Not present in changelog and release note
  • CopyAuthorizationOutput -> ModelCopyAuthorizationOutput
    • Not present in changelog and release note

commit: 7644726#diff-a85ae937dbbcfc0517d2e0a121380f05cc26a22c4892a7c5954168b2f96fd948R291

Additional context

False references:
@github-actions github-actions bot added customer-reported Issues that are reported by GitHub users external to the Azure organization. needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Dec 20, 2024
@vsantele vsantele mentioned this issue Dec 20, 2024
Merged
3 tasks
@xirzec xirzec added Client This issue points to a problem in the data-plane of the library. Cognitive - Form Recognizer labels Dec 20, 2024
@github-actions github-actions bot removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Dec 20, 2024
@totolicious
Copy link

Also, I would like to add that the code samples are not correct. For example, this particular line references AnalyzeResultOperationOutput, but more samples are still referencing this renamed type
https://github.com/Azure/azure-sdk-for-js/blob/78e29303f2b86461c87431b5c506426cbc8dc680/sdk/documentintelligence/ai-document-intelligence-rest/samples/v1/typescript/src/analyzeReceipt.ts#L16C3-L16C31

Nikhilprasad-r added a commit to Nikhilprasad-r/azure-sdk-for-js that referenced this issue Jan 3, 2025
@Nikhilprasad-r
modified readme of [DocumentIntelligence] wrong import of AnalyzeOper…
4a60521 
…ationOutput. changes in changelog, samples and release note for GA 1.0.0 Azure#32326
@Nikhilprasad-r Nikhilprasad-r mentioned this issue Jan 3, 2025
Merged
3 tasks
HarshaNalluru pushed a commit that referenced this issue Jan 3, 2025
@Nikhilprasad-r
modified readme of [DocumentIntelligence] wrong import of AnalyzeOper… (
6030c77 
#32412)

…ationOutput. changes in changelog, samples and release note for GA
1.0.0 #32326


### Packages impacted by this PR
Azure Documentintelligence

### Issues associated with this PR
Fixed wrong import of AnalyzeOperationOutput 

### Describe the problem that is addressed by this PR
Previously in the readme of Azure DocumentIntelligence (formerly
FormRecognizer) REST client library for JavaScript in Continue creating
the poller from initial response section the import of
AnalyzeOperationOutput was wrongly added as AnalyzeResultOperationOutput
in 3 counts that has been modified.

### What are the possible designs available to address the problem? If
there are more than one possible design, why was the one in this PR
chosen?
It was the only simple solution

### Are there test cases added in this PR? _(If not, why?)_
No just modified readme to update documentation of wrong import

### Provide a list of related PRs _(if any)_


### Command used to generate this PR:**_(Applicable only to SDK release
request PRs)_

### Checklists
- [ ] Added impacted package name to the issue description
- [ ] Does this PR needs any fixes in the SDK Generator?** _(If so,
create an Issue in the
[Autorest/typescript](https://github.com/Azure/autorest.typescript)
repository and link it here)_
- [ ] Added a changelog (if necessary)
@vsantele
Copy link
Contributor Author

vsantele commented Jan 5, 2025

#32327 fixes all missing changes I've seen. Is it possible to get any feedback on this?

HarshaNalluru pushed a commit that referenced this issue Jan 6, 2025
@vsantele
update CHANGELOG and samples to reflect additional type renamings in …
afb01e8 
…document intelligence (#32327)

<!-- Give your Pull Request a brief description, and answer the
following questions. This helps us find the best reviewers for the PR.
-->

### Packages impacted by this PR

@azure-rest/ai-document-intelligence-rest

### Issues associated with this PR

#32326 

### Describe the problem that is addressed by this PR

Some types renamed in version 1.0.0 are not reflected everywhere

### What are the possible designs available to address the problem? If
there are more than one possible design, why was the one in this PR
chosen?

 - 

### Are there test cases added in this PR? _(If not, why?)_

This PR only change types, there is no test for that as far as I know.

### Provide a list of related PRs _(if any)_

 -

### Command used to generate this PR: _(Applicable only to SDK release
request PRs)_

- 

### Checklists
- [x] Added impacted package name to the issue description.
- [ ] Does this PR need any fixes in the SDK Generator?** _(If so,
create an Issue in the
[Autorest/typescript](https://github.com/Azure/autorest.typescript)
repository and link it here.)_
- [x] Added a changelog (if necessary).
@HarshaNalluru
Copy link
Member

reviewed and merged, thanks for the comment and your valuable contributions.

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

@HarshaNalluru HarshaNalluru

Labels
Client This issue points to a problem in the data-plane of the library. Cognitive - Form Recognizer customer-reported Issues that are reported by GitHub users external to the Azure organization. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@xirzec @totolicious @HarshaNalluru @vsantele