Skip to content

Conversation

@FabrizioMoggio
Copy link
Contributor

What type of PR is this?

  • documentation

What this PR does / why we need it:

This is the M4 PR for the public version of the TI API, for the Fall25 Meta Release. The PR changes the API version from WIP to 0.10.0 ad provides the updated README.md and CHANGELOG.md files.

Which issue(s) this PR fixes

#67

@hdamker hdamker requested a review from a team September 1, 2025 14:01
@FabrizioMoggio
Copy link
Contributor Author

@Kevsy , @JoseMConde have you any comment?

Copy link
Contributor

@Kevsy Kevsy left a comment

Choose a reason for hiding this comment

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

A couple of suggestions made (see above)

FabrizioMoggio and others added 2 commits September 2, 2025 15:24
Co-authored-by: Kevin Smith <Kevsy@users.noreply.github.com>
Co-authored-by: Kevin Smith <Kevsy@users.noreply.github.com>
Copy link
Contributor

@Kevsy Kevsy left a comment

Choose a reason for hiding this comment

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

LGTM - note I can't approve because I'm also in release-management-reviewers, but you have my implicit codeowner approval at least :)

@hdamker
Copy link
Contributor

hdamker commented Sep 3, 2025

@FabrizioMoggio There is at least one critical inconsistency to fix in either the API or test definitions:

  • Test files use "$.applicationId" parameter but API YAML defines "appId" (lines 25,44,45 in postTrafficInfluence.feature; lines 25,44,66,86 in postTrafficInfluenceDevice.feature). This is a breaking inconsistency.
  • Align test files with API - change applicationId to appId in all feature files OR change API to use applicationId

Beyond that please check:

  • 409 Response Inconsistencies:
    • GET /traffic-influences has 409 (questionable for a read operation - what conflict?)
    • PATCH operation description says it returns "409 (DENIED_WAIT)" (line 571) but 409 is NOT in its responses list - documentation bug
    • POST /traffic-influence-devices lacks 409 while POST /traffic-influences has it (inconsistent for similar operations)
    • DELETE might benefit from 409 if resource is already in "deletion in progress" state
  • Line 571 Typo "errore" should be "error" in PATCH operation description

@hdamker
Copy link
Contributor

hdamker commented Sep 3, 2025

Some clean-up of legacy: please remove the non-compliant schema "ErrResponse" and the unused responses which are using this schema.

Beyond that there is a fix of the ErrorInfo schema in CAMARA_common.yaml which will come in a patch release of Commonalities. You can apply it already now as the fix is compliant to r3.3 of the API Design Guide, but it is neither critical nor mandatory for you now:

@hdamker
Copy link
Contributor

hdamker commented Sep 3, 2025

I suppose that you are aware that this API mentioned in the description is not released:

This information can be retrived using the CAMARA API: Edge Application Management.

Normally there shouldn't be any links into /main/ of repositories, but always a concrete release, but that does not exist yet.

@hdamker
Copy link
Contributor

hdamker commented Sep 3, 2025

"https://notificationSendServer12.supertelco.com" ... supertelco.com is a registered domain. Please use example.com instead.

@FabrizioMoggio
Copy link
Contributor Author

FabrizioMoggio commented Sep 3, 2025

I suppose that you are aware that this API mentioned in the description is not released:

This information can be retrived using the CAMARA API: Edge Application Management.

Normally there shouldn't be any links into /main/ of repositories, but always a concrete release, but that does not exist yet.

Yes, I know. unfortunately this is why I haven't use a direct link to the version. I could better specify that it is just an example.

@hdamker
Copy link
Contributor

hdamker commented Sep 3, 2025

I suppose that you are aware that this API mentioned in the description is not released:

This information can be retrived using the CAMARA API: Edge Application Management.

Normally there shouldn't be any links into /main/ of repositories, but always a concrete release, but that does not exist yet.

Yes, I know. unfortunately this is why I haven't use a direct link to the YAML but just a link to the Repo :-(. I could better specify that that one is just an example.

