Get Schema - Crego APIs

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

name

string

required

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

A versatile JSON Schema definition with metadata for describing object properties.

title

string

Schema Title

optional

The human-readable title of the schema.

>= 1 characters

Examples:

Product SchemaUser Information Schema

description

string

Schema Description

optional

A detailed description providing context or purpose for the schema.

>= 1 characters

Examples:

Schema for defining product details.Schema for capturing user information.

type

enum<string>

Schema Type

required

The type of data structure represented by the schema.

Allowed values:

objectarraystringnumberbooleannull

Example:

object

properties

object

Properties

optional

Defines the structure and constraints of properties for an object schema.

Example:

{"name":{"type":"string","description":"User's full name"},"age":{"type":"integer","description":"User's age in years"}}

Additional properties

object

optional

Property definitions following the JSON Schema standard.

required

array[string]

Required Fields

optional

An array specifying the properties that are mandatory in the object.

Example:

["name","age"]

enum

array[string]

Enumeration

optional

Defines a set of permissible values for the schema.

>= 1 items

Example:

["value1","value2","value3"]

$schema

string

Schema Version

optional

The version of the JSON Schema draft being used.

Example:

http://json-schema.org/draft-07/schema#

Example

{
    "title": "Product Schema",
    "description": "Schema for defining product details.",
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "User's full name"
        },
        "age": {
            "type": "integer",
            "description": "User's age in years"
        }
    },
    "required": [
        "name",
        "age"
    ],
    "enum": [
        "value1",
        "value2",
        "value3"
    ],
    "$schema": "http://json-schema.org/draft-07/schema#"
}