Prioritise API with api write=on #1315
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
chore
aphralG
reviewed
Oct 7, 2025
| return false | ||
| } | ||
|
|
||
| func (ncp *NginxConfigParser) sortPlusAPIs(apis []*model.APIDetails) []*model.APIDetails { |
There was a problem hiding this comment.
Could you add a comment or update the naming to explain that this is trying to prioritise and find apis with write enabled?
| server_name _; | ||
| location /api/ { | ||
| api write=on; | ||
| api write=off; |
There was a problem hiding this comment.
Could you add unit test for
- the case where there are multiple apis and the first one doesn't have write enabled but another does
- the function that prioritises the api with write on
| // the API CA file path | ||
| string Ca = 3; | ||
| // flag to know API is configured with 'write=on;' | ||
| bool write_enabled = 4; |
There was a problem hiding this comment.
Does a change need to happen to the MPI ? Do the management planes care about the write status ? Could the change instead only be made to the APIDetails struct thats internal to the Agent?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue:
Currently, if more than one Plus API is defined in NGINX config, Agent will always select the first working API URL, and if that API has "api write=off", that leads to "MethodDisabled" error while trying to update upstream using an API.
Fix:
With this change agent is parsing all the Plus API's defined in the NGINX config to find if any of them have "api write=on" and if yes, then we are selecting that as the default api; else we are selecting the first API defined in the NGINX config as the default one, which is the current behaviour.
Checklist
Before creating a PR, run through this checklist and mark each as complete.
CONTRIBUTINGdocumentmake install-toolsand have attached any dependency changes to this pull requestREADME.md)