Resources

Resources #

Example configuration of a custom User resource with extensions:

"%custom":
  universalid:
    # Resources
    resources: [
      {
        id: "custom-user",
        name: "customUser",
        description: "A minimal user example",
        endpoint: "customUsers",
        schema: "urn:se:universalid:User",
        schemaExtensions: [
          {
            schema: "urn:se:universalid:extension:Device",
            required: false
          },
          {
            schema: "urn:se:universalid:extension:Computer",
            required: false
          }
        ]
      }
    ]

id #

A unique id for this schema. It is usually similar to name but without spaces or special formatting.

name #

The name of this User resource.

description #

A description of the User resource type.

endpoint #

This sets the path after the hostname which this resource is going to be served.

schema #

The resource core schema.

schemaExtensions #

The resource schema extensions.