openapi: 3.2.0
info:
version: 1.0.0
title: Events Calendar REST Tags API
description: The Events Calendar REST API allows accessing upcoming events information easily and conveniently.
servers:
- url: https://unclenearest.com/wp-json/tribe/events/v1/
tags:
- name: Tags
paths:
/tags:
get:
parameters:
- in: query
schema:
type: integer
description: The archive page to return
required: false
name: page
- in: query
schema:
type: integer
description: The number of event tags to return on each page
required: false
name: per_page
- in: query
schema:
type: string
description: Limit results to those matching a string
required: false
name: search
- in: query
schema:
type: array
items:
type: integer
description: Ensure result set exclude specific IDs
required: false
name: exclude
- in: query
schema:
type: array
items:
type: integer
description: Limit result set to specific IDs
required: false
name: include
- in: query
schema:
type: string
description: Order sort attribute ascending or descending
required: false
name: order
- in: query
schema:
type: string
description: Sort collection by term attribute
required: false
name: orderby
- in: query
schema:
type: boolean
description: Whether to hide terms not assigned to any posts
required: false
name: hide_empty
- in: query
schema:
type: integer
description: Limit result set to terms assigned to a specific post
required: false
name: post
- in: query
schema:
type: integer
description: Limit result set to terms assigned to a specific event (an alias of the "post" parameter)
required: false
name: event
- in: query
schema:
type: string
description: Limit result set to terms with a specific slug
required: false
name: slug
responses:
'200':
description: Returns all the event tags matching the search criteria
content:
application/json:
schema:
title: tags
type: array
items:
$ref: '#/components/schemas/Term'
'400':
description: One or more of the specified query variables has a bad format
'404':
description: No event tags match the query or the requested page was not found.
tags:
- Tags
/tags/{id}:
get:
parameters:
- in: path
schema:
type: integer
description: the event tag term ID
required: true
name: id
responses:
'200':
description: Returns the data of the event tag with the specified term ID
content:
application/json:
schema:
$ref: '#/components/schemas/Term'
'400':
description: The event tag term ID is missing.
'404':
description: An event tag with the specified term ID does not exist.
tags:
- Tags
post:
parameters:
- in: path
schema:
type: integer
description: the event tag term ID
required: true
name: id
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
description: The event tag name
type: string
description:
description: The event tag description
type: string
slug:
description: The event tag slug
type: string
responses:
'200':
description: Returns the data of the updated event tag
content:
application/json:
schema:
$ref: '#/components/schemas/Term'
'201':
description: Returns the data of the created event tag
content:
application/json:
schema:
$ref: '#/components/schemas/Term'
'400':
description: A required parameter is missing or an input parameter is in the wrong format
'403':
description: The user is not authorized to create event tags
tags:
- Tags
delete:
parameters:
- in: path
schema:
type: integer
description: the event tag term ID
required: true
name: id
responses:
'200':
description: Deletes an event tag and returns its data
content:
application/json:
schema:
$ref: '#/components/schemas/Term'
'400':
description: The event tag term ID is missing or does not exist.
'403':
description: The current user cannot delete the event tag with the specified term ID.
'410':
description: The event tag with the specified term ID has been deleted already.
'500':
description: The event tag with the specified term ID could not be deleted.
tags:
- Tags
components:
schemas:
Term:
type: object
properties:
id:
type: integer
description: The WordPress term ID
name:
type: string
description: The term name
slug:
type: string
description: The term slug
taxonomy:
type: string
description: The taxonomy the term belongs to
description:
type: string
description: The term description
parent:
type: integer
description: The term parent term if any
count:
type: integer
description: The number of posts associated with the term
url:
type: string
description: The URL to the term archive page
urls:
type: array
items:
type: string
description: A list of links to the term own, archive and parent REST URL