[BUG] Api revision description ignored by publisher
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
Research direction
Start in apiops/src/common/Api.cs at line 299 and WorkspaceApi.cs at line 334, then trace how apiRevisionDescription from apiInformation.json is carried into the revision. Use the provided reproduction steps with publisher 7.0.2 and confirm that the deployed revision description matches the configured value in both API paths.
Written by the indexing model from the issue text.
Description
Release version
7.0.2
Describe the bug
We are using apiInformation.json where we have correctly setup everything what is needed, and it all worked just fine when we were using publisher version 5.x.x. After upgrade to publisher version 7.0.2 we noticed that our description of the revisions were not changing (before it was pipeline build ID).
The apiRevisionDescription was still configured correctly in apiInformation.json but somehow the value got ignored by the publisher and instead the description of the previous current revision was used.
It looks like the new publisher version 7.0.2 has either a bug (or maybe its a feature) where those descriptions are ignored.
AI helped me to identify the problem directly in the publisher code (but it may be wrong as I did not investigate the code in detail):
File: apiops/src/common/Api.cs line 299:
ApiRevisionDescription = existingDtoObject.Properties.ApiRevisionDescription,
and also:
Same bug exists in WorkspaceApi.cs line 334.
Expected behavior
When apiRevisionDescription is set in apiInformation.json, we expect this description in the api revision after deployment.
Actual behavior
When apiRevisionDescription is set in apiInformation.json, the api revision description set in apiInformation.json is ignored and latest current revision description is used instead.
Reproduction Steps
set apiRevisionDescription in apiInformation.json to certain value and deploy the revision via publisher version 7.0.2. Observe that thedescription in the api revision is not set to the value set in apiInformation.json.
- Dominant language
- C#
- Stars
- 448
- Forks
- 247
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Azure/apiops
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 52/100
Similar issues
-
type/automation type/tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
t/bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
ci-failure-cause test-failure
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area:auth FE mvp P3
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
klasolsson81/jobbliggaren#1788 ·