Missing global snippets API

Description

The API lacks support of the global snippets feature. The projects snippets are nice, but disabled per default, and thus users will more easily tend to publish snippets on global scope, than within projects.

Proposal

Update the /snippets endpoint which would help adding/deleting/modifying/listing all global snippets. Eventually, unifying with the projects snippets could be a good idea.

Links / references

I guess that's a case for the v9 API updates goals: #20070 (closed) (though if it could be backported to a future v8 that would be )

BTW, for reference, this is the link to the issue tracking the feature I'd like to implement:

• https://github.com/guyzmo/git-repo/issues/12

and here's the changeset of the feature I'm adding to my tool:

• guyzmo/git-repo@7b5309cb

as I'm trying to offer an homogeneous and simple interface across github/gitlab/bitbucket, the lack of a global snippet API is a big problem. I'd rather drop project_snippets support altogether and only support global ones from CLI (or maybe keep listing/fetching them).

My main issues are that:

• listing need iterating over list of projects, and then list of snippets (which takes forever, and needs pagination handling) ;
• creation of a snippet will need a special CLI parameter just for gitlab
• I need to retrieve the project_id from the name each time I need to access a snippet

Basically snippets from CLI can be very convenient, and without a good API, they are impossible to use Here's how it's currently working with github:

https://asciinema.org/a/cpjuxczprkihw3ssa23cummwb

N.B.: I'm planning on renaming the gist subcommand as snippet

cc @zj

Added ~13884 ~14213 ~13817 labels

Milestone changed to %29

Added ~123454 label

I don't see why this can't be done before 9.0. I also would love a CLI interface I can just pipe stuff into and get a snippet link back :)

cool I started to hack the gitlab code, but it'd help me a lot if I could have a gitlab dev to chat with, to help me out, while I'm implementing it.

I can take 5-10 minutes to help you if you want, please shoot me an email. (see my profile)

Please first take a look at a PR which didn't seem to have made it to this project: https://github.com/gitlabhq/gitlabhq/pull/10363/files

Mentioned in merge request !6373 (merged)

ok, so I have pushed an MR, cf !6373 (merged) with the implementation. Still have issues figuring out:

• authentication when creating a new snippet…
• how to implement search (looks like there's a SearchService would it work with snippets as well?)
• how to correctly implement /snippets/public (like /snippets/search) so that those methods aren't returning 404.

Also, for consistency with the UI (which enables listing of another user's public snippets), I wanted to add a /users/:id/snippets to get the list of a given user's snippets, but I figured that actually it's not fitting the current API design… (or there would be a /users/:id/projects etc.). What would be the best way to list a user's snippets, then?

• /snippets/user/:id? (imho, that does not feels right)
• /snippets/search?user=:id? (that's not very REST, as user is a resource)
• something else?

Added ~874211 label

closed via commit 87f3a66c

mentioned in commit fengweijie/gitlab-ce@87f3a66c

Thank you for the merge

Though, I noticed a few documentation hicups:

• https://docs.gitlab.com/ce/api/snippets.html

the comment at the top is not parsed as a link (for the version introduction)

• https://docs.gitlab.com/ce/api/README.html#resources

it's missing in the list of resources. Maybe it's worth opening a new issue, but until then, I'm reopening here.

reopened

@guyzmo thanks! Please do open a new issue - the feature has been implemented, we just need to fix the docs. (Also, feel free to submit an MR if you have the time )

closed

removed milestone

added devopsplan label

changed the description

removed time estimate

added Category:Source Code Management snippets labels and removed 1 deleted label