Skip to content

Commit 2fae0f1

Browse files
committed
chore: update OpenAPI specification and documentation visual improvements
- 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.
1 parent 6fd1a8c commit 2fae0f1

File tree

8 files changed

+755
-431
lines changed

8 files changed

+755
-431
lines changed

api/src/main/resources/rosetta-specifications-1.4.15/api.yaml

Lines changed: 431 additions & 331 deletions
Large diffs are not rendered by default.

docs/docs/development/performance-measurements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This page documents the performance measurements and load test results for diffe
1010

1111
## Load Test Results
1212

13-
Below you can find the load test results for various releases, comparing different deployment options.
13+
Below you can find the load test results for various releases, comparing different deployment options. All performance tests are evaluated against a Service Level Agreement (SLA) target of 1 second response time, which we consider the acceptable threshold for API responsiveness in production environments.
1414

1515
<details>
1616
<summary>

docs/docs/development/qa-regression.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: Testing methodology and procedures for releases
88

99
The following steps are performed as part of the QA process for new releases:
1010

11-
1. **E2E Testing**: Run the complete end-to-end test flow on preprod network using the [`e2e-tests`](https://github.com/cardano-foundation/cardano-rosetta-java/tree/main/e2e-tests) suite
11+
1. **E2E Testing**: Run the complete end-to-end test flow on preprod network using the [`e2e_tests`](https://github.com/cardano-foundation/cardano-rosetta-java/tree/main/e2e_tests) suite
1212

1313
- Test on both single docker and docker-compose deployments
1414
- Verify all construction API flows work correctly

docs/docusaurus.config.js

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ const config = {
4747
// Remove this to remove the "edit this page" links.
4848
editUrl:
4949
'https://github.com/cardano-foundation/cardano-rosetta-java/tree/main/docs/',
50+
showLastUpdateAuthor: true,
51+
showLastUpdateTime: true,
5052
exclude: [
5153
'**/test-results/**', // Exclude all test-results directories
5254
'**/_test-results/**', // Exclude directories with underscore prefix
@@ -144,19 +146,28 @@ const config = {
144146
{
145147
label: 'API Reference',
146148
route: '/cardano-rosetta-java/api',
149+
147150
configuration: {
148151
url: '/cardano-rosetta-java/api.yaml',
149152
hideDownloadButton: true,
150153
hideDarkModeToggle: true,
151154
forceDarkModeState: 'light',
152155
withDefaultFonts: false,
153156
hideClientButton: true,
157+
searchHotKey: 'l',
158+
proxyUrl: 'https://proxy.scalar.com',
154159
servers: [
155160
{
156161
url: 'http://localhost:8082',
157162
name: 'Local',
158163
},
159164
],
165+
customCss: `* {
166+
--scalar-background-1: transparent;
167+
--scalar-font: 'Helvetica Neue', Helvetica, Arial, sans-serif;
168+
}`
169+
170+
160171
},
161172
},
162173
],

docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"@docusaurus/preset-classic": "3.7.0",
2020
"@docusaurus/theme-mermaid": "^3.7.0",
2121
"@mdx-js/react": "^3.0.0",
22-
"@scalar/docusaurus": "^0.5.5",
22+
"@scalar/docusaurus": "^0.6.3",
2323
"clsx": "^2.0.0",
2424
"prism-react-renderer": "^2.3.0",
2525
"react": "^19.0.0",

0 commit comments

Comments
 (0)