Add services multicloud endpoints - #234
Open
oracle-dbexpert wants to merge 34 commits into
Open
Conversation
added 2 more APIs
Added Postman information to Swagger
add postman information to overview
removing endpoints for reimplementation
Removes the `dist/` directory and all of its tracked contents from the repository. The `dist/` directory contains build artifacts that do not need to be tracked in source control. This change helps keep the repository clean and lightweight. - Ensures that the `.gitignore` includes the `dist/` directory to prevent it from being re-added. - No application logic is changed; this is a housekeeping update. - If any deployment or CI/CD workflows previously referenced `dist/`, those should be updated to build artifacts locally as needed.
…I spec - Introduces a new "APIs in Development" tag and section in the OpenAPI specification. - Adds endpoints for BYOL Advisor, Cloud Upgrade Advisor, and Migration Methods Advisor, each with documented parameters and example values. - Configures these development APIs to default to the dev server using per-endpoint server settings. - Implements basic authentication security scheme for Migration Methods Advisor API. - Improves discoverability and documentation of APIs under development, enabling easier testing and feedback gathering. No production endpoint logic is changed in this update; all new endpoints are clearly separated for development use.
…or APIs ## Changes - Added `Params` endpoints for: - BYOL Advisor (`/v1/BYOLAdvisorParams`) - Cloud Upgrade Advisor (`/v1/cloudUpgradeAdvisorParams`) - Migration Methods Advisor (`/v1/migrationMethodsAdvisorParams`) - Each endpoint provides: - Valid input options and their corresponding values - Parameter abbreviations and human-readable descriptions - Example queries and expected outputs - Enhanced all main Advisor API descriptions to reference their respective parameter endpoints, and vice versa, for easier navigation and better developer guidance. ## Context Addresses recent feedback on making advisory API parameter options more transparent
## Overview This MR restructures the API documentation by introducing new sections to logically group related endpoints. This improves usability, discoverability, and future scalability of the documentation set. ## Changes - Added distinct sections for: - Migration APIs - BYOL Advisor APIs - Upgrade Advisor APIs - Moved relevant endpoints into their corresponding sections for intuitive navigation. - Updated section titles and documentation for clarity and consistency. ## Notes - No changes to API functionality, documentation organization only.
### Summary - Updated Swagger documentation to reflect new production API endpoints. - Clearly stated in both Swagger and API message that `SOURCE_DB_TYPE` defaults to `EE` if omitted. - Verified that all other fields accept `null` as provided, with no additional defaulting.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.