docs: Sync api-refs with current API implementation - #523
Open
claudiubelu wants to merge 1 commit into
Open
Conversation
The API reference docs had drifted from the actual endpoint / schema / model code over time: several fields returned or accepted by the API were undocumented, some documented fields / params no longer exist, and a few path / action names and responses were incorrect. Corrects region, service, provider, diagnostics, endpoint, transfer, deployment, and minion_pool docs, their shared parameters.yaml, and the JSON samples to match the current coriolis/api/v1/ implementation.
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
1 participant
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.
The API reference docs had drifted from the actual endpoint / schema / model code over time: several fields returned or accepted by the API were undocumented, some documented fields / params no longer exist, and a few path / action names and responses were incorrect.
Corrects region, service, provider, diagnostics, endpoint, transfer, deployment, and minion_pool docs, their shared
parameters.yaml, and the JSON samples to match the currentcoriolis/api/v1/implementation.