Skip to content

docs: standardize endpoint reference sections#1122

Merged
HoomanDgtl merged 3 commits into
akash-network:mainfrom
hrishabhayush:docs/console-api-reference-endpoints
May 12, 2026
Merged

docs: standardize endpoint reference sections#1122
HoomanDgtl merged 3 commits into
akash-network:mainfrom
hrishabhayush:docs/console-api-reference-endpoints

Conversation

@hrishabhayush
Copy link
Copy Markdown
Contributor

What changed

  • Normalized endpoint paths for single-resource routes:
    • GET /v1/deployments/{dseq}
    • PUT /v1/deployments/{dseq}
    • DELETE /v1/deployments/{dseq}
  • Reworked endpoint sections to a consistent structure:
    • purpose sentence
    • parameters table
    • cURL example
    • JavaScript (fetch) example
    • response schema table
    • example JSON response
  • Updated all listed Console API endpoints in this reference to follow the same template style.

Why

  • Make the reference predictable and faster to scan.
  • Reduce integration errors from inconsistent path/parameter documentation.
  • Improve copy-paste usability by giving complete request/response examples for each endpoint.

Test plan

  • Run docs locally from worktrees/wt-api-endpoints.
  • Open /docs/api-documentation/console-api/api-reference/.
  • Verify /v1/deployments/{dseq} paths render correctly for GET/PUT/DELETE.
  • Verify each endpoint section includes parameters, cURL, JS, and response examples.
  • Spot-check v1 and v2 endpoint formatting consistency.
Screenshot 2026-04-30 at 1 39 53 AM Screenshot 2026-04-30 at 1 40 13 AM

@HoomanDgtl HoomanDgtl requested a review from Zblocker64 May 7, 2026 13:40
@HoomanDgtl HoomanDgtl requested a review from baktun14 May 7, 2026 13:40
@Zblocker64 Zblocker64 removed their request for review May 7, 2026 13:50
@hrishabhayush
Copy link
Copy Markdown
Contributor Author

Is there something related to staking link broken in CI/CD which is affecting my PR?

@hrishabhayush hrishabhayush requested a review from baktun14 May 12, 2026 03:27
@hrishabhayush
Copy link
Copy Markdown
Contributor Author

hrishabhayush commented May 12, 2026

Screenshot 2026-05-12 at 7 23 04 AM

Can't seem to merge it even after approval @baktun14.

@HoomanDgtl HoomanDgtl merged commit 77d2063 into akash-network:main May 12, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants