Skip to content

Refs #426: Clarify authenticated attempt examples #542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Juanpablo24-06 wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −0
Open

Refs #426: Clarify authenticated attempt examples #542

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/api-examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@ login. Attempts are advisory only: they do not create payments, claim
acceptance, mutate ledger balances, or stop maintainers from accepting useful
work.

For authenticated examples, replace `<browser-session-cookie>` with the cookie
from a GitHub-authenticated browser session for the same account. Unauthenticated
attempt registration and release requests return `401`.

List active attempts for a bounty:

```bash
Expand Down Expand Up @@ -121,6 +125,7 @@ Register an attempt with a submitter identity, optional source URL, and TTL:

```bash
curl -s -X POST "$API_HOST/api/v1/bounties/<bounty_id>/attempts" \
-b "<browser-session-cookie>" \
-H "Content-Type: application/json" \
-d '{"submitter_account":"github:tatelyman","source_url":"https://github.com/ramimbo/mergework/tree/attempt-bounty-321","ttl_seconds":86400}'
```
Expand Down Expand Up @@ -154,6 +159,7 @@ Release an active attempt when you stop working:

```bash
curl -s -X POST "$API_HOST/api/v1/bounty-attempts/<attempt_id>/release" \
-b "<browser-session-cookie>" \
-H "Content-Type: application/json" \
-d '{"submitter_account":"github:tatelyman"}'
```
Expand Down
Loading