Request for new API endpoints

[SamwittwerVBZ]

Hi there!

Ricochet version v0.15.0-f9f4ebcc

I'm currently working on API wrappers for an internal R package. Thank you for the thorough documentation and the code snippets in there, very useful. So far it all works smoothly, however, I wasn't able to find endpoints for the following tasks in the API docs:

• Is there an endpoint to deploy a new item off of gitlab
• Is there a way to see and manage items of other users via API if you are an admin?
• Is there a dedicated endpoint to supply environmental variables to a deployment or change them? I expected something in /api/v0/content/{ulid}/settings but didn't find anything there sadly

Cheers,
Sam

[pat-s]

Thanks for reaching out! The API still has a lot of potential for improvement, so your questions are very valid 🙏
With this being said, there's already a lot you can do directly through the CLI - did you have a look at it yet?

Is there an endpoint to deploy a new item off of gitlab

You mean via the Git deploy option? This is only possible via the UI right now.

But I see the need for it when adding many repos in batch that should be connected to the Git deploy feature. It won't be scoped to GL but will likely have a generic param to input the Git URL.

Tracking issue: ricochet-rs/cli#184

Is there a way to see and manage items of other users via API if you are an admin?

/user/items should return all items of the instance if your admin, judging by it's description: "Returns an array of all content items that the user either owns, is an admin, editor, or contributor of."

If this doesn't work right now, we need to fix this. If it works, it should likely get a param to only list private items resp. the ones gated to specific roles instead of all items on the instance.

CLI option: ricochet app list -h

Tracking issue: ricochet-rs/cli#186

Is there a dedicated endpoint to supply environmental variables to a deployment or change them? I expected something in /api/v0/content/{ulid}/settings but didn't find anything there sadly

Not yet but we should definitely add this endpoint!

The CLI should already be able to do that though: ricochet app settings update -h.
Turns out it doesn't yet, see ricochet-rs/cli#185 for tracking

[JosiahParry]

Thank you for the thoughtful feedback! Give us a couple of weeks and I think we can address them individually