Add server URL to OpenAPI schema

[abhi1693]

NetBox version

v3.7.8

Feature type

Change to existing functionality

Proposed functionality

Incorporate the server's base URL into the OpenAPI schema by adding it to the 'servers' object. This modification will automate the configuration of the base URL for API clients. Specifically, this change should include:

• Definition of a default server URL in the OpenAPI configuration.
• Ensuring that this URL is referenced as the base path for all API calls within the NetBox API documentation and schema.
• Providing flexibility for users to override the default URL if their deployment requires a different configuration.

This update will streamline the API client setup process by pre-defining the server URL, thereby eliminating the need for users to manually specify this setting during client configuration.

Use case

Adding the server URL to the 'servers' object in the OpenAPI schema enhances the utility of the NetBox API by explicitly defining the base URL for all API endpoints. This change addresses the issue where clients of the NetBox API need to manually configure the base URL, which can lead to errors and inconsistencies, especially in environments where NetBox instances are dynamically created and managed. By specifying the server URL in the schema, client applications can automatically adapt to changes in the server's location without requiring manual updates. This makes the API more robust and easier to integrate with, improving user experience and supporting more dynamic, cloud-based environments where the URL might change frequently.

Database changes

No response

External dependencies

No response