Recipes

Update a Recipe

Update a recipe (must have contribute permission)

put/recipes/{owner}/{name}

Request

Base URL
https://api.pollination.solutions (the document declares no server; this is the origin it was published from)
Auth
- HTTP bearer
- or API key in header x-pollination-token
TypeScript
https://skmtc.dev/pollination/apis/pollination-server/docs/recipes/:owner/:name/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

ownerstring required

namestring required

Request body

publicboolean

Whether or not a repository is publicly viewable

keywordsstring[]

A list of keywords to index the repository by

descriptionstring

A description of the repository

iconstring

An icon to represent this repository

Example request

{
  "keywords": [
    "daylight",
    "radiance"
  ],
  "description": "Run daylight simulations the easy way!",
  "icon": "https://avatars1.githubusercontent.com/u/38131342"
}

Response

Accepted

statusstring

Changes

No recorded changes to this operation across all 1 revision of this API.