Refactor API documentation and parameters for clarity and consistency#68
Merged
Refactor API documentation and parameters for clarity and consistency#68
Conversation
- Updated `params_run.csv` to enhance parameter descriptions and structure, including new optional fields and nested parameters. - Revised `data_api.rst` to improve clarity in API endpoints, added examples, and corrected URL paths. - Enhanced `processing_api.rst` with detailed descriptions of processing parameters, improved response examples, and added pagination options for processing statistics. - Updated user status response to include billing information and linked data providers. - Improved the sharing project section to clarify user roles and added notes for sharing with external users. - Added new v2 processing endpoints and examples, including cost calculation and processing creation. - Updated user guide on API authentication for better readability and accuracy.
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.
params_run.csvto enhance parameter descriptions and structure, including new optional fields and nested parameters.data_api.rstto improve clarity in API endpoints, added examples, and corrected URL paths.processing_api.rstwith detailed descriptions of processing parameters, improved response examples, and added pagination options for processing statistics.