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

TI API: Rel 0.9.8 #311

Merged
merged 5 commits into from
Oct 10, 2024
Merged

Conversation

FabrizioMoggio
Copy link
Collaborator

@FabrizioMoggio FabrizioMoggio commented Oct 10, 2024

What type of PR is this?

Add one of the following kinds:

  • enhancement/feature
  • cleanup
  • documentation

What this PR does / why we need it:

This PR improves the TI API documentation and returned values to help the API Consumer to identify the target of the service data flow (the selected Edge EAS)

Which issue(s) this PR fixes:

Changelog input


- Documentation modified to add DNS and better explanation on the tasks from the TI API and API Consumer in order to identify the correct target of the service data flow
- added "selected_appInstanceId" as output parameter in the API Notification

@@ -79,18 +82,24 @@ info:
by a source port and a destination port and protocol. To optimise the flow
from more source ports or destination ports or protocols, the TI API must be
invoked many times.\
It is important to notice that it is a task of the Service Application to
Copy link
Collaborator

Choose a reason for hiding this comment

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

The "Service Application" seems to be a new name for existing concept like User Client or Client Application. If this is correct please check if we can reuse the existing name else we will need to define the term "Service Application".

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

You are totally right, I will update it with "Client Application".

server (EAS), for example using Edge DNS or using the target EAS IP address.
The TI API provides back the selected EAS instance identifier from which the
Service Application can retrive the destination IP address of its backend
server, to properly configure the service data flow.\
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just to enhance the documentation we may also provide hint or reference to other APIs which can be used to retrieve the destination IP as mentioned in this statement "Service Application can retrive the destination IP address of its backend server". This is just for enhancement if it looks fine.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

it is a good proposal. In my understanding one API is : Edge-Application-Management. Is my understanding correct?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes i think GET /apps/{appId}/instances: from Edge-Application-Management. seems to be an option and possibly even the Application_Endpoint_Discovery_API could also be used in some of the scenarios though it will work without any instance identifier.

Copy link
Collaborator

@gunjald gunjald left a comment

Choose a reason for hiding this comment

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

Changes are looking good to me.

@FabrizioMoggio FabrizioMoggio merged commit ce776ac into camaraproject:main Oct 10, 2024
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.

2 participants