But the current link is going directly to the YAML (which has the misleading version 0.93-wip, which is used there since more than a year despite some updates in the meantime).

Copy link
Contributor

@hdamker hdamker left a comment

Choose a reason for hiding this comment

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

Some minor changes on the actual release PR content proposed.

Co-authored-by: Herbert Damker <herbert.damker@telekom.de>
FabrizioMoggio added a commit to FabrizioMoggio/TrafficInfluence that referenced this pull request Sep 4, 2025
@hdamker
Copy link
Contributor

hdamker commented Sep 9, 2025

@FabrizioMoggio something went wrong in 17df308 ... it brought the values from the pre-release back. Please check and update.

BTW: is there any (other) reason that the PR is not ready for review again?

@FabrizioMoggio FabrizioMoggio marked this pull request as ready for review September 11, 2025 06:24
@FabrizioMoggio
Copy link
Contributor Author

Is there some pending issue yet? I don't see any, but I have found the PR marked as Draft (it was not me putting it in that status). In my understanding I should have implemented all the suggestions.

Copy link
Contributor Author

@FabrizioMoggio FabrizioMoggio left a comment

Choose a reason for hiding this comment

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

All the comments have been addressed

@hdamker
Copy link
Contributor

hdamker commented Sep 16, 2025

@FabrizioMoggio there seem to be still some inconsistencies between API and test definition:

Inconsistency #1: AppInstanceId casing

  • API definition: Uses appInstanceId (camelCase with lowercase 'a')
  • Test files: Reference $.AppInstanceId (PascalCase with uppercase 'A')
  • Occurrences:
    • traffic-influence-postTrafficInfluenceDevice.feature:67
    • traffic-influence-postTrafficInfluenceDevice.feature:87
    • traffic-influence-postTrafficInfluence.feature:46
  • How to fix: Update test files to use $.appInstanceId

Inconsistency #2: Zone property naming

  • API definition: Uses edgeCloudZoneId
  • Test files: Reference $.zone
  • Occurrences:
    • traffic-influence-postTrafficInfluenceDevice.feature:67
    • traffic-influence-postTrafficInfluenceDevice.feature:87
    • traffic-influence-postTrafficInfluence.feature:46
  • How to fix: Update test files to use $.edgeCloudZoneId

@hdamker
Copy link
Contributor

hdamker commented Sep 16, 2025

  • PATCH operation description says it returns "409 (DENIED_WAIT)" (line 571) but 409 is NOT in its responses list - documentation bug

As far as I can see this inconsistency isn't yet fixed: Line 570 still mentions "error code 409 (DENIED_WAIT)" but PATCH responses (lines 585-612) still don't include 409

@hdamker
Copy link
Contributor

hdamker commented Sep 16, 2025

All the comments have been addressed

@FabrizioMoggio thanks for addressing (most of) the previous findings. Please address the issues within #68 (comment) and #68 (comment) and we are good to go!

@FabrizioMoggio
Copy link
Contributor Author

All the comments have been addressed

@FabrizioMoggio thanks for addressing (most of) the previous findings. Please address the issues within #68 (comment) and #68 (comment) and we are good to go!

Fixed with: #77

@FabrizioMoggio FabrizioMoggio marked this pull request as ready for review September 16, 2025 14:06
Copy link
Contributor

@hdamker hdamker left a comment

Choose a reason for hiding this comment

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

Thanks @FabrizioMoggio

Approved on behalf of Release Management 👏
Next steps for the team:
• [ ] PR merged (by API repository codeowner)
• [ ] Release created within GitHub (by API repository codeowner)
• [ ] Release Tracker updated (with creation date of the release and the release tag link)

Copy link
Contributor

@Kevsy Kevsy left a comment

Choose a reason for hiding this comment

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

LGTM - approved as codeowner

@FabrizioMoggio FabrizioMoggio merged commit cb5502f into camaraproject:main Sep 16, 2025
2 checks passed
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.

3 participants