ISS-11 Add Rewards (Alpha) API documentation#215
Open
diegofranck-paxos wants to merge 11 commits intomainfrom
Open
ISS-11 Add Rewards (Alpha) API documentation#215diegofranck-paxos wants to merge 11 commits intomainfrom
diegofranck-paxos wants to merge 11 commits intomainfrom
Conversation
Add new Rewards (Alpha) section to the API Reference with four endpoint groups: Reward Addresses, Claims, Payout Groups, and Rewards. Includes overview pages, individual endpoint MDX files, docs.json navigation updates, and a changelog entry. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
The validate-scopes CI check requires scope blocks only when the OpenAPI spec defines OAuth2 security on the endpoint. These alpha endpoints have no OAuth security defined in the spec. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Add paxos-v2-preview-rewards.openapi.json to define OAuth2 security on all Rewards (Alpha) endpoints, satisfying the validate-scopes CI check. Restore scope blocks in all 14 endpoint MDX files. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace stub responses with complete schemas from the live OpenAPI spec, including all request bodies, query parameters, and response objects for all 14 Rewards (Alpha) endpoints. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace the group name and move the alpha indicator to a Mintlify sidebar tag, matching the design shown in the product screenshot. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace all Alpha references with Preview language across overview pages and the preview spec version field. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
Summary
docs.jsonnavigation to include the new section after the existing Rewards groupEndpoints documented
GET/POST /rewards/addresses,PUT/DELETE /rewards/addresses/{id}GET/POST /rewards/claim-schedules,PUT/DELETE /rewards/claim-schedules/{id},GET /rewards/claimsGET/POST /rewards/payout-groups,PUT/DELETE /rewards/payout-groups/{id}GET /rewards/detailsTest plan
🤖 Generated with Claude Code