Create a resource and its first revision

POST

/api/v1/resources

const url = 'https://example.com/api/v1/resources?projectId=00000000-0000-0000-0000-000000000000';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"name":"example","slug":"example","description":"example","setup":{"sh":"example"},"teardown":{"sh":"example"},"exports":["example"],"parameters":[{"name":"example","description":"example","required":false,"default":"example","example":"example"}],"creator":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url 'https://example.com/api/v1/resources?projectId=00000000-0000-0000-0000-000000000000' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "slug": "example", "description": "example", "setup": { "sh": "example" }, "teardown": { "sh": "example" }, "exports": [ "example" ], "parameters": [ { "name": "example", "description": "example", "required": false, "default": "example", "example": "example" } ], "creator": "example" }'

Parameters

Query Parameters

projectId

required

Project scope. Required on scoped list and root-create operations; requests without a resolvable project are rejected with 400. There is no default project.

string

>= 1 characters

Example

00000000-0000-0000-0000-000000000000

Project scope. Required on scoped list and root-create operations; requests without a resolvable project are rejected with 400. There is no default project.

Request Body

application/json

object

name

required

string

>= 1 characters

slug

string

>= 1 characters

description

string

setup

required

object

string

>= 1 characters

teardown

object

string

>= 1 characters

exports

Array<string>

parameters

Array<object>

object

name

required

string

/^[A-Za-z_][A-Za-z0-9_]*$/

description

string

required

boolean

default

string

example

string

creator

string

Responses

201

Success

400

Invalid input

409

Resource slug or revision ref already exists in this project