Skip to content

docs(config): document openaev.agent-url (#6484) - #7811

Merged
antoinemzs merged 1 commit into
OpenAEV-Platform:mainfrom
AzazelSensei:docs/document-agent-url-6484
Sep 9, 2026
Merged

docs(config): document openaev.agent-url (#6484)#7811
antoinemzs merged 1 commit into
OpenAEV-Platform:mainfrom
AzazelSensei:docs/document-agent-url-6484

Conversation

@AzazelSensei

@AzazelSensei Abdullah (AzazelSensei) commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Proposed changes

  • Document openaev.agent-url in the deployment configuration table
  • Add a commented example next to openaev.base-url in application.properties and the dev example

Testing Instructions

  1. Search the deployment docs for openaev.agent-url
  2. Confirm the commented example sits under openaev.base-url in application.properties

Related issues

Checklist

  • I consider the submitted work as finished
  • I tested the code for its functionality
  • I wrote test cases for the relevant uses case
  • I added/update the relevant documentation (either on github or on notion)
  • Where necessary I refactored code to improve the overall quality
  • For bug fix -> I implemented a test that covers the bug

Add the agent URL to the deployment table and leave a commented
example next to base-url. Agents fall back to base-url when it is
unset.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR closes the documentation gap around the openaev.agent-url configuration by adding a clear description in the deployment configuration table and providing commented examples in the default and dev example properties files, helping operators understand when to set it (e.g., network path differences for agents).

Changes:

  • Documented openaev.agent-url (and its runtime fallback to openaev.base-url) in the deployment configuration table.
  • Added commented openaev.agent-url examples near openaev.base-url in application.properties and application-dev.properties.example.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
openaev-api/src/main/resources/application.properties Adds an inline commented example and explanation for openaev.agent-url next to openaev.base-url.
openaev-api/src/main/resources/application-dev.properties.example Adds a dev-profile commented example and short explanation for openaev.agent-url.
docs/docs/deployment/configuration.md Adds openaev.agent-url to the deployment configuration table with a production-oriented explanation and fallback behavior.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@antoinemzs

antoinemzs commented Sep 9, 2026

Copy link
Copy Markdown
Member

Abdullah (@AzazelSensei) cheers for this, we appreciate your contribution! Good spot indeed.

@antoinemzs antoinemzs self-assigned this Sep 9, 2026
@antoinemzs antoinemzs added community Contribution from the community. documentation Type: documentation only (docs:). labels Sep 9, 2026
@antoinemzs
antoinemzs merged commit 77eaed0 into OpenAEV-Platform:main Sep 9, 2026
41 of 43 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community Contribution from the community. documentation Type: documentation only (docs:).

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix(documentation): Environnement var not docummented

3 participants