Create a rule

Create a rule in a namespace.

Path Parameters

namespace
Type: string
required

Body

required

application/json

document
Type: string
required
slug
Type: string
required
title
Type: string
required
description
Type: string
isPrivate
Type: boolean

Responses

application/json
application/json
application/json
application/json
application/json
application/json
application/json

post/v1/rulesets/{namespace}

import Scalar from '@scalar/sdk';

const client = new Scalar({
  bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var
});

const uid = await client.rules.createRuleset('acme', {
  title: 'Acme API Rules',
  slug: 'acme-rules',
  document: 'extends: ["spectral:oas"]\nrules:\n  info-contact: warn\n',
});

console.log(uid);

Show Schema

{
  "uid": "UakgbKJ5m9gl0JDMbcJqL"
}

Default Response

List all rules

Update rule metadata