| Code Block | ||
|---|---|---|
| ||
{
"openapi" : "3.0.1",
"info" : {
"title" : "CreateCalendar",
"description" : "Create a Calendar in AddEvent.com",
"version" : "1.0"
},
"servers" : [ {
"url" : "https://www.addevent.com"
} ],
"paths" : {
"/api/v1/me/calendars/create/" : {
"post" : {
"description" : "Auto generated using Swagger Inspector",
"parameters" : [ {
"name" : "template_embed_id",
"in" : "query",
"schema" : {
"type" : "string"
},
"example" : "XXXXXXXX"
}, {
"name" : "timezone",
"in" : "query",
"schema" : {
"type" : "string"
},
"example" : "Australia%2FSydney"
}, {
"name" : "palette_id",
"in" : "query",
"schema" : {
"type" : "string"
},
"example" : "XXXXXX"
}, {
"name" : "description",
"in" : "query",
"schema" : {
"type" : "string"
},
"example" : "A%20Calendar%20Dsecription"
}, {
"name" : "weekday_begin",
"in" : "query",
"schema" : {
"type" : "string"
},
"example" : "1"
}, {
"name" : "template_id",
"in" : "query",
"schema" : {
"type" : "string"
},
"example" : "XXXXXXXXX"
}, {
"name" : "title",
"in" : "query",
"schema" : {
"type" : "string"
},
"example" : "An%20Example%20Calendar"
}, {
"name" : "custom_data",
"in" : "query",
"schema" : {
"type" : "string"
},
"example" : "%7B%22bannerimage%22%3A%22http%3A%2F%2Fplacekitten.com%2F200%2F300%22%7D"
}, {
"name" : "calendar_color",
"in" : "query",
"schema" : {
"type" : "string"
},
"example" : "1"
}, {
"name" : "token",
"in" : "query",
"schema" : {
"type" : "string"
},
"example" : "apiXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
} ],
"responses" : {
"200" : {
"description" : "Auto generated using Swagger Inspector",
"content" : {
"application/json;charset=utf-8" : {
"schema" : {
"type" : "string"
},
"examples" : { }
}
}
}
},
"servers" : [ {
"url" : "https://www.addevent.com"
} ]
},
"servers" : [ {
"url" : "https://www.addevent.com"
} ]
}
}
} |
That is OpenAPI 3 example that should be available in Spring '22.
Here is the OpenAPI 2 example
| Code Block |
|---|
{
"swagger" : "2.0",
"info" : {
"description" : "defaultDescription",
"version" : "1.0",
"title" : "defaultTitle"
},
"paths" : {
"/api/v1/me/calendars/create/" : {
"post" : {
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "template_embed_id",
"in" : "query",
"required" : false,
"type" : "string",
"x-example" : "viklYMTc2564"
}, {
"name" : "timezone",
"in" : "query",
"required" : false,
"type" : "string",
"x-example" : "Australia/Sydney"
}, {
"name" : "palette_id",
"in" : "query",
"required" : false,
"type" : "string",
"x-example" : "bFjvD651"
}, {
"name" : "description",
"in" : "query",
"required" : false,
"type" : "string",
"x-example" : "A Calendar Dsecription"
}, {
"name" : "weekday_begin",
"in" : "query",
"required" : false,
"type" : "string",
"x-example" : "1"
}, {
"name" : "template_id",
"in" : "query",
"required" : false,
"type" : "string",
"x-example" : "JCFUZkxd3375"
}, {
"name" : "title",
"in" : "query",
"required" : false,
"type" : "string",
"x-example" : "Calendar Via API with Custom Data5"
}, {
"name" : "custom_data",
"in" : "query",
"required" : false,
"type" : "string",
"x-example" : "{\"bannerimage\":\"https://ayers--c.ap4.content.force.com/servlet/servlet.ImageServer"
}, {
"name" : "calendar_color",
"in" : "query",
"required" : false,
"type" : "string",
"x-example" : "1"
}, {
"name" : "token",
"in" : "query",
"required" : false,
"type" : "string",
"x-example" : "api1617001204OR97KfbgsXMJSIQG2oFt115671"
} ],
"responses" : {
"200" : {
"description" : "Definition generated from Swagger Inspector",
"schema" : {
"$ref" : "#/definitions/Model0"
}
}
}
}
}
},
"definitions" : {
"Meta" : {
"properties" : {
"code" : {
"type" : "string"
}
}
},
"Calendar" : {
"properties" : {
"id" : {
"type" : "string"
},
"uniquekey" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"timezone" : {
"type" : "string"
},
"weekday_begin" : {
"type" : "string"
},
"calendar_color" : {
"type" : "string"
},
"palette_id" : {
"type" : "string"
},
"followers_active" : {
"type" : "string"
},
"followers_total" : {
"type" : "string"
},
"events_total" : {
"type" : "string"
},
"custom_data" : {
"type" : "string"
},
"template_id" : {
"type" : "string"
},
"template_embed_id" : {
"type" : "string"
},
"link_short" : {
"type" : "string"
},
"link_long" : {
"type" : "string"
},
"date_create" : {
"type" : "integer",
"format" : "int32"
},
"date_modified" : {
"type" : "integer",
"format" : "int32"
}
}
},
"Model0" : {
"properties" : {
"meta" : {
"$ref" : "#/definitions/Meta"
},
"calendar" : {
"$ref" : "#/definitions/Calendar"
}
}
}
}
} |