Changeset 37563 in project


Ignore:
Timestamp:
04/26/19 10:46:20 (4 weeks ago)
Author:
evhan
Message:

eggref/topham: Fix broken links

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/5/topham

    r37562 r37563  
    22
    33[[toc:]]
    4 
    54
    65== Description
     
    2221information about it:
    2322
    24 <enscript highlight="scheme"> 
     23<enscript highlight="scheme">
    2524(import (topham)
    2625        (topham builds))
     
    5251{{access-token}} parameter:
    5352
    54 <enscript highlight="scheme"> 
     53<enscript highlight="scheme">
    5554(import (topham))
    5655
     
    6059The second is to set the {{SRHT_ACCESS_TOKEN}} environment variable:
    6160
    62 <enscript highlight="scheme"> 
     61<enscript highlight="scheme">
    6362(import (chicken process-context))
    6463
     
    8079from which a resource should be (or has been) fetched:
    8180
    82 <enscript highlight="scheme"> 
     81<enscript highlight="scheme">
    8382(mailing-lists)
    8483; => ((#:service "lists" #:path "/api/lists"))
     
    102101
    103102To specify a starting ID, use the {{page}} combinator. This sets the
    104 {{start}} parameter for GET requests, per [[https://en.wikipedia.org/wiki/Pagination|sr.ht's API]]:
    105 
    106 <enscript highlight="scheme">
    107 (import (only (topham) retrieve page))
     103{{start}} parameter for GET requests, per [[https://man.sr.ht/api-conventions.md#pagination|sr.ht's API]]:
     104
     105<enscript highlight="scheme">
     106(import (only (topham) retrieve page)
     107        (only (topham paste) pastes))
    108108
    109109; retrieve the first page of results
    110 (retrieve (emails "~user"))
     110(retrieve (pastes))
    111111
    112112; retrieve results starting from id 42
    113 (retrieve (page (emails "~user") 42))
     113(retrieve (page (pastes) 42))
    114114</enscript>
    115115
     
    149149These procedures correspond to the {{POST}}, {{GET}}, {{PUT}} and {{DELETE}}
    150150request methods, respectively. The result is a Scheme representation of
    151 the response, or {{#f}} if the requested resource was not found.
     151the response (generally a "crud object"), or {{#f}} if the requested
     152resource was not found.
    152153
    153154If the response is an error (other than HTTP 404), a condition of type
     
    169170<procedure>(job #!key argument ...) => crud</procedure>
    170171
    171 In the first form, [[https://man.sr.ht/builds.sr.ht/api.md#get-apijobsid|fetches a job resource by ID]].
    172 
    173 In the second form, [[https://man.sr.ht/builds.sr.ht/api.md#post-apijobs|creates a new job resource]].
     172In the first form, [[https://man.sr.ht/builds.sr.ht/api.md#get-apijobsid|fetches a job by ID]].
     173
     174In the second form, [[https://man.sr.ht/builds.sr.ht/api.md#post-apijobs|creates a new job]].
     175
     176{{number}} should be a job resource ID.
    174177
    175178<procedure>(manifest number) => crud</procedure>
    176179
    177 [[https://man.sr.ht/builds.sr.ht/api.md#get-apijobsid|Retrieves a job's manifest]].
     180[Retrieves a job's manifest][get-apijobsidmanifest].
    178181
    179182{{number}} should be a job resource ID.
     
    181184<procedure>(start number) => crud</procedure>
    182185
    183 [[https://man.sr.ht/builds.sr.ht/api.md#post-apijobs|Starts a job]] that was created with {{execute: #f}}.
     186[[https://man.sr.ht/builds.sr.ht/api.md#post-apijobsidstart|Starts a job]] that was created with {{execute: #f}}.
    184187
    185188{{number}} should be a job resource ID.
     
    200203<procedure>(profile #!key argument ...) => crud</procedure>
    201204
    202 In the first form, [[https://man.sr.ht/builds.sr.ht/api.md#get-apijobsid|fetches the active user's profile]].
     205In the first form, [[https://man.sr.ht/meta.sr.ht/user-api.md#get-apiuserprofile|fetches the active user's profile]].
    203206
    204207In the second form, [[https://man.sr.ht/meta.sr.ht/user-api.md#put-apiuserprofile|updates the user's profile]].
     
    206209<procedure>(audit-log) => crud</procedure>
    207210
    208 [[https://man.sr.ht/builds.sr.ht/api.md#get-apijobsid|Retrieves the active user's audit log]].
     211[[https://man.sr.ht/meta.sr.ht/user-api.md#get-apiuseraudit-log|Retrieves the active user's audit log]].
    209212
    210213This endpoint is subject to [[#pagination|pagination]].
     
    212215<procedure>(ssh-keys) => crud</procedure>
    213216
    214 [[https://man.sr.ht/builds.sr.ht/api.md#get-apijobsid|Retrieves the active user's SSH keys]].
     217[[https://man.sr.ht/meta.sr.ht/user-api.md#get-apiuserssh-keys|Retrieves the active user's SSH keys]].
    215218
    216219This endpoint is subject to [[#pagination|pagination]].
     
    219222<procedure>(ssh-key #!key ssh-key) => crud</procedure>
    220223
    221 In the first form, [[https://man.sr.ht/builds.sr.ht/api.md#get-apijobsid|fetches an SSH key by ID]].
    222 
    223 In the second form, [[https://man.sr.ht/builds.sr.ht/api.md#post-apijobs|creates a new SSH key]].
     224In the first form, [[https://man.sr.ht/meta.sr.ht/user-api.md#get-apiuserssh-keysid|fetches an SSH key by ID]].
     225
     226In the second form, [[https://man.sr.ht/meta.sr.ht/user-api.md#post-apiuserssh-keys|creates a new SSH key]].
    224227
    225228{{number}} should be a key resource ID.
     
    227230<procedure>(pgp-keys) => crud</procedure>
    228231
    229 [[https://man.sr.ht/builds.sr.ht/api.md#get-apijobsid|Retrieves the active user's PGP keys]].
     232[[https://man.sr.ht/meta.sr.ht/user-api.md#get-apiuserpgp-keys|Retrieves the active user's PGP keys]].
    230233
    231234This endpoint is subject to [[#pagination|pagination]].
     
    234237<procedure>(pgp-key #!key pgp-key) => crud</procedure>
    235238
    236 In the first form, [[https://man.sr.ht/builds.sr.ht/api.md#get-apijobsid|fetches a PGP key by ID]].
    237 
    238 In the second form, [[https://man.sr.ht/builds.sr.ht/api.md#post-apijobs|creates a new PGP key]].
     239In the first form, [[https://man.sr.ht/meta.sr.ht/user-api.md#get-apiuserpgp-keysid|fetches a PGP key by ID]].
     240
     241In the second form, [[https://man.sr.ht/meta.sr.ht/user-api.md#post-apiuserpgp-keys|creates a new PGP key]].
    239242
    240243{{number}} should be a key resource ID.
     
    249252<procedure>(paste #!key contents filename visibility) => crud</procedure>
    250253
    251 In the first form, [[https://man.sr.ht/builds.sr.ht/api.md#get-apijobsid|fetches a paste resource by ID]].
    252 
    253 In the second form, [[https://man.sr.ht/builds.sr.ht/api.md#post-apijobs|creates a new paste resource]].
    254 
    255 {{string}} should be a paste resource SHA.
     254In the first form, [[https://man.sr.ht/paste.sr.ht/api.md#get-apipastessha|fetches a paste by ID]].
     255
     256In the second form, [[https://man.sr.ht/paste.sr.ht/api.md#post-apipastes|creates a new paste]].
     257
     258{{string}} should be a paste SHA.
    256259
    257260<procedure>(blob string) => crud</procedure>
    258261
    259 [[https://man.sr.ht/builds.sr.ht/api.md#get-apijobsid|Retrieves a blob resource]].
    260 
    261 {{string}} should be a blob resource SHA.
     262[[https://man.sr.ht/paste.sr.ht/api.md#get-apiblobssha|Fetches a blob]].
     263
     264{{string}} should be a blob SHA.
    262265
    263266<procedure>(pastes) => crud</procedure>
    264267
    265 [[https://man.sr.ht/builds.sr.ht/api.md#get-apijobsid|Retrieves a list of paste resources]].
     268[[https://man.sr.ht/paste.sr.ht/api.md#get-apipastes|Retrieves a list of pastes]].
    266269
    267270This endpoint is subject to [[#pagination|pagination]].
Note: See TracChangeset for help on using the changeset viewer.