Changeset 38747 in project


Ignore:
Timestamp:
06/06/20 08:12:57 (5 weeks ago)
Author:
evhan
Message:

wiki/sourcehut: Add docs for git library

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/5/sourcehut

    r38274 r38747  
    215215
    216216
     217==== git
     218
     219The {{(sourcehut git)}} library provides request builders for [[https://man.sr.ht/git.sr.ht/api.md|git.sr.ht]].
     220
     221<procedure>(log string) => crud</procedure>
     222<procedure>(log string string) => crud</procedure>
     223
     224In the first form, [[https://man.sr.ht/git.sr.ht/api.md#get-apireposnamerefs|retrieves a list of references in the given repository belonging to the active user]].
     225
     226In the second form, [[https://man.sr.ht/git.sr.ht/api.md#get-apireposnamerefs|retrieves references for a repository belonging to the given user]].
     227
     228This endpoint is subject to [[#Pagination|pagination]].
     229
     230<procedure>(log string) => crud</procedure>
     231<procedure>(log string string) => crud</procedure>
     232
     233In the first form, [[https://man.sr.ht/git.sr.ht/api.md#get-apireposnamerefs|retrieves a list of the latest commits on the default branch of the given repository belonging to the active user]].
     234
     235In the second form, [[https://man.sr.ht/git.sr.ht/api.md#get-apireposnamerefs|retrieves commits for a repository of the given
     236user]].
     237
     238This endpoint is subject to [[#Pagination|pagination]].
     239
     240<procedure>(artifact string string #!key file filename) => crud</procedure>
     241<procedure>(artifact string string string #!key file filename) => crud</procedure>
     242
     243In the first form, [[https://man.sr.ht/git.sr.ht/api.md#post-apireposnameartifactsref|attaches an artifact to a reference in the given repository belonging to the active user]].
     244
     245In the second form, [[https://man.sr.ht/git.sr.ht/api.md#post-apireposnameartifactsref|attaches an artifact to a reference in a repository belonging to the given user]].
     246
     247{{file}} should either be an input port or a string containing the file contents. A {{filename}} can also be given, to specify a name for the file. If not given, the name of the input port will be used.
     248
     249
    217250==== lists
    218251
Note: See TracChangeset for help on using the changeset viewer.