Sign in
Recipes

Update a Recipe

Changed on

Update a recipe (must have contribute permission)

put/recipes/{owner}/{name}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in header x-pollination-token

Path parameters

ownerstring required
namestring required

Request body

typestring

A base class to use when there is no baseclass available to fall on.

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

typestring

A base class to use when there is no baseclass available to fall on.

statusstring

Changes

  • e25504ef9dccRevision changes
    • breaking

      response property detail/items/loc/items/ list-of-types was widened by adding types integer to media type application/json of response 422

  • be42c3cf5190Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status