Metadata Directives

Metadata Directives

Metadata directives help you organize, identify, and categorize your requests.

@name — Request Name

Give a human-readable name to any request:

@name Get Users
GET https://api.example.com/users

The name appears in the sidebar, code lenses, and response panel.

@id — Unique Identifier

A 6-character alphanumeric ID for referencing requests in @pre chains.

@id abc123
@name Login
POST https://api.example.com/auth/login

Tip

IDs are auto-generated when you save the file if not already present. You can also write them manually.

@collection — Group into Collections

Organize requests into named collections:

@collection Auth API
@name Login
POST https://api.example.com/auth/login

Collections appear as groups in the Rext sidebar.

@group — Sub-grouping

Create sub-groups within collections using / separators for nested levels:

@collection Auth API
@group Users / Admin
@name Create Admin
POST https://api.example.com/admin/users

This creates the hierarchy: Auth API → Users → Admin → Create Admin

@tags — Filtering Tags

Add comma-separated tags for filtering:

@tags auth, critical, v2
@name Login
POST https://api.example.com/auth/login

@deprecated — Mark as Obsolete

Mark a request as deprecated. It will display with a visual indicator:

@deprecated
@name Old Login
POST https://api.example.com/v1/login

Complete Example

@collection Auth API
@group Users / Admin
@tags auth, admin, critical
@id x9k2m1
@name Create Admin User
POST https://api.example.com/admin/users
Content-Type: application/json

{
  "name": "Admin",
  "role": "admin"
}

Next Steps

• Learn about @query and @body directives
• Explore shared configuration with @config