Differential D14128

[alias-server] Clean up README as prep for documenting API endpoints
ClosedPublic
Actions

Authored by bytesofman on Jun 26 2023, 18:31.

Details

Reviewers

Fabien

Group Reviewers

Restricted Project

Commits

rABC5dee5570b988: [alias-server] Clean up README as prep for documenting API endpoints

Summary

T3060

Clean up legacy / unused TODO info from README and replace with stub API documentation

Will be expanded as new endpoints are added

Note: the '/aliases' endpoint will either be deprecated or paginated, in another diff

Test Plan

Verify only the README is changed, no typos

Diff Detail

Repository

rABC Bitcoin ABC

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

bytesofman created this revision.Jun 26 2023, 18:31

Herald added a reviewer: Restricted Project. · View Herald TranscriptJun 26 2023, 18:31

bytesofman requested review of this revision.Jun 26 2023, 18:31

Harbormaster completed remote builds in B24185: Diff 41004.Jun 26 2023, 18:32

Fabien accepted this revision.Jun 26 2023, 19:27

This revision is now accepted and ready to land.Jun 26 2023, 19:27

Closed by commit rABC5dee5570b988: [alias-server] Clean up README as prep for documenting API endpoints (authored by bytesofman). · Explain WhyJun 26 2023, 19:54

This revision was automatically updated to reflect the committed changes.

bytesofman added a commit: rABC5dee5570b988: [alias-server] Clean up README as prep for documenting API endpoints.

Revision Contents
Changeset List

Path

Size

apps/

alias-server/

README.md

56 lines

Diff 41010

View Options

apps/alias-server/README.md

[alias-server] Clean up README as prep for documenting API endpointsClosedPublicActions