docs: Api spec improvements #456
Draft
Conversation
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
linconvidal
added
documentation
|
This is ready to be merged. |
linconvidal
force-pushed
the
api-spec-improvements
branch
from
0fc59a7 to
d08de82
Compare
matiwinnetou
approved these changes
May 28, 2025
linconvidal
force-pushed
the
api-spec-improvements
branch
from
b4cb439 to
b91a3b9
Compare
|
@linconvidal not a spec improvement, but can you just change the docker-compose command to docker compose in the readMe here |
…ents - Updated API title to reflect rebranding to Mesh API. - Enhanced some endpoint descriptions for clarity and accuracy (network status, options, block transaction). - Added detailed descriptions for Cardano-specific transaction and block metadata. - Commented out unimplemented mempool endpoints and related documentation. - Improved Docusaurus configuration for better user experience, including last update timestamps . - Updated CSS for improved layout and styling consistency across documentation pages.
- Updated example values for block, account and transaction identifiers to align with current data. - Enhanced operation types and statuses to include Cardano-specific options. - Added valid response examples to improve clarity. - Commented out unimplemented features and provided TODO notes for future implementation.
…tion layout - Updated custom CSS to enhance layout consistency, including centering the navbar and main wrapper. - Removed the proxy URL from the configuration. - Adjusted styles for the theme edit button and sidebar to improve user experience. - Deleted the outdated API specification file to streamline documentation.
Remove multiple 'examples' entries from schema definitions ('Operation', 'NetworkIdentifier'). These were intended solely for enhanced rendering in Scalar docs but caused spec-validation failures during CI builds.
Single 'example' per schema retained to ensure OpenAPI compliance and fix build errors.
…ues in API specification - Upgraded the OpenAPI generator Maven plugin from version 6.4.0 to 7.13.0. - Simplified example values in the API specification by removing unnecessary array structures for 'network' and 'status' fields.
linconvidal
force-pushed
the
api-spec-improvements
branch
from
2652c02 to
84a331a
Compare
|
@Kartiiyer12 Done in #478 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.