{ "openapi" : "3.0.3", "info" : { "title" : "KoF22 Site API", "description" : "The public API of [kof22.com](https://www.kof22.com): read the site's published content, search it, subscribe to its feeds, send a message, and (for the site owner's apps) publish posts.\n\n## Overview\n\n- **Base URL:** `https://api.kof22.com/v1`. Every path below is relative to it.\n- **Format:** JSON (UTF-8). Feeds are XML or JSON Feed; the sitemap is XML.\n- **Reads are anonymous.** No key, no cookie. Only published and active records are visible; drafts, private fields (author email, photo GPS, storage keys, unprocessed originals) and internal tables are never reachable.\n- **Writes:** `POST /contact` is anonymous and abuse-guarded. Authoring endpoints (`/me/...`) need an OAuth2 bearer token from the KoF22 identity provider (see *Authentication*).\n\n## Quick start\n\n```bash\n# the five newest Field Notes posts\ncurl \"https://api.kof22.com/v1/blog/query?slug=quick-bits\"\ncurl \"https://api.kof22.com/v1/post/query?blogId=1&orderBy=publishDate%20desc&pageSize=5\"\n\n# one post, with its tag links and photos nested\ncurl \"https://api.kof22.com/v1/post/42\"\n\n# search published content\ncurl \"https://api.kof22.com/v1/search?q=raspberry%20pi\"\n```\n\n## Resources\n\n| Resource | Path | Description |\n|----------|------|-------------|\n| `site` | `/site` | Site identity (name and description). |\n| `page` | `/page` | Published pages; sections are nested in `sections` (ordered by sortOrder). |\n| `pageSection` | nested | A content block inside a page. |\n| `sectionType` | `/sectionType` | Page section types (resolve `sectionTypeId` to a `code`). |\n| `blog` | `/blog` | Blogs (for example `quick-bits` Field Notes and `ideas-into-systems`). |\n| `post` | `/post` | Published posts; tag links in `tags`, ordered photos in `media`. |\n| `postTagLink` | nested | A tag applied to a post (resolve `tagId` with /tag). |\n| `postMedia` | nested | A photo attached to a post, in display order. |\n| `tag` | `/tag` | Blog tags. |\n| `author` | `/author` | Active authors (public profile only; never email). |\n| `menu` | `/menu` | Active navigation menus; items are nested in `items`. |\n| `menuItem` | nested | An active navigation item (tree via `parentId`). |\n| `media` | `/media` | Active media assets with public rendition URLs. |\n| `mediaType` | `/mediaType` | Media types. |\n| `photo` | `/photo` | Published photos (renditions and camera EXIF; never GPS or the unprocessed original). |\n| `photoTagLink` | nested | A tag applied to a photo (resolve `tagId` with /photoTag). |\n| `photoTag` | `/photoTag` | Photo tags. |\n| `album` | `/album` | Published photo albums. |\n| `albumFolder` | `/albumFolder` | Published album folders (tree via `parentId`). |\n| `project` | `/project` | Published projects. |\n| `projectCategory` | `/projectCategory` | Published project categories (SOFTWARE or PERSONAL section). |\n| `projectUpdate` | `/projectUpdate` | Published project updates (journal entries). |\n| `redirect` | `/redirect` | Active URL redirects for the website. |\n| `redirectType` | `/redirectType` | Redirect types (HTTP status per type). |\n| `snippet` | `/snippet` | Active reusable content snippets (looked up by `shortName`). |\n| `stream` | `/stream` | The public activity stream: posts, projects, updates, albums and photos, newest first. |\n\n\nNested resources (`sections`, `items`, `tags`, `media`) are returned inside their parent and have no endpoints of their own.\n\n## Querying\n\nEvery resource has `GET /{resource}/{id}` and `GET /{resource}/query`.\n\n| Parameter | Meaning |\n|-----------|---------|\n| `field=value` | Filter on any listed field (equals). |\n| `field=!value` | Not equal. Prefix `!` also negates `IN`, `LIKE`, `BETWEEN` and `EMPTY`. |\n| `field=>=2026-01-01T00:00:00Z` | Also `<=`, `<`, `>`. |\n| `field=IN 1,2,3` / `field=BETWEEN a,b` | Lists and ranges. |\n| `field=LIKE %pi%` / `field=EMPTY` | Pattern match / null or blank. |\n| `booleanOperator=OR` | Combine filters with OR (default AND). |\n| `orderBy=publishDate desc,id desc` | Sort (comma-separated). |\n| `pageNo` / `pageSize` | Paging: `pageSize` 1 to 1000, default 50. |\n| `includeCount=true` | Adds the total `count` to the response. |\n\nQuery responses look like `{\"records\":[...],\"count\":123,\"pageNo\":1,\"pageSize\":50}`.\n\n## Search\n\n`GET /search?q=term` searches published posts, pages, projects, albums and photos (OpenSearch-backed, re-checked against the database so only public records come back). Optional `type=post,page,project,album,photo` and `limit` (1-50, default 20). Each result has `type`, `id`, `title`, `url` (on www.kof22.com), `snippet` and `score`.\n\n## Feeds and sitemap\n\n| Feed | Path |\n|------|------|\n| RSS 2.0 | `/feeds/{blogSlug}/rss.xml` |\n| Atom 1.0 | `/feeds/{blogSlug}/atom.xml` |\n| JSON Feed 1.1 | `/feeds/{blogSlug}/feed.json` |\n| Sitemap | `/sitemap.xml` (every public URL on www.kof22.com) |\n\nFeeds carry the 50 newest published posts of a blog and are cached for five minutes.\n\n## Contact\n\n`POST /contact` with `{\"name\",\"email\",\"subject\",\"message\"}` sends a message to the site owner. It is validated server-side, rate limited, and protected by a honeypot field (`website`, leave it empty) and a minimum fill time (`startedAt`, the epoch milliseconds when your form was shown). No third-party captcha. Success is `202 Accepted`.\n\n## Authentication\n\nReads and `/contact` need nothing. The authoring endpoints (`/me`, `/me/posts`, `/me/uploads`, `/me/tags`, `/me/link-preview`) require `Authorization: Bearer ` issued by the KoF22 Authentik provider for the **KoF22 Post** app (OAuth2 Authorization Code with PKCE, public client `kof22-post-ios`, scopes `openid profile email offline_access kof22:publish`). The token must carry the `kof22:publish` grant and the user must be a site publisher; otherwise the API answers `401` (missing or invalid token) or `403` (not allowed).\n\n| Endpoint | URL |\n|----------|-----|\n| Authorize | `https://auth.kof22.com/application/o/authorize/` |\n| Token | `https://auth.kof22.com/application/o/token/` |\n| Revoke | `https://auth.kof22.com/application/o/revoke/` |\n| User info | `https://auth.kof22.com/application/o/userinfo/` |\n| Issuer / JWKS | `https://auth.kof22.com/application/o/kof22-post-ios/` (`jwks/`) |\n\nAccess tokens last 30 minutes; refresh tokens (granted with `offline_access`) last 90 days.\n\n## Authoring (KoF22 Post)\n\n- `GET /me` - who am I, my author profile, and the blogs I can post to (default `quick-bits`).\n- `GET /me/posts` - my posts with `status` (`draft`, `scheduled`, `published`), cursor paginated.\n- `POST /me/posts` - create a draft, publish now, or schedule (`status`, `publishAt`).\n- `GET`, `PATCH`, `DELETE /me/posts/{id}` - read, update (needs `If-Match`), delete.\n- `POST /me/uploads` then `PUT` the bytes to the returned `uploadUrl`, then `POST /me/uploads/{uploadId}/complete` - photo upload. EXIF GPS is stripped unless `keepLocation` is true; renditions are generated.\n- `GET /me/tags?q=` - tag autocomplete. `POST /me/link-preview` - server-side link preview.\n\nWrites that create something accept an `Idempotency-Key` header (retry-safe: the same key and body replays the first response). Updates and deletes use `ETag` / `If-Match` (`412` on a stale version, `428` when missing on update). Publishing uses the same path as the CMS: audits, change events and search re-indexing happen as for Admin edits, and the website shows the post immediately.\n\n## iOS app setup (KoF22 Post)\n\n> **Status:** the `kof22-post-ios` Authentik client is being provisioned; until its discovery URL (`https://auth.kof22.com/application/o/kof22-post-ios/.well-known/openid-configuration`) resolves, sign-in returns errors.\n\n**Registered redirect URIs** (use one exactly; anything else is rejected by the identity provider):\n\n| Redirect URI | Kind | Notes |\n|--------------|------|-------|\n| `com.kof22.post://oauth/callback` | Custom URL scheme | v1 of the app. Register the `com.kof22.post` scheme in the app's `Info.plist`. |\n| `https://api.kof22.com/oauth/ios-callback` | Universal link | Needs the app's Associated Domains entitlement (`applinks:api.kof22.com`) and [`/.well-known/apple-app-site-association`](https://api.kof22.com/.well-known/apple-app-site-association), which is served only once the Apple Team ID is configured on the server via `SITE_API_IOS_APP_IDS` (e.g. `TEAMID.com.kof22.post`); until then it returns `404`. If iOS does not hand the link to the app, the page offers the `com.kof22.post://oauth/callback` link with the same query. |\n\n**Sign-in flow**\n\n1. Generate a PKCE `code_verifier` (43-128 random URL-safe characters) and send `code_challenge = BASE64URL(SHA256(verifier))` with `code_challenge_method=S256` (plain is not accepted). Also send a random, single-use `state` and reject any callback whose `state` does not match.\n2. Open the *Authorize* URL in an `ASWebAuthenticationSession` (not a `WKWebView` or an embedded browser) with `callbackURLScheme` `com.kof22.post` (or, on iOS 17.4+, a `.https(host: \"api.kof22.com\", path: \"/oauth/ios-callback\")` callback). Set `prefersEphemeralWebBrowserSession` as you prefer and a `presentationContextProvider`.\n3. Exchange the returned `code` at the *Token* endpoint with `grant_type=authorization_code`, the same `redirect_uri`, `client_id=kof22-post-ios` and the `code_verifier`. It is a public client: no client secret ships in the app.\n4. Keep the access and refresh tokens in the Keychain; refresh with `grant_type=refresh_token` before the 30-minute access token expires, and revoke on sign-out.\n\n**Bearer tokens are only for the `/me` endpoints.** Send `Authorization: Bearer ` to `/me` and `/me/...` only; every other endpoint is anonymous and ignores it, so do not attach tokens to content, search or feed requests.\n\n## Errors\n\nEvery error has the same JSON envelope:\n\n```json\n{\"error\": {\"code\": \"validation_failed\", \"message\": \"title is too long\", \"status\": 422,\n \"details\": [{\"field\": \"title\", \"issue\": \"max 100 characters\"}]}}\n```\n\n| Status | Meaning |\n|--------|---------|\n| `400` | Malformed request or query. |\n| `401` | Missing, expired or invalid bearer token. |\n| `403` | Authenticated but not allowed (scope or group). |\n| `404` | Not found, or not public. |\n| `409` | Conflict (for example an Idempotency-Key still in flight, or a duplicate slug). |\n| `412` / `428` | Stale or missing `If-Match` on update. |\n| `413` | Upload or body too large. |\n| `415` | Unsupported media type. |\n| `422` | Validation failed. |\n| `429` | Rate limited; honour `Retry-After`. |\n\n## Rate limits\n\nLimits are enforced at the edge (Traefik) and again in the application. Today the edge limits are **aggregate per host** (30 requests per second with bursts of 120 for the whole API, and 10 contact submissions per minute) because the ingress does not yet see real client IPs; per-client limits will replace them without a contract change. The application additionally limits contact submissions and authoring calls per client and per user. A `429` always carries `Retry-After`. Please cache: reads change rarely.\n\n## Versioning\n\nThe **major** version is in the path (`/v1`). The full **semantic version** of the contract is in the OpenAPI `info.version` and in [`/versions.json`](https://api.kof22.com/versions.json):\n\n- **Patch** (1.0.x): fixes and documentation, no contract change.\n- **Minor** (1.x.0): additive only (new resources, fields, endpoints or optional parameters). Clients must ignore unknown fields.\n- **Major** (`/v2`): any breaking change. `/v1` then stays available with `Deprecation` and `Sunset` headers before removal.\n\n### Changelog\n\n**1.1.0** (2026-10-11)\n\n- Documentation: iOS app setup (KoF22 Post) - registered redirect URIs, PKCE S256 and state, ASWebAuthenticationSession, bearer tokens for /me only.\n\n**1.0.0** (2026-10-11)\n\n- First release of the KoF22 Site API at https://api.kof22.com/v1.\n- Curated read resources with nested associations (published and active records only).\n- Search, contact form, RSS/Atom/JSON feeds per blog and sitemap.xml.\n- Authoring for the KoF22 Post iOS app: quick posts, photo uploads, tags, link previews (OAuth2 PKCE).\n- Replaces /public-api/v1, which is now deprecated (Deprecation and Sunset headers).\n\n\n\n### Deprecated: `/public-api/v1`\n\nThe old table-shaped API at `https://admin.kof22.com/public-api/v1` still works but is deprecated: its responses carry `Deprecation`, `Sunset` and a `Link` to this API. Move to `/v1` here; it will be removed after the sunset date.\n\n## Generating a client SDK\n\nThe spec is OpenAPI 3.0.3 at [`/v1/openapi.json`](https://api.kof22.com/v1/openapi.json) (and `openapi.yaml`). Every operation has a stable `operationId` and every schema is named, so generators produce clean code:\n\n```bash\n# Swift (swift-openapi-generator): put openapi.yaml next to openapi-generator-config.yaml\ncurl -o Sources/KoF22API/openapi.yaml https://api.kof22.com/v1/openapi.yaml\n\n# TypeScript\nnpx @openapitools/openapi-generator-cli generate -i https://api.kof22.com/v1/openapi.json -g typescript-fetch -o ./kof22-client\n\n# Python\nnpx @openapitools/openapi-generator-cli generate -i https://api.kof22.com/v1/openapi.json -g python -o ./kof22-client-python\n```\n\n## Support\n\nEmail **[james@kof22.com](mailto:james@kof22.com)** with the request path, the time (UTC), the HTTP status and the error body.\n", "contact" : { "email" : "james@kof22.com", "name" : "KoF22", "url" : "https://www.kof22.com" }, "version" : "1.1.0", "x-api-major-version" : "v1" }, "servers" : [ { "url" : "https://api.kof22.com", "description" : "Production" } ], "tags" : [ { "name" : "Discovery", "description" : "Versions and the OpenAPI document." }, { "name" : "Content", "description" : "Curated, published site content (anonymous)." }, { "name" : "Search", "description" : "Search published content." }, { "name" : "Feeds", "description" : "RSS, Atom, JSON Feed and sitemap." }, { "name" : "Contact", "description" : "Message the site owner." }, { "name" : "Authoring", "description" : "Publishing for the KoF22 Post app (OAuth2 PKCE)." } ], "paths" : { "/v1/author/query" : { "get" : { "summary" : "Search for Author records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryAuthor", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "descriptionAndName" : { "summary" : "order by description, then by name (both ascending)", "value" : "description, name" }, "profileImageUrlAndProfileMediaIdAndShortName" : { "summary" : "order by profileImageUrl descending, then by profileMediaId ascending, then by shortName", "value" : "profileImageUrl DESC, profileMediaId ASC, shortName" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "description", "description" : "Query on the Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "profileImageUrl", "description" : "Query on the Profile Image Url field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "profileMediaId", "description" : "Query on the Profile Media field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "shortName", "description" : "Query on the Short Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "slug", "description" : "Query on the Slug field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "socialLinks", "description" : "Query on the Social Links field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "website", "description" : "Query on the Website field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Author table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/authorSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/author/{id}" : { "get" : { "summary" : "Get one Author by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getAuthor", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Author to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Author record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Author", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/author" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/post/query" : { "get" : { "summary" : "Search for Blog Post records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryPost", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "authorIdAndBlogId" : { "summary" : "order by authorId, then by blogId (both ascending)", "value" : "authorId, blogId" }, "contentAndDescriptionAndExcerpt" : { "summary" : "order by content descending, then by description ascending, then by excerpt", "value" : "content DESC, description ASC, excerpt" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "authorId", "description" : "Query on the Author field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "blogId", "description" : "Query on the Blog field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "content", "description" : "Query on the Content field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "description", "description" : "Query on the Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "excerpt", "description" : "Query on the Excerpt field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "featuredImage", "description" : "Query on the Featured Image URL field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "featuredMediaId", "description" : "Query on the Featured Media field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "isFeatured", "description" : "Query on the Is Featured field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaBooleanEquals" : { "$ref" : "#/components/examples/criteriaBooleanEquals" }, "criteriaBooleanNotEquals" : { "$ref" : "#/components/examples/criteriaBooleanNotEquals" }, "criteriaBooleanEmpty" : { "$ref" : "#/components/examples/criteriaBooleanEmpty" }, "criteriaBooleanNotEmpty" : { "$ref" : "#/components/examples/criteriaBooleanNotEmpty" } } }, { "name" : "linkDescription", "description" : "Query on the Link Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "linkImageUrl", "description" : "Query on the Link Image URL field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "linkTitle", "description" : "Query on the Link Title field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "linkUrl", "description" : "Query on the Link URL field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "locationLabel", "description" : "Query on the Location field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "metaDescription", "description" : "Query on the Meta Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "metaKeywords", "description" : "Query on the Meta Keywords field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "metaTitle", "description" : "Query on the Meta Title field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "modifyDate", "description" : "Query on the Modify Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "publishDate", "description" : "Query on the Publish Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "readTime", "description" : "Query on the Read Time field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "slug", "description" : "Query on the Slug field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "title", "description" : "Query on the Title field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Blog Post table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/postSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/post/{id}" : { "get" : { "summary" : "Get one Blog Post by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getPost", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Blog Post to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Blog Post record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Blog Post", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/post" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/blog/query" : { "get" : { "summary" : "Search for Blogs records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryBlog", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "descriptionAndMetaDescription" : { "summary" : "order by description, then by metaDescription (both ascending)", "value" : "description, metaDescription" }, "metaKeywordsAndMetaTitleAndModifyDate" : { "summary" : "order by metaKeywords descending, then by metaTitle ascending, then by modifyDate", "value" : "metaKeywords DESC, metaTitle ASC, modifyDate" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "description", "description" : "Query on the Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "metaDescription", "description" : "Query on the Meta Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "metaKeywords", "description" : "Query on the Meta Keywords field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "metaTitle", "description" : "Query on the Meta Title field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "modifyDate", "description" : "Query on the Modify Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "shortName", "description" : "Query on the Short Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "slug", "description" : "Query on the Slug field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Blogs table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/blogSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/blog/{id}" : { "get" : { "summary" : "Get one Blogs by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getBlog", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Blogs to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Blogs record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Blogs", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/blog" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/stream/query" : { "get" : { "summary" : "Search for Content Stream records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryStream", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "contextLabelAndImageUrl" : { "summary" : "order by contextLabel, then by imageUrl (both ascending)", "value" : "contextLabel, imageUrl" }, "kindAndPublishedAtAndSummary" : { "summary" : "order by kind descending, then by publishedAt ascending, then by summary", "value" : "kind DESC, publishedAt ASC, summary" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "contextLabel", "description" : "Query on the Context Label field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "imageUrl", "description" : "Query on the Image Url field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "kind", "description" : "Query on the Kind field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "publishedAt", "description" : "Query on the Published At field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "summary", "description" : "Query on the Summary field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "title", "description" : "Query on the Title field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "url", "description" : "Query on the Url field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Content Stream table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/streamSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/stream/{id}" : { "get" : { "summary" : "Get one Content Stream by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getStream", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Content Stream to get.", "required" : true, "in" : "path", "schema" : { "type" : "string" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Content Stream record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Content Stream", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/stream" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/media/query" : { "get" : { "summary" : "Search for Media records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryMedia", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "descriptionAndDuration" : { "summary" : "order by description, then by duration (both ascending)", "value" : "description, duration" }, "fileExtensionAndFileSizeAndGalleryUrl" : { "summary" : "order by fileExtension descending, then by fileSize ascending, then by galleryUrl", "value" : "fileExtension DESC, fileSize ASC, galleryUrl" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "description", "description" : "Query on the Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "duration", "description" : "Query on the Duration field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "fileExtension", "description" : "Query on the File Extension field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "fileSize", "description" : "Query on the File Size field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "galleryUrl", "description" : "Query on the Gallery Url field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "height", "description" : "Query on the Height field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "mediaTypeId", "description" : "Query on the Media Type field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "mimeType", "description" : "Query on the Mime Type field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "modifyDate", "description" : "Query on the Modify Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "publicUrl", "description" : "Query on the Public Url field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "slideshowUrl", "description" : "Query on the Slideshow Url field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "slug", "description" : "Query on the Slug field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "thumbnailUrl", "description" : "Query on the Thumbnail Url field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "width", "description" : "Query on the Width field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Media table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/mediaSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/media/{id}" : { "get" : { "summary" : "Get one Media by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getMedia", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Media to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Media record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Media", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/media" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/mediaType/query" : { "get" : { "summary" : "Search for Media Types records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryMediaType", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "codeAndDescription" : { "summary" : "order by code, then by description (both ascending)", "value" : "code, description" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "code", "description" : "Query on the Code field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "description", "description" : "Query on the Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Media Types table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/mediaTypeSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/mediaType/{id}" : { "get" : { "summary" : "Get one Media Types by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getMediaType", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Media Types to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Media Types record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Media Types", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/mediaType" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/menu/query" : { "get" : { "summary" : "Search for Menus records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryMenu", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "descriptionAndMenuType" : { "summary" : "order by description, then by menuType (both ascending)", "value" : "description, menuType" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "description", "description" : "Query on the Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "menuType", "description" : "Query on the Menu Type field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "slug", "description" : "Query on the Slug field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Menus table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/menuSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/menu/{id}" : { "get" : { "summary" : "Get one Menus by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getMenu", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Menus to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Menus record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Menus", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/menu" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/sectionType/query" : { "get" : { "summary" : "Search for Page Section Types records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "querySectionType", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "codeAndDescription" : { "summary" : "order by code, then by description (both ascending)", "value" : "code, description" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "code", "description" : "Query on the Code field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "description", "description" : "Query on the Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "sortOrder", "description" : "Query on the Sort Order field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Page Section Types table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/sectionTypeSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/sectionType/{id}" : { "get" : { "summary" : "Get one Page Section Types by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getSectionType", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Page Section Types to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Page Section Types record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Page Section Types", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/sectionType" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/page/query" : { "get" : { "summary" : "Search for Pages records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryPage", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "contentAndFeaturedImage" : { "summary" : "order by content, then by featuredImage (both ascending)", "value" : "content, featuredImage" }, "featuredMediaIdAndImageAltAndImageCaption" : { "summary" : "order by featuredMediaId descending, then by imageAlt ascending, then by imageCaption", "value" : "featuredMediaId DESC, imageAlt ASC, imageCaption" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "content", "description" : "Query on the Content field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "featuredImage", "description" : "Query on the Featured Image field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "featuredMediaId", "description" : "Query on the Featured Media field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "imageAlt", "description" : "Query on the Image Alt field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "imageCaption", "description" : "Query on the Image Caption field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "imageFocalX", "description" : "Query on the Image Focal X field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "imageFocalY", "description" : "Query on the Image Focal Y field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "metaDescription", "description" : "Query on the Meta Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "metaKeywords", "description" : "Query on the Meta Keywords field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "modifyDate", "description" : "Query on the Modify Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "ogImage", "description" : "Query on the Og Image field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "pageTypeId", "description" : "Query on the Page Type field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "parentPageId", "description" : "Query on the Parent Page field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "publishDate", "description" : "Query on the Publish Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "slug", "description" : "Query on the Slug field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "sortOrder", "description" : "Query on the Sort Order field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "template", "description" : "Query on the Template field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "title", "description" : "Query on the Title field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Pages table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/pageSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/page/{id}" : { "get" : { "summary" : "Get one Pages by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getPage", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Pages to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Pages record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Pages", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/page" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/photo/query" : { "get" : { "summary" : "Search for Photo records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryPhoto", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "captionAndDescription" : { "summary" : "order by caption, then by description (both ascending)", "value" : "caption, description" }, "exifApertureAndExifCameraMakeAndExifCameraModel" : { "summary" : "order by exifAperture descending, then by exifCameraMake ascending, then by exifCameraModel", "value" : "exifAperture DESC, exifCameraMake ASC, exifCameraModel" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "caption", "description" : "Query on the Caption field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "description", "description" : "Query on the Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "exifAperture", "description" : "Query on the Exif Aperture field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "exifCameraMake", "description" : "Query on the Exif Camera Make field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "exifCameraModel", "description" : "Query on the Exif Camera Model field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "exifDateTaken", "description" : "Query on the Exif Date Taken field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "exifFocalLength", "description" : "Query on the Exif Focal Length field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "exifIso", "description" : "Query on the Exif Iso field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "exifLensModel", "description" : "Query on the Exif Lens Model field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "exifShutterSpeed", "description" : "Query on the Exif Shutter Speed field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "galleryUrl", "description" : "Query on the Gallery Url field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "height", "description" : "Query on the Height field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "isAlbumCover", "description" : "Query on the Is Album Cover field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaBooleanEquals" : { "$ref" : "#/components/examples/criteriaBooleanEquals" }, "criteriaBooleanNotEquals" : { "$ref" : "#/components/examples/criteriaBooleanNotEquals" }, "criteriaBooleanEmpty" : { "$ref" : "#/components/examples/criteriaBooleanEmpty" }, "criteriaBooleanNotEmpty" : { "$ref" : "#/components/examples/criteriaBooleanNotEmpty" } } }, { "name" : "isFavorite", "description" : "Query on the Is Favorite field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaBooleanEquals" : { "$ref" : "#/components/examples/criteriaBooleanEquals" }, "criteriaBooleanNotEquals" : { "$ref" : "#/components/examples/criteriaBooleanNotEquals" }, "criteriaBooleanEmpty" : { "$ref" : "#/components/examples/criteriaBooleanEmpty" }, "criteriaBooleanNotEmpty" : { "$ref" : "#/components/examples/criteriaBooleanNotEmpty" } } }, { "name" : "mimeType", "description" : "Query on the Mime Type field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "albumId", "description" : "Query on the Photo Album field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "publishDate", "description" : "Query on the Publish Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "slideshowUrl", "description" : "Query on the Slideshow Url field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "slug", "description" : "Query on the Slug field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "sortOrder", "description" : "Query on the Sort Order field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "thumbnailUrl", "description" : "Query on the Thumbnail Url field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "title", "description" : "Query on the Title field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "width", "description" : "Query on the Width field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Photo table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/photoSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/photo/{id}" : { "get" : { "summary" : "Get one Photo by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getPhoto", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Photo to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Photo record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Photo", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/photo" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/album/query" : { "get" : { "summary" : "Search for Photo Album records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryAlbum", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "albumDateAndAlbumEndDate" : { "summary" : "order by albumDate, then by albumEndDate (both ascending)", "value" : "albumDate, albumEndDate" }, "coverImageUrlAndCoverPhotoIdAndDescription" : { "summary" : "order by coverImageUrl descending, then by coverPhotoId ascending, then by description", "value" : "coverImageUrl DESC, coverPhotoId ASC, description" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "albumDate", "description" : "Query on the Album Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "albumEndDate", "description" : "Query on the Album End Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "coverImageUrl", "description" : "Query on the Cover Image Url field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "coverPhotoId", "description" : "Query on the Cover Photo field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "description", "description" : "Query on the Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "location", "description" : "Query on the Location field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "metaDescription", "description" : "Query on the Meta Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "metaTitle", "description" : "Query on the Meta Title field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "folderId", "description" : "Query on the Photo Album Folder field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "primaryCamera", "description" : "Query on the Primary Camera field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "primaryLens", "description" : "Query on the Primary Lens field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "projectId", "description" : "Query on the Project field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "projectUpdateId", "description" : "Query on the Project Update field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "publishDate", "description" : "Query on the Publish Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "shortName", "description" : "Query on the Short Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "slug", "description" : "Query on the Slug field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "sortOrder", "description" : "Query on the Sort Order field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "title", "description" : "Query on the Title field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "weather", "description" : "Query on the Weather field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Photo Album table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/albumSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/album/{id}" : { "get" : { "summary" : "Get one Photo Album by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getAlbum", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Photo Album to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Photo Album record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Photo Album", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/album" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/albumFolder/query" : { "get" : { "summary" : "Search for Photo Album Folder records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryAlbumFolder", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "descriptionAndFolderImageUrl" : { "summary" : "order by description, then by folderImageUrl (both ascending)", "value" : "description, folderImageUrl" }, "metaDescriptionAndMetaTitleAndName" : { "summary" : "order by metaDescription descending, then by metaTitle ascending, then by name", "value" : "metaDescription DESC, metaTitle ASC, name" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "description", "description" : "Query on the Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "folderImageUrl", "description" : "Query on the Folder Image Url field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "metaDescription", "description" : "Query on the Meta Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "metaTitle", "description" : "Query on the Meta Title field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "parentId", "description" : "Query on the Parent field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "slug", "description" : "Query on the Slug field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "sortOrder", "description" : "Query on the Sort Order field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Photo Album Folder table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/albumFolderSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/albumFolder/{id}" : { "get" : { "summary" : "Get one Photo Album Folder by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getAlbumFolder", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Photo Album Folder to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Photo Album Folder record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Photo Album Folder", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/albumFolder" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/photoTag/query" : { "get" : { "summary" : "Search for Photo Tag records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryPhotoTag", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "descriptionAndName" : { "summary" : "order by description, then by name (both ascending)", "value" : "description, name" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "description", "description" : "Query on the Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "slug", "description" : "Query on the Slug field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Photo Tag table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/photoTagSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/photoTag/{id}" : { "get" : { "summary" : "Get one Photo Tag by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getPhotoTag", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Photo Tag to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Photo Tag record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Photo Tag", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/photoTag" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/projectCategory/query" : { "get" : { "summary" : "Search for Project categories records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryProjectCategory", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "descriptionAndFeaturedImage" : { "summary" : "order by description, then by featuredImage (both ascending)", "value" : "description, featuredImage" }, "featuredMediaIdAndNameAndSection" : { "summary" : "order by featuredMediaId descending, then by name ascending, then by section", "value" : "featuredMediaId DESC, name ASC, section" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "description", "description" : "Query on the Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "featuredImage", "description" : "Query on the Featured Image field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "featuredMediaId", "description" : "Query on the Featured Media field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "section", "description" : "Query on the Section field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "slug", "description" : "Query on the Slug field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "sortOrder", "description" : "Query on the Sort Order field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "title", "description" : "Query on the Title field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Project categories table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/projectCategorySearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/projectCategory/{id}" : { "get" : { "summary" : "Get one Project categories by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getProjectCategory", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Project categories to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Project categories record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Project categories", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/projectCategory" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/projectUpdate/query" : { "get" : { "summary" : "Search for Project updates records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryProjectUpdate", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "contentAndExcerpt" : { "summary" : "order by content, then by excerpt (both ascending)", "value" : "content, excerpt" }, "featuredImageAndFeaturedMediaIdAndProjectId" : { "summary" : "order by featuredImage descending, then by featuredMediaId ascending, then by projectId", "value" : "featuredImage DESC, featuredMediaId ASC, projectId" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "content", "description" : "Query on the Content field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "excerpt", "description" : "Query on the Excerpt field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "featuredImage", "description" : "Query on the Featured Image field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "featuredMediaId", "description" : "Query on the Featured Media field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "projectId", "description" : "Query on the Project field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "publishDate", "description" : "Query on the Publish Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "slug", "description" : "Query on the Slug field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "sortOrder", "description" : "Query on the Sort Order field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "title", "description" : "Query on the Title field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "updateDate", "description" : "Query on the Update Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Project updates table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/projectUpdateSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/projectUpdate/{id}" : { "get" : { "summary" : "Get one Project updates by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getProjectUpdate", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Project updates to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Project updates record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Project updates", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/projectUpdate" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/project/query" : { "get" : { "summary" : "Search for Projects records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryProject", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "categoryIdAndContent" : { "summary" : "order by categoryId, then by content (both ascending)", "value" : "categoryId, content" }, "descriptionAndEndDateAndFeaturedImage" : { "summary" : "order by description descending, then by endDate ascending, then by featuredImage", "value" : "description DESC, endDate ASC, featuredImage" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "categoryId", "description" : "Query on the Category field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "content", "description" : "Query on the Content field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "description", "description" : "Query on the Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "endDate", "description" : "Query on the End Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "featuredImage", "description" : "Query on the Featured Image field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "featuredMediaId", "description" : "Query on the Featured Media field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "githubUrl", "description" : "Query on the Github Url field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "imageFocalX", "description" : "Query on the Horizontal focal point (%) field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "imageCaption", "description" : "Query on the Image Caption field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "imageAlt", "description" : "Query on the Image description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "isFeatured", "description" : "Query on the Is Featured field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaBooleanEquals" : { "$ref" : "#/components/examples/criteriaBooleanEquals" }, "criteriaBooleanNotEquals" : { "$ref" : "#/components/examples/criteriaBooleanNotEquals" }, "criteriaBooleanEmpty" : { "$ref" : "#/components/examples/criteriaBooleanEmpty" }, "criteriaBooleanNotEmpty" : { "$ref" : "#/components/examples/criteriaBooleanNotEmpty" } } }, { "name" : "liveUrl", "description" : "Query on the Live Url field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "modifyDate", "description" : "Query on the Modify Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "projectStatus", "description" : "Query on the Project Status field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "publishDate", "description" : "Query on the Publish Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "shortName", "description" : "Query on the Short Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "slug", "description" : "Query on the Slug field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "sortOrder", "description" : "Query on the Sort Order field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "startDate", "description" : "Query on the Start Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "title", "description" : "Query on the Title field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "imageFocalY", "description" : "Query on the Vertical focal point (%) field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Projects table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/projectSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/project/{id}" : { "get" : { "summary" : "Get one Projects by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getProject", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Projects to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Projects record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Projects", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/project" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/redirectType/query" : { "get" : { "summary" : "Search for Redirect Types records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryRedirectType", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "codeAndHttpStatusCode" : { "summary" : "order by code, then by httpStatusCode (both ascending)", "value" : "code, httpStatusCode" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "code", "description" : "Query on the Code field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "httpStatusCode", "description" : "Query on the Http Status Code field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Redirect Types table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/redirectTypeSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/redirectType/{id}" : { "get" : { "summary" : "Get one Redirect Types by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getRedirectType", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Redirect Types to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Redirect Types record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Redirect Types", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/redirectType" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/redirect/query" : { "get" : { "summary" : "Search for Redirects records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryRedirect", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "expiryDateAndMatchType" : { "summary" : "order by expiryDate, then by matchType (both ascending)", "value" : "expiryDate, matchType" }, "preserveQueryParamsAndPriorityAndRedirectTypeId" : { "summary" : "order by preserveQueryParams descending, then by priority ascending, then by redirectTypeId", "value" : "preserveQueryParams DESC, priority ASC, redirectTypeId" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "expiryDate", "description" : "Query on the Expiry Date field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaDateTimeEquals" : { "$ref" : "#/components/examples/criteriaDateTimeEquals" }, "criteriaDateTimeNotEquals" : { "$ref" : "#/components/examples/criteriaDateTimeNotEquals" }, "criteriaDateTimeLessThan" : { "$ref" : "#/components/examples/criteriaDateTimeLessThan" }, "criteriaDateTimeGreaterThan" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThan" }, "criteriaDateTimeLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeLessThanOrEquals" }, "criteriaDateTimeGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaDateTimeGreaterThanOrEquals" }, "criteriaDateTimeEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeEmpty" }, "criteriaDateTimeNotEmpty" : { "$ref" : "#/components/examples/criteriaDateTimeNotEmpty" }, "criteriaDateTimeBetween" : { "$ref" : "#/components/examples/criteriaDateTimeBetween" }, "criteriaDateTimeNotBetween" : { "$ref" : "#/components/examples/criteriaDateTimeNotBetween" }, "criteriaDateTimeIn" : { "$ref" : "#/components/examples/criteriaDateTimeIn" }, "criteriaDateTimeNotIn" : { "$ref" : "#/components/examples/criteriaDateTimeNotIn" }, "criteriaDateTimeMultiple" : { "$ref" : "#/components/examples/criteriaDateTimeMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "matchType", "description" : "Query on the Match Type field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "preserveQueryParams", "description" : "Query on the Preserve Query Params field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaBooleanEquals" : { "$ref" : "#/components/examples/criteriaBooleanEquals" }, "criteriaBooleanNotEquals" : { "$ref" : "#/components/examples/criteriaBooleanNotEquals" }, "criteriaBooleanEmpty" : { "$ref" : "#/components/examples/criteriaBooleanEmpty" }, "criteriaBooleanNotEmpty" : { "$ref" : "#/components/examples/criteriaBooleanNotEmpty" } } }, { "name" : "priority", "description" : "Query on the Priority field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "redirectTypeId", "description" : "Query on the Redirect Type field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "sourcePath", "description" : "Query on the Source Path field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "targetPath", "description" : "Query on the Target Path field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Redirects table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/redirectSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/redirect/{id}" : { "get" : { "summary" : "Get one Redirects by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getRedirect", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Redirects to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Redirects record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Redirects", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/redirect" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/site/query" : { "get" : { "summary" : "Search for Sites records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "querySite", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "descriptionAndName" : { "summary" : "order by description, then by name (both ascending)", "value" : "description, name" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "description", "description" : "Query on the Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "shortName", "description" : "Query on the Short Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Sites table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/siteSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/site/{id}" : { "get" : { "summary" : "Get one Sites by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getSite", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Sites to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Sites record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Sites", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/site" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/snippet/query" : { "get" : { "summary" : "Search for Snippets records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "querySnippet", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "contentAndCssClassName" : { "summary" : "order by content, then by cssClassName (both ascending)", "value" : "content, cssClassName" }, "nameAndShortNameAndSortOrder" : { "summary" : "order by name descending, then by shortName ascending, then by sortOrder", "value" : "name DESC, shortName ASC, sortOrder" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "content", "description" : "Query on the Content field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "cssClassName", "description" : "Query on the Css Class Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "shortName", "description" : "Query on the Short Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "sortOrder", "description" : "Query on the Sort Order field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Snippets table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/snippetSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/snippet/{id}" : { "get" : { "summary" : "Get one Snippets by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getSnippet", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Snippets to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Snippets record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Snippets", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/snippet" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/tag/query" : { "get" : { "summary" : "Search for Tags records by query string", "description" : "Execute a query on this table, using query criteria as specified in query string parameters.\n\n* Pagination is managed via the `pageNo` & `pageSize` query string parameters. pageNo starts at 1. pageSize defaults to 50.\n* By default, the response includes the total count of records that match the query criteria. The count can be omitted by specifying `includeCount=false`\n* By default, results are sorted by the table's primary key, descending. This can be changed by specifying the `orderBy` query string parameter, following SQL ORDER BY syntax (e.g., `fieldName1 ASC, fieldName2 DESC`)\n* By default, all given query criteria are combined using logical AND. This can be changed by specifying the query string parameter `booleanOperator=OR`.\n* Each field on the table can be used as a query criteria. Each query criteria field can be specified on the query string any number of times.\n* By default, all criteria use the equals operator (e.g., `myField=value` means records will be returned where myField equals value). Alternative operators can be used as follows:\n * Equals: `myField=value`\n * Not Equals: `myField=!value`\n * Less Than: `myField=<value`\n * Greater Than: `myField=>value`\n * Less Than or Equals: `myField=<=value`\n * Greater Than or Equals: `myField=>=value`\n * Empty (or null): `myField=EMPTY`\n * Not Empty: `myField=!EMPTY`\n * Between: `myField=BETWEEN value1,value2` (two values must be given, separated by commas)\n * Not Between: `myField=!BETWEEN value1,value2` (two values must be given, separated by commas)\n * In: `myField=IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Not In: `myField=!IN value1,value2,...,valueN` (one or more values must be given, separated by commas)\n * Like: `myField=LIKE value` (using standard SQL % and _ wildcards)\n * Not Like: `myField=!LIKE value` (using standard SQL % and _ wildcards)\n", "operationId" : "queryTag", "tags" : [ "Content" ], "parameters" : [ { "name" : "pageNo", "description" : "Which page of results to return. Starts at 1.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "pageSize", "description" : "Max number of records to include in a page. Defaults to 50. Must be between 1 and 1000.", "in" : "query", "schema" : { "type" : "integer" } }, { "name" : "includeCount", "description" : "Whether or not to include the count (total matching records) in the result. Default is true.", "in" : "query", "schema" : { "type" : "boolean", "enum" : [ "true", "false" ] } }, { "name" : "orderBy", "description" : "How the results of the query should be sorted. SQL-style, comma-separated list of field names, each optionally followed by ASC or DESC (defaults to ASC).", "in" : "query", "schema" : { "type" : "string" }, "examples" : { "default" : { "summary" : "default: order by id descending", "value" : [ "" ] }, "id" : { "summary" : "order by id (ascending, since ASC/DESC was not specified)", "value" : "id" }, "idDesc" : { "summary" : "order by id descending", "value" : "id DESC" }, "idAsc" : { "summary" : "order by id ascending", "value" : "id ASC" }, "blogIdAndDescription" : { "summary" : "order by blogId, then by description (both ascending)", "value" : "blogId, description" } } }, { "name" : "booleanOperator", "description" : "Whether to combine query field as an AND or an OR. Default is AND.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AND", "OR" ] } }, { "name" : "blogId", "description" : "Query on the Blog field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "description", "description" : "Query on the Description field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "id", "description" : "Query on the Id field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaNumberEquals" : { "$ref" : "#/components/examples/criteriaNumberEquals" }, "criteriaNumberNotEquals" : { "$ref" : "#/components/examples/criteriaNumberNotEquals" }, "criteriaNumberLessThan" : { "$ref" : "#/components/examples/criteriaNumberLessThan" }, "criteriaNumberGreaterThan" : { "$ref" : "#/components/examples/criteriaNumberGreaterThan" }, "criteriaNumberLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberLessThanOrEquals" }, "criteriaNumberGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaNumberGreaterThanOrEquals" }, "criteriaNumberEmpty" : { "$ref" : "#/components/examples/criteriaNumberEmpty" }, "criteriaNumberNotEmpty" : { "$ref" : "#/components/examples/criteriaNumberNotEmpty" }, "criteriaNumberBetween" : { "$ref" : "#/components/examples/criteriaNumberBetween" }, "criteriaNumberNotBetween" : { "$ref" : "#/components/examples/criteriaNumberNotBetween" }, "criteriaNumberIn" : { "$ref" : "#/components/examples/criteriaNumberIn" }, "criteriaNumberNotIn" : { "$ref" : "#/components/examples/criteriaNumberNotIn" }, "criteriaNumberMultiple" : { "$ref" : "#/components/examples/criteriaNumberMultiple" } } }, { "name" : "name", "description" : "Query on the Name field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } }, { "name" : "slug", "description" : "Query on the Slug field. Can prefix value with an operator, else defaults to = (equals).", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "explode" : true, "examples" : { "criteriaNotQueried" : { "$ref" : "#/components/examples/criteriaNotQueried" }, "criteriaStringEquals" : { "$ref" : "#/components/examples/criteriaStringEquals" }, "criteriaStringNotEquals" : { "$ref" : "#/components/examples/criteriaStringNotEquals" }, "criteriaStringLessThan" : { "$ref" : "#/components/examples/criteriaStringLessThan" }, "criteriaStringGreaterThan" : { "$ref" : "#/components/examples/criteriaStringGreaterThan" }, "criteriaStringLessThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringLessThanOrEquals" }, "criteriaStringGreaterThanOrEquals" : { "$ref" : "#/components/examples/criteriaStringGreaterThanOrEquals" }, "criteriaStringEmpty" : { "$ref" : "#/components/examples/criteriaStringEmpty" }, "criteriaStringNotEmpty" : { "$ref" : "#/components/examples/criteriaStringNotEmpty" }, "criteriaStringBetween" : { "$ref" : "#/components/examples/criteriaStringBetween" }, "criteriaStringNotBetween" : { "$ref" : "#/components/examples/criteriaStringNotBetween" }, "criteriaStringIn" : { "$ref" : "#/components/examples/criteriaStringIn" }, "criteriaStringNotIn" : { "$ref" : "#/components/examples/criteriaStringNotIn" }, "criteriaStringLike" : { "$ref" : "#/components/examples/criteriaStringLike" }, "criteriaStringNotLike" : { "$ref" : "#/components/examples/criteriaStringNotLike" }, "criteriaStringMultiple" : { "$ref" : "#/components/examples/criteriaStringMultiple" } } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "200" : { "description" : "Successfully searched the Tags table (though may have found 0 records).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/tagSearchResult" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/v1/tag/{id}" : { "get" : { "summary" : "Get one Tags by Id", "description" : "Get one record from this table, by specifying its primary key as a path parameter.\n", "operationId" : "getTag", "tags" : [ "Content" ], "parameters" : [ { "name" : "id", "description" : "Id of the Tags to get.", "required" : true, "in" : "path", "schema" : { "type" : "integer" } } ], "responses" : { "400" : { "$ref" : "#/components/responses/error400" }, "401" : { "$ref" : "#/components/responses/error401" }, "403" : { "$ref" : "#/components/responses/error403" }, "500" : { "$ref" : "#/components/responses/error500" }, "404" : { "description" : "The requested Tags record was not found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "200" : { "description" : "Successfully got the requested Tags", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/tag" } } } }, "429" : { "$ref" : "#/components/responses/error429" } } } }, "/versions.json" : { "get" : { "operationId" : "getApiVersions", "tags" : [ "Discovery" ], "summary" : "List API versions", "description" : "Supported path versions and the full semantic version of each.", "responses" : { "200" : { "description" : "Version discovery document", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Versions" } } } } } } }, "/v1/search" : { "get" : { "operationId" : "searchContent", "tags" : [ "Search" ], "summary" : "Search published content", "description" : "Full-text search over published posts, pages, projects, albums and photos.", "parameters" : [ { "name" : "q", "in" : "query", "required" : true, "description" : "Search term (2-200 characters).", "schema" : { "type" : "string", "minLength" : 2, "maxLength" : 200 } }, { "name" : "type", "in" : "query", "required" : false, "description" : "Comma-separated result types to include (post, page, project, album, photo).", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "required" : false, "schema" : { "type" : "integer", "minimum" : 1, "maximum" : 50, "default" : 20 } } ], "responses" : { "200" : { "description" : "Matching public records", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchResults" } } } }, "422" : { "$ref" : "#/components/responses/ValidationFailed" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" }, "503" : { "$ref" : "#/components/responses/ServiceUnavailable" } } } }, "/v1/contact" : { "post" : { "operationId" : "sendContactMessage", "tags" : [ "Contact" ], "summary" : "Send a message to the site owner", "description" : "Validated, rate limited and honeypot-protected. Leave `website` empty and send `startedAt` (epoch milliseconds when the form was shown).", "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContactRequest" } } } }, "responses" : { "202" : { "description" : "Accepted for delivery", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContactAccepted" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "422" : { "$ref" : "#/components/responses/ValidationFailed" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" } } } }, "/v1/feeds/{blogSlug}/rss.xml" : { "get" : { "operationId" : "getBlogRssFeed", "tags" : [ "Feeds" ], "summary" : "RSS 2.0 feed of a blog", "parameters" : [ { "$ref" : "#/components/parameters/BlogSlug" } ], "responses" : { "200" : { "description" : "RSS 2.0 document", "content" : { "application/rss+xml" : { "schema" : { "type" : "string" } } } }, "404" : { "$ref" : "#/components/responses/NotFound" } } } }, "/v1/feeds/{blogSlug}/atom.xml" : { "get" : { "operationId" : "getBlogAtomFeed", "tags" : [ "Feeds" ], "summary" : "Atom 1.0 feed of a blog", "parameters" : [ { "$ref" : "#/components/parameters/BlogSlug" } ], "responses" : { "200" : { "description" : "Atom document", "content" : { "application/atom+xml" : { "schema" : { "type" : "string" } } } }, "404" : { "$ref" : "#/components/responses/NotFound" } } } }, "/v1/feeds/{blogSlug}/feed.json" : { "get" : { "operationId" : "getBlogJsonFeed", "tags" : [ "Feeds" ], "summary" : "JSON Feed 1.1 of a blog", "parameters" : [ { "$ref" : "#/components/parameters/BlogSlug" } ], "responses" : { "200" : { "description" : "JSON Feed document", "content" : { "application/feed+json" : { "schema" : { "$ref" : "#/components/schemas/JsonFeed" } } } }, "404" : { "$ref" : "#/components/responses/NotFound" } } } }, "/v1/sitemap.xml" : { "get" : { "operationId" : "getSitemap", "tags" : [ "Feeds" ], "summary" : "Sitemap of every public website URL", "responses" : { "200" : { "description" : "sitemaps.org urlset", "content" : { "application/xml" : { "schema" : { "type" : "string" } } } } } } }, "/v1/me" : { "get" : { "operationId" : "getMe", "tags" : [ "Authoring" ], "summary" : "Who am I", "description" : "The signed-in publisher, their author profile, the blogs they can post to and the limits.", "security" : [ { "kof22OAuth" : [ "kof22:publish" ] }, { "bearerAuth" : [ ] } ], "responses" : { "200" : { "description" : "The current publisher", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Me" } } } }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" } } } }, "/v1/me/posts" : { "get" : { "operationId" : "listMyPosts", "tags" : [ "Authoring" ], "summary" : "List my posts", "description" : "My posts, most recently changed first, with cursor pagination.", "security" : [ { "kof22OAuth" : [ "kof22:publish" ] }, { "bearerAuth" : [ ] } ], "parameters" : [ { "name" : "status", "in" : "query", "required" : false, "schema" : { "$ref" : "#/components/schemas/PostStatus" } }, { "name" : "cursor", "in" : "query", "required" : false, "description" : "The `nextCursor` of the previous page.", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "required" : false, "schema" : { "type" : "integer", "minimum" : 1, "maximum" : 50, "default" : 20 } } ], "responses" : { "200" : { "description" : "A page of posts", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PostPage" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" } } }, "post" : { "operationId" : "createPost", "tags" : [ "Authoring" ], "summary" : "Create a post", "description" : "Creates a draft, publishes immediately (`status: published`) or schedules (`status: scheduled` with `publishAt`). Retry-safe with `Idempotency-Key`.", "security" : [ { "kof22OAuth" : [ "kof22:publish" ] }, { "bearerAuth" : [ ] } ], "parameters" : [ { "$ref" : "#/components/parameters/IdempotencyKey" } ], "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PostCreate" } } } }, "responses" : { "201" : { "description" : "Created", "headers" : { "ETag" : { "$ref" : "#/components/headers/ETag" }, "Location" : { "$ref" : "#/components/headers/Location" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthoringPost" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "422" : { "$ref" : "#/components/responses/ValidationFailed" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" } } } }, "/v1/me/posts/{postId}" : { "parameters" : [ { "$ref" : "#/components/parameters/PostId" } ], "get" : { "operationId" : "getMyPost", "tags" : [ "Authoring" ], "summary" : "Get one of my posts", "security" : [ { "kof22OAuth" : [ "kof22:publish" ] }, { "bearerAuth" : [ ] } ], "responses" : { "200" : { "description" : "The post", "headers" : { "ETag" : { "$ref" : "#/components/headers/ETag" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthoringPost" } } } }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" } } }, "patch" : { "operationId" : "updatePost", "tags" : [ "Authoring" ], "summary" : "Update one of my posts", "description" : "Omitted fields are unchanged; `null` clears optional fields. `tags` and `media` replace the whole list. Requires `If-Match` with the current ETag.", "security" : [ { "kof22OAuth" : [ "kof22:publish" ] }, { "bearerAuth" : [ ] } ], "parameters" : [ { "$ref" : "#/components/parameters/IfMatch" } ], "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PostUpdate" } } } }, "responses" : { "200" : { "description" : "Updated", "headers" : { "ETag" : { "$ref" : "#/components/headers/ETag" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthoringPost" } } } }, "400" : { "$ref" : "#/components/responses/BadRequest" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "412" : { "$ref" : "#/components/responses/PreconditionFailed" }, "422" : { "$ref" : "#/components/responses/ValidationFailed" }, "428" : { "$ref" : "#/components/responses/PreconditionRequired" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" } } }, "delete" : { "operationId" : "deletePost", "tags" : [ "Authoring" ], "summary" : "Delete one of my posts", "security" : [ { "kof22OAuth" : [ "kof22:publish" ] }, { "bearerAuth" : [ ] } ], "parameters" : [ { "$ref" : "#/components/parameters/IfMatchOptional" } ], "responses" : { "204" : { "description" : "Deleted" }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "412" : { "$ref" : "#/components/responses/PreconditionFailed" } } } }, "/v1/me/uploads" : { "post" : { "operationId" : "createUpload", "tags" : [ "Authoring" ], "summary" : "Start a photo upload", "description" : "Returns a presigned `uploadUrl`. PUT the file bytes there with the returned headers (within 15 minutes; PUT is retry-safe), then call `completeUpload`. JPEG, PNG and HEIC (when the server converter is enabled); at most 25 MB. Photos only.", "security" : [ { "kof22OAuth" : [ "kof22:publish" ] }, { "bearerAuth" : [ ] } ], "parameters" : [ { "$ref" : "#/components/parameters/IdempotencyKey" } ], "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UploadCreate" } } } }, "responses" : { "201" : { "description" : "Upload ticket", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UploadTicket" } } } }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "413" : { "$ref" : "#/components/responses/PayloadTooLarge" }, "415" : { "$ref" : "#/components/responses/UnsupportedMediaType" }, "422" : { "$ref" : "#/components/responses/ValidationFailed" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" } } } }, "/v1/me/uploads/{uploadId}/complete" : { "post" : { "operationId" : "completeUpload", "tags" : [ "Authoring" ], "summary" : "Finish a photo upload", "description" : "Verifies the uploaded bytes, converts HEIC, strips EXIF location data unless `keepLocation` is true, generates renditions and returns the media to attach to a post. Calling it again returns the same media.", "security" : [ { "kof22OAuth" : [ "kof22:publish" ] }, { "bearerAuth" : [ ] } ], "parameters" : [ { "$ref" : "#/components/parameters/UploadId" } ], "requestBody" : { "required" : false, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UploadComplete" } } } }, "responses" : { "200" : { "description" : "The published photo", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MediaItem" } } } }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "404" : { "$ref" : "#/components/responses/NotFound" }, "409" : { "$ref" : "#/components/responses/Conflict" }, "413" : { "$ref" : "#/components/responses/PayloadTooLarge" }, "415" : { "$ref" : "#/components/responses/UnsupportedMediaType" } } } }, "/v1/me/tags" : { "get" : { "operationId" : "listMyTags", "tags" : [ "Authoring" ], "summary" : "Tag autocomplete", "security" : [ { "kof22OAuth" : [ "kof22:publish" ] }, { "bearerAuth" : [ ] } ], "parameters" : [ { "name" : "q", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "blog", "in" : "query", "required" : false, "description" : "Blog slug (default quick-bits).", "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "required" : false, "schema" : { "type" : "integer", "minimum" : 1, "maximum" : 50, "default" : 20 } } ], "responses" : { "200" : { "description" : "Matching tags", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TagList" } } } }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "422" : { "$ref" : "#/components/responses/ValidationFailed" } } } }, "/v1/me/link-preview" : { "post" : { "operationId" : "getLinkPreview", "tags" : [ "Authoring" ], "summary" : "Preview a link", "description" : "Fetches title, description and image server-side (public addresses only).", "security" : [ { "kof22OAuth" : [ "kof22:publish" ] }, { "bearerAuth" : [ ] } ], "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LinkPreviewRequest" } } } }, "responses" : { "200" : { "description" : "The preview (fields are null when the page had none)", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LinkPreview" } } } }, "401" : { "$ref" : "#/components/responses/Unauthorized" }, "403" : { "$ref" : "#/components/responses/Forbidden" }, "422" : { "$ref" : "#/components/responses/ValidationFailed" }, "429" : { "$ref" : "#/components/responses/TooManyRequests" } } } } }, "components" : { "examples" : { "criteriaNotQueried" : { "summary" : "no query on this field", "value" : [ "" ] }, "criteriaNumberEquals" : { "summary" : "equal to 47", "value" : [ "47" ] }, "criteriaNumberNotEquals" : { "summary" : "not equal to 47", "value" : [ "!47" ] }, "criteriaNumberLessThan" : { "summary" : "less than 47", "value" : [ "<47" ] }, "criteriaNumberGreaterThan" : { "summary" : "greater than 47", "value" : [ ">47" ] }, "criteriaNumberLessThanOrEquals" : { "summary" : "less than or equal to 47", "value" : [ "<=47" ] }, "criteriaNumberGreaterThanOrEquals" : { "summary" : "greater than or equal to 47", "value" : [ ">=47" ] }, "criteriaNumberEmpty" : { "summary" : "null value", "value" : [ "EMPTY" ] }, "criteriaNumberNotEmpty" : { "summary" : "non-null value", "value" : [ "!EMPTY" ] }, "criteriaNumberBetween" : { "summary" : "between 42 and 47", "value" : [ "BETWEEN 42,47" ] }, "criteriaNumberNotBetween" : { "summary" : "not between 42 and 47", "value" : [ "!BETWEEN 42,47" ] }, "criteriaNumberIn" : { "summary" : "any of 1701, 74205, or 74656", "value" : [ "IN 1701,74205,74656" ] }, "criteriaNumberNotIn" : { "summary" : "not any of 1701, 74205, or 74656", "value" : [ "!IN 1701,74205,74656" ] }, "criteriaNumberMultiple" : { "summary" : "multiple criteria: between 42 and 47 and not equal to 45", "value" : [ "BETWEEN 42,47", "!45" ] }, "criteriaBooleanEquals" : { "summary" : "equal to true", "value" : [ "true" ] }, "criteriaBooleanNotEquals" : { "summary" : "not equal to true", "value" : [ "!true" ] }, "criteriaBooleanEmpty" : { "summary" : "null value", "value" : [ "EMPTY" ] }, "criteriaBooleanNotEmpty" : { "summary" : "non-null value", "value" : [ "!EMPTY" ] }, "criteriaDateTimeEquals" : { "summary" : "equal to 2001-01-01T00:00:00Z", "value" : [ "2001-01-01T00:00:00Z" ] }, "criteriaDateTimeNotEquals" : { "summary" : "not equal to 2001-01-01T00:00:00Z", "value" : [ "!2001-01-01T00:00:00Z" ] }, "criteriaDateTimeLessThan" : { "summary" : "less than 2001-01-01T00:00:00Z", "value" : [ "<2001-01-01T00:00:00Z" ] }, "criteriaDateTimeGreaterThan" : { "summary" : "greater than 2001-01-01T00:00:00Z", "value" : [ ">2001-01-01T00:00:00Z" ] }, "criteriaDateTimeLessThanOrEquals" : { "summary" : "less than or equal to 2001-01-01T00:00:00Z", "value" : [ "<=2001-01-01T00:00:00Z" ] }, "criteriaDateTimeGreaterThanOrEquals" : { "summary" : "greater than or equal to 2001-01-01T00:00:00Z", "value" : [ ">=2001-01-01T00:00:00Z" ] }, "criteriaDateTimeEmpty" : { "summary" : "null value", "value" : [ "EMPTY" ] }, "criteriaDateTimeNotEmpty" : { "summary" : "non-null value", "value" : [ "!EMPTY" ] }, "criteriaDateTimeBetween" : { "summary" : "between 2000-10-03T00:00:00Z and 2001-01-01T00:00:00Z", "value" : [ "BETWEEN 2000-10-03T00:00:00Z,2001-01-01T00:00:00Z" ] }, "criteriaDateTimeNotBetween" : { "summary" : "not between 2000-10-03T00:00:00Z and 2001-01-01T00:00:00Z", "value" : [ "!BETWEEN 2000-10-03T00:00:00Z,2001-01-01T00:00:00Z" ] }, "criteriaDateTimeIn" : { "summary" : "any of 2000-10-03T00:00:00Z, 2001-01-01T00:00:00Z, or 2001-04-01T00:00:00Z", "value" : [ "IN 2000-10-03T00:00:00Z,2001-01-01T00:00:00Z,2001-04-01T00:00:00Z" ] }, "criteriaDateTimeNotIn" : { "summary" : "not any of 2000-10-03T00:00:00Z, 2001-01-01T00:00:00Z, or 2001-04-01T00:00:00Z", "value" : [ "!IN 2000-10-03T00:00:00Z,2001-01-01T00:00:00Z,2001-04-01T00:00:00Z" ] }, "criteriaDateTimeMultiple" : { "summary" : "multiple criteria: between 2000-10-03T00:00:00Z and 2001-04-01T00:00:00Z and not equal to 2001-01-01T00:00:00Z", "value" : [ "BETWEEN 2000-10-03T00:00:00Z,2001-04-01T00:00:00Z", "!2001-01-01T00:00:00Z" ] }, "criteriaDateEquals" : { "summary" : "equal to 2001-01-01", "value" : [ "2001-01-01" ] }, "criteriaDateNotEquals" : { "summary" : "not equal to 2001-01-01", "value" : [ "!2001-01-01" ] }, "criteriaDateLessThan" : { "summary" : "less than 2001-01-01", "value" : [ "<2001-01-01" ] }, "criteriaDateGreaterThan" : { "summary" : "greater than 2001-01-01", "value" : [ ">2001-01-01" ] }, "criteriaDateLessThanOrEquals" : { "summary" : "less than or equal to 2001-01-01", "value" : [ "<=2001-01-01" ] }, "criteriaDateGreaterThanOrEquals" : { "summary" : "greater than or equal to 2001-01-01", "value" : [ ">=2001-01-01" ] }, "criteriaDateEmpty" : { "summary" : "null value", "value" : [ "EMPTY" ] }, "criteriaDateNotEmpty" : { "summary" : "non-null value", "value" : [ "!EMPTY" ] }, "criteriaDateBetween" : { "summary" : "between 2000-10-03 and 2001-01-01", "value" : [ "BETWEEN 2000-10-03,2001-01-01" ] }, "criteriaDateNotBetween" : { "summary" : "not between 2000-10-03 and 2001-01-01", "value" : [ "!BETWEEN 2000-10-03,2001-01-01" ] }, "criteriaDateIn" : { "summary" : "any of 2000-10-03, 2001-01-01, or 2001-04-01", "value" : [ "IN 2000-10-03,2001-01-01,2001-04-01" ] }, "criteriaDateNotIn" : { "summary" : "not any of 2000-10-03, 2001-01-01, or 2001-04-01", "value" : [ "!IN 2000-10-03,2001-01-01,2001-04-01" ] }, "criteriaDateMultiple" : { "summary" : "multiple criteria: between 2000-10-03 and 2001-04-01 and not equal to 2001-01-01", "value" : [ "BETWEEN 2000-10-03,2001-04-01", "!2001-01-01" ] }, "criteriaStringEquals" : { "summary" : "equal to foo", "value" : [ "foo" ] }, "criteriaStringNotEquals" : { "summary" : "not equal to foo", "value" : [ "!foo" ] }, "criteriaStringLessThan" : { "summary" : "less than foo", "value" : [ "foo" ] }, "criteriaStringLessThanOrEquals" : { "summary" : "less than or equal to foo", "value" : [ "<=foo" ] }, "criteriaStringGreaterThanOrEquals" : { "summary" : "greater than or equal to foo", "value" : [ ">=foo" ] }, "criteriaStringEmpty" : { "summary" : "null value", "value" : [ "EMPTY" ] }, "criteriaStringNotEmpty" : { "summary" : "non-null value", "value" : [ "!EMPTY" ] }, "criteriaStringBetween" : { "summary" : "between bar and foo", "value" : [ "BETWEEN bar,foo" ] }, "criteriaStringNotBetween" : { "summary" : "not between bar and foo", "value" : [ "!BETWEEN bar,foo" ] }, "criteriaStringIn" : { "summary" : "any of foo, bar, or baz", "value" : [ "IN foo,bar,baz" ] }, "criteriaStringNotIn" : { "summary" : "not any of foo, bar, or baz", "value" : [ "!IN foo,bar,baz" ] }, "criteriaStringLike" : { "summary" : "starting with f", "value" : [ "LIKE f%" ] }, "criteriaStringNotLike" : { "summary" : "not starting with f", "value" : [ "!LIKE f%" ] }, "criteriaStringMultiple" : { "summary" : "multiple criteria: between bar and foo and not equal to baz", "value" : [ "BETWEEN bar,foo", "!baz" ] }, "criteriaBlobEmpty" : { "summary" : "null value", "value" : [ "EMPTY" ] }, "criteriaBlobNotEmpty" : { "summary" : "non-null value", "value" : [ "!EMPTY" ] } }, "schemas" : { "baseSearchResultFields" : { "type" : "object", "properties" : { "pageNo" : { "type" : "integer", "description" : "Requested result page number" }, "count" : { "type" : "integer", "description" : "Number of records that matched the search criteria" }, "pageSize" : { "type" : "integer", "description" : "Requested result page size" } } }, "author" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "Description for the Author.", "nullable" : true, "maxLength" : 255 }, "id" : { "type" : "integer", "description" : "Id for the Author.", "readOnly" : true, "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the Author.", "maxLength" : 40 }, "profileImageUrl" : { "type" : "string", "description" : "Profile Image Url for the Author.", "readOnly" : true, "nullable" : true, "maxLength" : 500 }, "profileMediaId" : { "type" : "integer", "description" : "Profile Media for the Author. Values in this field come from the primary key of the Media table", "nullable" : true }, "shortName" : { "type" : "string", "description" : "Short Name for the Author.", "maxLength" : 20 }, "slug" : { "type" : "string", "description" : "Slug for the Author.", "maxLength" : 40 }, "socialLinks" : { "type" : "string", "description" : "Social Links for the Author.", "nullable" : true }, "website" : { "type" : "string", "description" : "Website for the Author.", "nullable" : true, "maxLength" : 255 } } }, "authorSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/author" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "post" : { "type" : "object", "properties" : { "authorId" : { "type" : "integer", "description" : "Author for the Blog Post. Values in this field come from the primary key of the Author table" }, "blogId" : { "type" : "integer", "description" : "Blog for the Blog Post. Values in this field come from the primary key of the Blogs table" }, "content" : { "type" : "string", "description" : "Content for the Blog Post." }, "description" : { "type" : "string", "description" : "Description for the Blog Post.", "nullable" : true, "maxLength" : 255 }, "excerpt" : { "type" : "string", "description" : "Excerpt for the Blog Post.", "nullable" : true }, "featuredImage" : { "type" : "string", "description" : "Featured Image URL for the Blog Post.", "readOnly" : true, "nullable" : true, "maxLength" : 255 }, "featuredMediaId" : { "type" : "integer", "description" : "Featured Media for the Blog Post. Values in this field come from the primary key of the Media table", "nullable" : true }, "id" : { "type" : "integer", "description" : "Id for the Blog Post.", "readOnly" : true, "nullable" : true }, "isFeatured" : { "type" : "boolean", "description" : "Is Featured for the Blog Post." }, "linkDescription" : { "type" : "string", "description" : "Link Description for the Blog Post.", "nullable" : true, "maxLength" : 1000 }, "linkImageUrl" : { "type" : "string", "description" : "Link Image URL for the Blog Post.", "nullable" : true, "maxLength" : 2000 }, "linkTitle" : { "type" : "string", "description" : "Link Title for the Blog Post.", "nullable" : true, "maxLength" : 300 }, "linkUrl" : { "type" : "string", "description" : "Link URL for the Blog Post.", "nullable" : true, "maxLength" : 2000 }, "locationLabel" : { "type" : "string", "description" : "Location for the Blog Post.", "nullable" : true, "maxLength" : 200 }, "metaDescription" : { "type" : "string", "description" : "Meta Description for the Blog Post.", "nullable" : true, "maxLength" : 500 }, "metaKeywords" : { "type" : "string", "description" : "Meta Keywords for the Blog Post.", "nullable" : true, "maxLength" : 255 }, "metaTitle" : { "type" : "string", "description" : "Meta Title for the Blog Post.", "nullable" : true, "maxLength" : 255 }, "modifyDate" : { "type" : "string", "format" : "date-time", "description" : "Modify Date for the Blog Post.", "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the Blog Post.", "maxLength" : 40 }, "publishDate" : { "type" : "string", "format" : "date-time", "description" : "Publish Date for the Blog Post.", "nullable" : true }, "readTime" : { "type" : "integer", "description" : "Read Time for the Blog Post." }, "slug" : { "type" : "string", "description" : "Slug for the Blog Post.", "maxLength" : 100 }, "title" : { "type" : "string", "description" : "Title for the Blog Post.", "maxLength" : 100 }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/postTagLink" } }, "media" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/postMedia" } } } }, "postSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/post" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "blog" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "Description for the Blogs.", "nullable" : true, "maxLength" : 255 }, "id" : { "type" : "integer", "description" : "Id for the Blogs.", "readOnly" : true, "nullable" : true }, "metaDescription" : { "type" : "string", "description" : "Meta Description for the Blogs.", "nullable" : true, "maxLength" : 500 }, "metaKeywords" : { "type" : "string", "description" : "Meta Keywords for the Blogs.", "nullable" : true, "maxLength" : 255 }, "metaTitle" : { "type" : "string", "description" : "Meta Title for the Blogs.", "nullable" : true, "maxLength" : 255 }, "modifyDate" : { "type" : "string", "format" : "date-time", "description" : "Modify Date for the Blogs.", "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the Blogs.", "maxLength" : 40 }, "shortName" : { "type" : "string", "description" : "Short Name for the Blogs.", "maxLength" : 20 }, "slug" : { "type" : "string", "description" : "Slug for the Blogs.", "maxLength" : 40 } } }, "blogSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/blog" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "stream" : { "type" : "object", "properties" : { "contextLabel" : { "type" : "string", "description" : "Context Label for the Content Stream.", "readOnly" : true, "nullable" : true }, "id" : { "type" : "string", "description" : "Id for the Content Stream.", "readOnly" : true, "nullable" : true }, "imageUrl" : { "type" : "string", "description" : "Image Url for the Content Stream.", "readOnly" : true, "nullable" : true }, "kind" : { "type" : "string", "description" : "Kind for the Content Stream.", "readOnly" : true, "nullable" : true }, "publishedAt" : { "type" : "string", "format" : "date-time", "description" : "Published At for the Content Stream.", "readOnly" : true, "nullable" : true }, "summary" : { "type" : "string", "description" : "Summary for the Content Stream.", "readOnly" : true, "nullable" : true }, "title" : { "type" : "string", "description" : "Title for the Content Stream.", "readOnly" : true, "nullable" : true }, "url" : { "type" : "string", "description" : "Url for the Content Stream.", "readOnly" : true, "nullable" : true } } }, "streamSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/stream" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "media" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "Description for the Media.", "nullable" : true, "maxLength" : 500 }, "duration" : { "type" : "integer", "description" : "Duration for the Media.", "nullable" : true }, "fileExtension" : { "type" : "string", "description" : "File Extension for the Media.", "nullable" : true, "maxLength" : 20 }, "fileSize" : { "type" : "integer", "description" : "File Size for the Media.", "nullable" : true }, "galleryUrl" : { "type" : "string", "description" : "Gallery Url for the Media.", "readOnly" : true, "nullable" : true, "maxLength" : 500 }, "height" : { "type" : "integer", "description" : "Height for the Media.", "nullable" : true }, "id" : { "type" : "integer", "description" : "Id for the Media.", "readOnly" : true, "nullable" : true }, "mediaTypeId" : { "type" : "integer", "description" : "Media Type for the Media. Values in this field come from the primary key of the Media Types table" }, "mimeType" : { "type" : "string", "description" : "Mime Type for the Media.", "nullable" : true, "maxLength" : 100 }, "modifyDate" : { "type" : "string", "format" : "date-time", "description" : "Modify Date for the Media.", "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the Media.", "maxLength" : 200 }, "publicUrl" : { "type" : "string", "description" : "Public Url for the Media.", "readOnly" : true, "nullable" : true, "maxLength" : 500 }, "slideshowUrl" : { "type" : "string", "description" : "Slideshow Url for the Media.", "readOnly" : true, "nullable" : true, "maxLength" : 500 }, "slug" : { "type" : "string", "description" : "Slug for the Media.", "nullable" : true, "maxLength" : 100 }, "thumbnailUrl" : { "type" : "string", "description" : "Thumbnail Url for the Media.", "readOnly" : true, "nullable" : true, "maxLength" : 500 }, "width" : { "type" : "integer", "description" : "Width for the Media.", "nullable" : true } } }, "mediaSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/media" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "mediaType" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Code for the Media Types.", "maxLength" : 50 }, "description" : { "type" : "string", "description" : "Description for the Media Types.", "nullable" : true, "maxLength" : 500 }, "id" : { "type" : "integer", "description" : "Id for the Media Types.", "readOnly" : true, "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the Media Types.", "maxLength" : 100 } } }, "mediaTypeSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/mediaType" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "menu" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "Description for the Menus.", "nullable" : true, "maxLength" : 255 }, "id" : { "type" : "integer", "description" : "Id for the Menus.", "readOnly" : true, "nullable" : true }, "menuType" : { "type" : "string", "description" : "Menu Type for the Menus.", "maxLength" : 50 }, "name" : { "type" : "string", "description" : "Name for the Menus.", "maxLength" : 100 }, "slug" : { "type" : "string", "description" : "Slug for the Menus.", "maxLength" : 100 }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/menuItem" } } } }, "menuSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/menu" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "sectionType" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Code for the Page Section Types.", "maxLength" : 50 }, "description" : { "type" : "string", "description" : "Description for the Page Section Types.", "nullable" : true, "maxLength" : 255 }, "id" : { "type" : "integer", "description" : "Id for the Page Section Types.", "readOnly" : true, "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the Page Section Types.", "maxLength" : 100 }, "sortOrder" : { "type" : "integer", "description" : "Sort Order for the Page Section Types.", "nullable" : true } } }, "sectionTypeSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/sectionType" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "page" : { "type" : "object", "properties" : { "content" : { "type" : "string", "description" : "Content for the Pages.", "nullable" : true }, "featuredImage" : { "type" : "string", "description" : "Featured Image for the Pages.", "readOnly" : true, "nullable" : true, "maxLength" : 500 }, "featuredMediaId" : { "type" : "integer", "description" : "Featured Media for the Pages. Values in this field come from the primary key of the Media table", "nullable" : true }, "id" : { "type" : "integer", "description" : "Id for the Pages.", "readOnly" : true, "nullable" : true }, "imageAlt" : { "type" : "string", "description" : "Image Alt for the Pages.", "nullable" : true, "maxLength" : 500 }, "imageCaption" : { "type" : "string", "description" : "Image Caption for the Pages.", "nullable" : true, "maxLength" : 1000 }, "imageFocalX" : { "type" : "integer", "description" : "Image Focal X for the Pages.", "nullable" : true }, "imageFocalY" : { "type" : "integer", "description" : "Image Focal Y for the Pages.", "nullable" : true }, "metaDescription" : { "type" : "string", "description" : "Meta Description for the Pages.", "nullable" : true, "maxLength" : 500 }, "metaKeywords" : { "type" : "string", "description" : "Meta Keywords for the Pages.", "nullable" : true, "maxLength" : 255 }, "modifyDate" : { "type" : "string", "format" : "date-time", "description" : "Modify Date for the Pages.", "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the Pages.", "maxLength" : 100 }, "ogImage" : { "type" : "string", "description" : "Og Image for the Pages.", "nullable" : true, "maxLength" : 255 }, "pageTypeId" : { "type" : "integer", "description" : "Page Type for the Pages. Values in this field come from the primary key of the Page Types table" }, "parentPageId" : { "type" : "integer", "description" : "Parent Page for the Pages. Values in this field come from the primary key of the Pages table", "nullable" : true }, "publishDate" : { "type" : "string", "format" : "date-time", "description" : "Publish Date for the Pages.", "nullable" : true }, "slug" : { "type" : "string", "description" : "Slug for the Pages.", "maxLength" : 100 }, "sortOrder" : { "type" : "integer", "description" : "Sort Order for the Pages.", "nullable" : true }, "template" : { "type" : "string", "description" : "Template for the Pages.", "nullable" : true }, "title" : { "type" : "string", "description" : "Title for the Pages.", "maxLength" : 200 }, "sections" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/pageSection" } } } }, "pageSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/page" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "photo" : { "type" : "object", "properties" : { "caption" : { "type" : "string", "description" : "Caption for the Photo.", "nullable" : true, "maxLength" : 500 }, "description" : { "type" : "string", "description" : "Description for the Photo.", "nullable" : true, "maxLength" : 1000 }, "exifAperture" : { "type" : "string", "description" : "Exif Aperture for the Photo.", "nullable" : true, "maxLength" : 20 }, "exifCameraMake" : { "type" : "string", "description" : "Exif Camera Make for the Photo.", "nullable" : true, "maxLength" : 100 }, "exifCameraModel" : { "type" : "string", "description" : "Exif Camera Model for the Photo.", "nullable" : true, "maxLength" : 100 }, "exifDateTaken" : { "type" : "string", "format" : "date-time", "description" : "Exif Date Taken for the Photo.", "nullable" : true }, "exifFocalLength" : { "type" : "string", "description" : "Exif Focal Length for the Photo.", "nullable" : true, "maxLength" : 20 }, "exifIso" : { "type" : "integer", "description" : "Exif Iso for the Photo.", "nullable" : true }, "exifLensModel" : { "type" : "string", "description" : "Exif Lens Model for the Photo.", "nullable" : true, "maxLength" : 200 }, "exifShutterSpeed" : { "type" : "string", "description" : "Exif Shutter Speed for the Photo.", "nullable" : true, "maxLength" : 20 }, "galleryUrl" : { "type" : "string", "description" : "Gallery Url for the Photo.", "nullable" : true, "maxLength" : 500 }, "height" : { "type" : "integer", "description" : "Height for the Photo.", "nullable" : true }, "id" : { "type" : "integer", "description" : "Id for the Photo.", "readOnly" : true, "nullable" : true }, "isAlbumCover" : { "type" : "boolean", "description" : "Is Album Cover for the Photo." }, "isFavorite" : { "type" : "boolean", "description" : "Is Favorite for the Photo." }, "mimeType" : { "type" : "string", "description" : "Mime Type for the Photo.", "nullable" : true, "maxLength" : 100 }, "albumId" : { "type" : "integer", "description" : "Photo Album for the Photo. Values in this field come from the primary key of the Photo Album table" }, "publishDate" : { "type" : "string", "format" : "date-time", "description" : "Publish Date for the Photo.", "readOnly" : true, "nullable" : true }, "slideshowUrl" : { "type" : "string", "description" : "Slideshow Url for the Photo.", "nullable" : true, "maxLength" : 500 }, "slug" : { "type" : "string", "description" : "Slug for the Photo.", "maxLength" : 100 }, "sortOrder" : { "type" : "integer", "description" : "Sort Order for the Photo.", "nullable" : true }, "thumbnailUrl" : { "type" : "string", "description" : "Thumbnail Url for the Photo.", "nullable" : true, "maxLength" : 500 }, "title" : { "type" : "string", "description" : "Title for the Photo.", "maxLength" : 200 }, "width" : { "type" : "integer", "description" : "Width for the Photo.", "nullable" : true }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/photoTagLink" } } } }, "photoSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/photo" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "album" : { "type" : "object", "properties" : { "albumDate" : { "type" : "string", "format" : "date-time", "description" : "Album Date for the Photo Album.", "nullable" : true }, "albumEndDate" : { "type" : "string", "format" : "date-time", "description" : "Album End Date for the Photo Album.", "nullable" : true }, "coverImageUrl" : { "type" : "string", "description" : "Cover Image Url for the Photo Album.", "nullable" : true, "maxLength" : 500 }, "coverPhotoId" : { "type" : "integer", "description" : "Cover Photo for the Photo Album. Values in this field come from the primary key of the Photo table", "nullable" : true }, "description" : { "type" : "string", "description" : "Description for the Photo Album.", "nullable" : true, "maxLength" : 1000 }, "id" : { "type" : "integer", "description" : "Id for the Photo Album.", "readOnly" : true, "nullable" : true }, "location" : { "type" : "string", "description" : "Location for the Photo Album.", "nullable" : true, "maxLength" : 200 }, "metaDescription" : { "type" : "string", "description" : "Meta Description for the Photo Album.", "nullable" : true, "maxLength" : 500 }, "metaTitle" : { "type" : "string", "description" : "Meta Title for the Photo Album.", "nullable" : true, "maxLength" : 255 }, "name" : { "type" : "string", "description" : "Name for the Photo Album.", "maxLength" : 100 }, "folderId" : { "type" : "integer", "description" : "Photo Album Folder for the Photo Album. Values in this field come from the primary key of the Photo Album Folder table", "nullable" : true }, "primaryCamera" : { "type" : "string", "description" : "Primary Camera for the Photo Album.", "nullable" : true, "maxLength" : 100 }, "primaryLens" : { "type" : "string", "description" : "Primary Lens for the Photo Album.", "nullable" : true, "maxLength" : 100 }, "projectId" : { "type" : "integer", "description" : "Project for the Photo Album. Values in this field come from the primary key of the Projects table", "nullable" : true }, "projectUpdateId" : { "type" : "integer", "description" : "Project Update for the Photo Album. Values in this field come from the primary key of the Project updates table", "nullable" : true }, "publishDate" : { "type" : "string", "format" : "date-time", "description" : "Publish Date for the Photo Album.", "readOnly" : true, "nullable" : true }, "shortName" : { "type" : "string", "description" : "Short Name for the Photo Album.", "maxLength" : 40 }, "slug" : { "type" : "string", "description" : "Slug for the Photo Album.", "maxLength" : 100 }, "sortOrder" : { "type" : "integer", "description" : "Sort Order for the Photo Album.", "nullable" : true }, "title" : { "type" : "string", "description" : "Title for the Photo Album.", "nullable" : true, "maxLength" : 200 }, "weather" : { "type" : "string", "description" : "Weather for the Photo Album.", "nullable" : true, "maxLength" : 100 } } }, "albumSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/album" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "albumFolder" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "Description for the Photo Album Folder.", "nullable" : true, "maxLength" : 500 }, "folderImageUrl" : { "type" : "string", "description" : "Folder Image Url for the Photo Album Folder.", "nullable" : true, "maxLength" : 500 }, "id" : { "type" : "integer", "description" : "Id for the Photo Album Folder.", "readOnly" : true, "nullable" : true }, "metaDescription" : { "type" : "string", "description" : "Meta Description for the Photo Album Folder.", "nullable" : true, "maxLength" : 500 }, "metaTitle" : { "type" : "string", "description" : "Meta Title for the Photo Album Folder.", "nullable" : true, "maxLength" : 255 }, "name" : { "type" : "string", "description" : "Name for the Photo Album Folder.", "maxLength" : 100 }, "parentId" : { "type" : "integer", "description" : "Parent for the Photo Album Folder. Values in this field come from the primary key of the Photo Album Folder table", "nullable" : true }, "slug" : { "type" : "string", "description" : "Slug for the Photo Album Folder.", "maxLength" : 100 }, "sortOrder" : { "type" : "integer", "description" : "Sort Order for the Photo Album Folder.", "nullable" : true } } }, "albumFolderSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/albumFolder" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "photoTag" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "Description for the Photo Tag.", "nullable" : true, "maxLength" : 255 }, "id" : { "type" : "integer", "description" : "Id for the Photo Tag.", "readOnly" : true, "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the Photo Tag.", "maxLength" : 100 }, "slug" : { "type" : "string", "description" : "Slug for the Photo Tag.", "maxLength" : 100 } } }, "photoTagSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/photoTag" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "projectCategory" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "Description for the Project categories.", "nullable" : true, "maxLength" : 1000 }, "featuredImage" : { "type" : "string", "description" : "Featured Image for the Project categories.", "readOnly" : true, "nullable" : true, "maxLength" : 500 }, "featuredMediaId" : { "type" : "integer", "description" : "Featured Media for the Project categories. Values in this field come from the primary key of the Media table", "nullable" : true }, "id" : { "type" : "integer", "description" : "Id for the Project categories.", "readOnly" : true, "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the Project categories.", "maxLength" : 100 }, "section" : { "type" : "string", "description" : "Section for the Project categories. Value definitions are: SOFTWARE=Software projects and PERSONAL=Personal projects", "maxLength" : 20, "enum" : [ "SOFTWARE", "PERSONAL" ] }, "slug" : { "type" : "string", "description" : "Slug for the Project categories.", "maxLength" : 100 }, "sortOrder" : { "type" : "integer", "description" : "Sort Order for the Project categories." }, "title" : { "type" : "string", "description" : "Title for the Project categories.", "maxLength" : 200 } } }, "projectCategorySearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/projectCategory" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "projectUpdate" : { "type" : "object", "properties" : { "content" : { "type" : "string", "description" : "Content for the Project updates." }, "excerpt" : { "type" : "string", "description" : "Excerpt for the Project updates.", "nullable" : true, "maxLength" : 1000 }, "featuredImage" : { "type" : "string", "description" : "Featured Image for the Project updates.", "readOnly" : true, "nullable" : true, "maxLength" : 500 }, "featuredMediaId" : { "type" : "integer", "description" : "Featured Media for the Project updates. Values in this field come from the primary key of the Media table", "nullable" : true }, "id" : { "type" : "integer", "description" : "Id for the Project updates.", "readOnly" : true, "nullable" : true }, "projectId" : { "type" : "integer", "description" : "Project for the Project updates. Values in this field come from the primary key of the Projects table" }, "publishDate" : { "type" : "string", "format" : "date-time", "description" : "Publish Date for the Project updates.", "nullable" : true }, "slug" : { "type" : "string", "description" : "Slug for the Project updates.", "maxLength" : 100 }, "sortOrder" : { "type" : "integer", "description" : "Sort Order for the Project updates." }, "title" : { "type" : "string", "description" : "Title for the Project updates.", "maxLength" : 200 }, "updateDate" : { "type" : "string", "format" : "date-time", "description" : "Update Date for the Project updates." } } }, "projectUpdateSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/projectUpdate" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "project" : { "type" : "object", "properties" : { "categoryId" : { "type" : "integer", "description" : "Category for the Projects. Values in this field come from the primary key of the Project categories table" }, "content" : { "type" : "string", "description" : "Content for the Projects.", "nullable" : true }, "description" : { "type" : "string", "description" : "Description for the Projects.", "nullable" : true }, "endDate" : { "type" : "string", "format" : "date-time", "description" : "End Date for the Projects.", "nullable" : true }, "featuredImage" : { "type" : "string", "description" : "Featured Image for the Projects.", "readOnly" : true, "nullable" : true, "maxLength" : 255 }, "featuredMediaId" : { "type" : "integer", "description" : "Featured Media for the Projects. Values in this field come from the primary key of the Media table", "nullable" : true }, "githubUrl" : { "type" : "string", "description" : "Github Url for the Projects.", "nullable" : true, "maxLength" : 255 }, "imageFocalX" : { "type" : "integer", "description" : "Horizontal focal point (%) for the Projects.", "nullable" : true }, "id" : { "type" : "integer", "description" : "Id for the Projects.", "readOnly" : true, "nullable" : true }, "imageCaption" : { "type" : "string", "description" : "Image Caption for the Projects.", "nullable" : true, "maxLength" : 1000 }, "imageAlt" : { "type" : "string", "description" : "Image description for the Projects.", "nullable" : true, "maxLength" : 500 }, "isFeatured" : { "type" : "boolean", "description" : "Is Featured for the Projects." }, "liveUrl" : { "type" : "string", "description" : "Live Url for the Projects.", "nullable" : true, "maxLength" : 255 }, "modifyDate" : { "type" : "string", "format" : "date-time", "description" : "Modify Date for the Projects.", "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the Projects.", "maxLength" : 100 }, "projectStatus" : { "type" : "string", "description" : "Project Status for the Projects." }, "publishDate" : { "type" : "string", "format" : "date-time", "description" : "Publish Date for the Projects.", "nullable" : true }, "shortName" : { "type" : "string", "description" : "Short Name for the Projects.", "maxLength" : 20 }, "slug" : { "type" : "string", "description" : "Slug for the Projects.", "maxLength" : 100 }, "sortOrder" : { "type" : "integer", "description" : "Sort Order for the Projects.", "nullable" : true }, "startDate" : { "type" : "string", "format" : "date-time", "description" : "Start Date for the Projects.", "nullable" : true }, "title" : { "type" : "string", "description" : "Title for the Projects.", "maxLength" : 200 }, "imageFocalY" : { "type" : "integer", "description" : "Vertical focal point (%) for the Projects.", "nullable" : true } } }, "projectSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/project" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "redirectType" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Code for the Redirect Types.", "maxLength" : 50 }, "httpStatusCode" : { "type" : "integer", "description" : "Http Status Code for the Redirect Types." }, "id" : { "type" : "integer", "description" : "Id for the Redirect Types.", "readOnly" : true, "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the Redirect Types.", "maxLength" : 100 } } }, "redirectTypeSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/redirectType" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "redirect" : { "type" : "object", "properties" : { "expiryDate" : { "type" : "string", "format" : "date-time", "description" : "Expiry Date for the Redirects.", "nullable" : true }, "id" : { "type" : "integer", "description" : "Id for the Redirects.", "readOnly" : true, "nullable" : true }, "matchType" : { "type" : "string", "description" : "Match Type for the Redirects.", "maxLength" : 20 }, "preserveQueryParams" : { "type" : "boolean", "description" : "Preserve Query Params for the Redirects.", "nullable" : true }, "priority" : { "type" : "integer", "description" : "Priority for the Redirects.", "nullable" : true }, "redirectTypeId" : { "type" : "integer", "description" : "Redirect Type for the Redirects. Values in this field come from the primary key of the Redirect Types table" }, "sourcePath" : { "type" : "string", "description" : "Source Path for the Redirects.", "maxLength" : 500 }, "targetPath" : { "type" : "string", "description" : "Target Path for the Redirects.", "maxLength" : 500 } } }, "redirectSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/redirect" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "site" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "Description for the Sites.", "nullable" : true, "maxLength" : 255 }, "id" : { "type" : "integer", "description" : "Id for the Sites.", "readOnly" : true, "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the Sites.", "maxLength" : 40 }, "shortName" : { "type" : "string", "description" : "Short Name for the Sites.", "maxLength" : 20 } } }, "siteSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/site" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "snippet" : { "type" : "object", "properties" : { "content" : { "type" : "string", "description" : "Content for the Snippets.", "nullable" : true }, "cssClassName" : { "type" : "string", "description" : "Css Class Name for the Snippets.", "nullable" : true, "maxLength" : 255 }, "id" : { "type" : "integer", "description" : "Id for the Snippets.", "readOnly" : true, "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the Snippets.", "maxLength" : 100 }, "shortName" : { "type" : "string", "description" : "Short Name for the Snippets.", "maxLength" : 50 }, "sortOrder" : { "type" : "integer", "description" : "Sort Order for the Snippets.", "nullable" : true } } }, "snippetSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/snippet" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "tag" : { "type" : "object", "properties" : { "blogId" : { "type" : "integer", "description" : "Blog for the Tags. Values in this field come from the primary key of the Blogs table" }, "description" : { "type" : "string", "description" : "Description for the Tags.", "nullable" : true, "maxLength" : 255 }, "id" : { "type" : "integer", "description" : "Id for the Tags.", "readOnly" : true, "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the Tags.", "maxLength" : 40 }, "slug" : { "type" : "string", "description" : "Slug for the Tags.", "maxLength" : 40 } } }, "tagSearchResult" : { "type" : "object", "properties" : { "records" : { "type" : "array", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/tag" } ] } } }, "allOf" : [ { "$ref" : "#/components/schemas/baseSearchResultFields" } ] }, "pageSection" : { "type" : "object", "properties" : { "content" : { "type" : "string", "description" : "Content for the Page Sections.", "nullable" : true }, "cssClassName" : { "type" : "string", "description" : "Css Class Name for the Page Sections.", "nullable" : true, "maxLength" : 255 }, "id" : { "type" : "integer", "description" : "Id for the Page Sections.", "readOnly" : true, "nullable" : true }, "name" : { "type" : "string", "description" : "Name for the Page Sections.", "maxLength" : 100 }, "sectionTypeId" : { "type" : "integer", "description" : "Section Type for the Page Sections. Values in this field come from the primary key of the Page Section Types table" }, "sortOrder" : { "type" : "integer", "description" : "Sort Order for the Page Sections.", "nullable" : true } }, "description" : "A content block inside a page." }, "postTagLink" : { "type" : "object", "properties" : { "tagId" : { "type" : "integer", "description" : "Blog Tag for the Blog Post Tags. Values in this field come from the primary key of the Tags table" } }, "description" : "A tag applied to a post (resolve `tagId` with /tag)." }, "postMedia" : { "type" : "object", "properties" : { "altText" : { "type" : "string", "description" : "Alt Text for the Blog Post Media.", "nullable" : true, "maxLength" : 1000 }, "caption" : { "type" : "string", "description" : "Caption for the Blog Post Media.", "nullable" : true, "maxLength" : 2000 }, "height" : { "type" : "integer", "description" : "Height for the Blog Post Media.", "nullable" : true }, "mediaId" : { "type" : "integer", "description" : "Media for the Blog Post Media. Values in this field come from the primary key of the Media table" }, "sortOrder" : { "type" : "integer", "description" : "Sort Order for the Blog Post Media." }, "thumbnailUrl" : { "type" : "string", "description" : "Thumbnail Url for the Blog Post Media.", "nullable" : true, "maxLength" : 1000 }, "url" : { "type" : "string", "description" : "Url for the Blog Post Media.", "maxLength" : 1000 }, "width" : { "type" : "integer", "description" : "Width for the Blog Post Media.", "nullable" : true } }, "description" : "A photo attached to a post, in display order." }, "menuItem" : { "type" : "object", "properties" : { "cssClasses" : { "type" : "string", "description" : "Css Classes for the Menu Items.", "nullable" : true, "maxLength" : 200 }, "description" : { "type" : "string", "description" : "Description for the Menu Items.", "nullable" : true, "maxLength" : 255 }, "displayOrder" : { "type" : "integer", "description" : "Display Order for the Menu Items." }, "icon" : { "type" : "string", "description" : "Icon for the Menu Items.", "nullable" : true, "maxLength" : 100 }, "id" : { "type" : "integer", "description" : "Id for the Menu Items.", "readOnly" : true, "nullable" : true }, "itemType" : { "type" : "string", "description" : "Item Type for the Menu Items.", "maxLength" : 50 }, "linkUrl" : { "type" : "string", "description" : "Link Url for the Menu Items.", "nullable" : true, "maxLength" : 500 }, "name" : { "type" : "string", "description" : "Name for the Menu Items.", "maxLength" : 100 }, "parentId" : { "type" : "integer", "description" : "Parent for the Menu Items. Values in this field come from the primary key of the Menu Items table", "nullable" : true }, "routePath" : { "type" : "string", "description" : "Route Path for the Menu Items.", "nullable" : true, "maxLength" : 200 }, "slug" : { "type" : "string", "description" : "Slug for the Menu Items.", "maxLength" : 100 }, "target" : { "type" : "string", "description" : "Target for the Menu Items.", "nullable" : true, "maxLength" : 20 } }, "description" : "An active navigation item (tree via `parentId`)." }, "photoTagLink" : { "type" : "object", "properties" : { "tagId" : { "type" : "integer", "description" : "Photo Tag for the Photo Tags. Values in this field come from the primary key of the Photo Tag table" } }, "description" : "A tag applied to a photo (resolve `tagId` with /photoTag)." }, "Error" : { "type" : "object", "required" : [ "error" ], "properties" : { "error" : { "$ref" : "#/components/schemas/ErrorBody" } } }, "ErrorBody" : { "type" : "object", "required" : [ "code", "message", "status" ], "properties" : { "code" : { "type" : "string", "description" : "Machine-readable code, e.g. validation_failed" }, "message" : { "type" : "string" }, "status" : { "type" : "integer" }, "details" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ErrorDetail" } } } }, "ErrorDetail" : { "type" : "object", "required" : [ "field", "issue" ], "properties" : { "field" : { "type" : "string" }, "issue" : { "type" : "string" } } }, "Versions" : { "type" : "object", "required" : [ "currentVersion", "supportedVersions", "versions" ], "properties" : { "currentVersion" : { "type" : "string", "example" : "v1" }, "supportedVersions" : { "type" : "array", "items" : { "type" : "string" } }, "versions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/VersionInfo" } } } }, "VersionInfo" : { "type" : "object", "required" : [ "version", "semver", "status", "docsUrl", "openapiUrl" ], "properties" : { "version" : { "type" : "string", "example" : "v1" }, "semver" : { "type" : "string", "example" : "1.0.0" }, "status" : { "type" : "string", "enum" : [ "current", "deprecated" ] }, "released" : { "type" : "string", "format" : "date" }, "docsUrl" : { "type" : "string" }, "openapiUrl" : { "type" : "string" }, "changelog" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReleaseNote" } } } }, "ReleaseNote" : { "type" : "object", "required" : [ "version", "date", "changes" ], "properties" : { "version" : { "type" : "string" }, "date" : { "type" : "string", "format" : "date" }, "changes" : { "type" : "array", "items" : { "type" : "string" } } } }, "SearchResults" : { "type" : "object", "required" : [ "query", "results" ], "properties" : { "query" : { "type" : "string" }, "results" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SearchHit" } } } }, "SearchHit" : { "type" : "object", "required" : [ "type", "id", "title", "url" ], "properties" : { "type" : { "type" : "string", "enum" : [ "post", "page", "project", "album", "photo" ] }, "id" : { "type" : "integer", "format" : "int64" }, "title" : { "type" : "string" }, "url" : { "type" : "string", "description" : "Website URL of the result" }, "snippet" : { "type" : "string", "nullable" : true }, "score" : { "type" : "number", "format" : "float", "nullable" : true } } }, "ContactRequest" : { "type" : "object", "required" : [ "name", "email", "message" ], "properties" : { "name" : { "type" : "string", "maxLength" : 200 }, "email" : { "type" : "string", "format" : "email", "maxLength" : 320 }, "subject" : { "type" : "string", "maxLength" : 200 }, "message" : { "type" : "string", "minLength" : 10, "maxLength" : 5000 }, "website" : { "type" : "string", "description" : "Honeypot. Must be empty." }, "startedAt" : { "type" : "integer", "format" : "int64", "description" : "Epoch milliseconds when the form was shown." } } }, "ContactAccepted" : { "type" : "object", "required" : [ "status" ], "properties" : { "status" : { "type" : "string", "enum" : [ "accepted" ] } } }, "JsonFeed" : { "type" : "object", "description" : "A JSON Feed 1.1 document (https://www.jsonfeed.org/version/1.1/).", "additionalProperties" : true, "properties" : { "version" : { "type" : "string" }, "title" : { "type" : "string" }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JsonFeedItem" } } } }, "JsonFeedItem" : { "type" : "object", "additionalProperties" : true, "properties" : { "id" : { "type" : "string" }, "url" : { "type" : "string" }, "title" : { "type" : "string" }, "content_text" : { "type" : "string" }, "content_html" : { "type" : "string" }, "summary" : { "type" : "string" }, "date_published" : { "type" : "string", "format" : "date-time" } } }, "Me" : { "type" : "object", "required" : [ "email", "groups", "canPost", "blogs", "defaultBlog", "limits" ], "properties" : { "email" : { "type" : "string" }, "name" : { "type" : "string", "nullable" : true }, "groups" : { "type" : "array", "items" : { "type" : "string" } }, "author" : { "$ref" : "#/components/schemas/AuthorRef" }, "canPost" : { "type" : "boolean" }, "blogs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BlogRef" } }, "defaultBlog" : { "type" : "string" }, "limits" : { "$ref" : "#/components/schemas/AuthoringLimits" } } }, "AuthorRef" : { "type" : "object", "nullable" : true, "required" : [ "id", "name", "slug" ], "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "slug" : { "type" : "string" } } }, "BlogRef" : { "type" : "object", "required" : [ "id", "slug", "name", "isDefault" ], "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "slug" : { "type" : "string" }, "name" : { "type" : "string" }, "isDefault" : { "type" : "boolean" } } }, "AuthoringLimits" : { "type" : "object", "required" : [ "maxBodyLength", "maxTitleLength", "maxTags", "maxPhotosPerPost", "maxPhotoBytes", "photoContentTypes" ], "properties" : { "maxBodyLength" : { "type" : "integer" }, "maxTitleLength" : { "type" : "integer" }, "maxTags" : { "type" : "integer" }, "maxPhotosPerPost" : { "type" : "integer" }, "maxPhotoBytes" : { "type" : "integer", "format" : "int64" }, "photoContentTypes" : { "type" : "array", "items" : { "type" : "string" } } } }, "PostStatus" : { "type" : "string", "enum" : [ "draft", "scheduled", "published" ] }, "AuthoringPost" : { "type" : "object", "required" : [ "id", "blogId", "blog", "status", "title", "body", "slug", "tags", "media", "version" ], "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "blogId" : { "type" : "integer", "format" : "int64" }, "blog" : { "type" : "string", "description" : "Blog slug" }, "status" : { "$ref" : "#/components/schemas/PostStatus" }, "title" : { "type" : "string" }, "body" : { "type" : "string", "description" : "Markdown" }, "slug" : { "type" : "string" }, "url" : { "type" : "string", "nullable" : true, "description" : "Public URL once published" }, "publishAt" : { "type" : "string", "format" : "date-time", "nullable" : true, "description" : "Scheduled publish time" }, "publishedAt" : { "type" : "string", "format" : "date-time", "nullable" : true }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "locationLabel" : { "type" : "string", "nullable" : true }, "link" : { "$ref" : "#/components/schemas/PostLink" }, "media" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PostPhoto" } }, "createdAt" : { "type" : "string", "format" : "date-time", "nullable" : true }, "updatedAt" : { "type" : "string", "format" : "date-time", "nullable" : true }, "version" : { "type" : "string", "description" : "Same value as the ETag (without quotes)" } } }, "PostLink" : { "type" : "object", "nullable" : true, "required" : [ "url" ], "properties" : { "url" : { "type" : "string" }, "title" : { "type" : "string", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "imageUrl" : { "type" : "string", "nullable" : true } } }, "PostPhoto" : { "type" : "object", "required" : [ "mediaId", "url" ], "properties" : { "mediaId" : { "type" : "integer", "format" : "int64" }, "url" : { "type" : "string" }, "thumbnailUrl" : { "type" : "string", "nullable" : true }, "width" : { "type" : "integer", "nullable" : true }, "height" : { "type" : "integer", "nullable" : true }, "altText" : { "type" : "string", "nullable" : true }, "caption" : { "type" : "string", "nullable" : true } } }, "PostPage" : { "type" : "object", "required" : [ "items" ], "properties" : { "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AuthoringPost" } }, "nextCursor" : { "type" : "string", "nullable" : true } } }, "MediaAttachment" : { "type" : "object", "required" : [ "mediaId" ], "properties" : { "mediaId" : { "type" : "integer", "format" : "int64" }, "altText" : { "type" : "string", "maxLength" : 1000 }, "caption" : { "type" : "string", "maxLength" : 2000 } } }, "PostCreate" : { "type" : "object", "required" : [ "body" ], "properties" : { "blog" : { "type" : "string", "description" : "Blog slug (default quick-bits)" }, "title" : { "type" : "string", "maxLength" : 100, "description" : "Optional; derived from the first line of the body when omitted" }, "body" : { "type" : "string", "maxLength" : 10000, "description" : "Markdown" }, "status" : { "$ref" : "#/components/schemas/PostStatus" }, "publishAt" : { "type" : "string", "format" : "date-time", "description" : "Required when status is scheduled" }, "tags" : { "type" : "array", "maxItems" : 10, "items" : { "type" : "string", "maxLength" : 50 } }, "locationLabel" : { "type" : "string", "maxLength" : 200 }, "linkUrl" : { "type" : "string", "maxLength" : 2000, "description" : "Link to preview server-side" }, "media" : { "type" : "array", "maxItems" : 20, "items" : { "$ref" : "#/components/schemas/MediaAttachment" } } } }, "PostUpdate" : { "type" : "object", "properties" : { "blog" : { "type" : "string" }, "title" : { "type" : "string", "maxLength" : 100, "nullable" : true }, "body" : { "type" : "string", "maxLength" : 10000 }, "status" : { "$ref" : "#/components/schemas/PostStatus" }, "publishAt" : { "type" : "string", "format" : "date-time" }, "tags" : { "type" : "array", "maxItems" : 10, "items" : { "type" : "string", "maxLength" : 50 } }, "locationLabel" : { "type" : "string", "maxLength" : 200, "nullable" : true }, "linkUrl" : { "type" : "string", "maxLength" : 2000, "nullable" : true }, "media" : { "type" : "array", "maxItems" : 20, "items" : { "$ref" : "#/components/schemas/MediaAttachment" } } } }, "UploadCreate" : { "type" : "object", "required" : [ "fileName", "contentType", "byteSize" ], "properties" : { "fileName" : { "type" : "string", "maxLength" : 255 }, "contentType" : { "type" : "string", "enum" : [ "image/jpeg", "image/png", "image/heic", "image/heif" ] }, "byteSize" : { "type" : "integer", "format" : "int64", "maximum" : 26214400 } } }, "UploadTicket" : { "type" : "object", "required" : [ "uploadId", "uploadUrl", "method", "headers", "expiresAt", "maxBytes", "completeUrl" ], "properties" : { "uploadId" : { "type" : "string", "format" : "uuid" }, "uploadUrl" : { "type" : "string", "description" : "Presigned URL; PUT the raw file bytes here" }, "method" : { "type" : "string", "enum" : [ "PUT" ] }, "headers" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "Headers to send with the PUT (Content-Type)" }, "expiresAt" : { "type" : "string", "format" : "date-time" }, "maxBytes" : { "type" : "integer", "format" : "int64" }, "completeUrl" : { "type" : "string" } } }, "UploadComplete" : { "type" : "object", "properties" : { "altText" : { "type" : "string", "maxLength" : 1000 }, "caption" : { "type" : "string", "maxLength" : 2000 }, "keepLocation" : { "type" : "boolean", "default" : false, "description" : "Keep EXIF including GPS (published publicly!)" } } }, "MediaItem" : { "type" : "object", "required" : [ "mediaId", "url", "mimeType", "locationRemoved" ], "properties" : { "mediaId" : { "type" : "integer", "format" : "int64" }, "url" : { "type" : "string" }, "thumbnailUrl" : { "type" : "string", "nullable" : true }, "width" : { "type" : "integer", "nullable" : true }, "height" : { "type" : "integer", "nullable" : true }, "mimeType" : { "type" : "string" }, "altText" : { "type" : "string", "nullable" : true }, "caption" : { "type" : "string", "nullable" : true }, "locationRemoved" : { "type" : "boolean" } } }, "TagList" : { "type" : "object", "required" : [ "items" ], "properties" : { "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AuthoringTag" } } } }, "AuthoringTag" : { "type" : "object", "required" : [ "id", "name", "slug", "blogId" ], "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "slug" : { "type" : "string" }, "blogId" : { "type" : "integer", "format" : "int64" } } }, "LinkPreviewRequest" : { "type" : "object", "required" : [ "url" ], "properties" : { "url" : { "type" : "string", "maxLength" : 2000 } } }, "LinkPreview" : { "type" : "object", "required" : [ "url" ], "properties" : { "url" : { "type" : "string" }, "title" : { "type" : "string", "nullable" : true }, "description" : { "type" : "string", "nullable" : true }, "imageUrl" : { "type" : "string", "nullable" : true } } } }, "responses" : { "error400" : { "description" : "Bad Request. Some portion of the request's content was not acceptable to the server. See error message in body for details.", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "error" : { "type" : "string", "example" : "Parameter id should be given an integer value, but received string: \"Foo\"" } } } } } }, "error401" : { "description" : "Unauthorized. The required authentication credentials were missing or invalid.", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "error" : { "type" : "string", "example" : "The required authentication credentials were missing or invalid." } } } } } }, "error403" : { "description" : "Forbidden. You do not have permission to access the requested resource.", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "error" : { "type" : "string", "example" : "You do not have permission to access the requested resource." } } } } } }, "error500" : { "description" : "Internal Server Error. An error occurred in the server while processing the request.", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "error" : { "type" : "string", "example" : "Database connection error. Try again later." } } } } } }, "error429" : { "description" : "Too Many Requests. Your application has issued too many API requests in too short of a time frame.", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "error" : { "type" : "string", "example" : "Too Many Requests. Your application has issued too many API requests in too short of a time frame." } } } } } }, "BadRequest" : { "description" : "Malformed request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "Unauthorized" : { "description" : "Missing, expired or invalid bearer token", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "Forbidden" : { "description" : "Not allowed (scope, group or author profile)", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "NotFound" : { "description" : "Not found or not public", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "Conflict" : { "description" : "Conflict (idempotency key in flight, upload state, delete blocked)", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "PreconditionFailed" : { "description" : "If-Match does not match the current version", "headers" : { "ETag" : { "$ref" : "#/components/headers/ETag" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "PreconditionRequired" : { "description" : "If-Match is required", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "PayloadTooLarge" : { "description" : "Too large", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "UnsupportedMediaType" : { "description" : "Unsupported file type", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "ValidationFailed" : { "description" : "Validation failed", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "TooManyRequests" : { "description" : "Rate limited", "headers" : { "Retry-After" : { "$ref" : "#/components/headers/RetryAfter" } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } }, "ServiceUnavailable" : { "description" : "Temporarily unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } } }, "securitySchemes" : { "kof22OAuth" : { "type" : "oauth2", "description" : "Authentik OAuth2, Authorization Code with PKCE (S256), public client `kof22-post-ios`. Request `offline_access` for a refresh token.", "flows" : { "authorizationCode" : { "authorizationUrl" : "https://auth.kof22.com/application/o/authorize/", "tokenUrl" : "https://auth.kof22.com/application/o/token/", "refreshUrl" : "https://auth.kof22.com/application/o/token/", "scopes" : { "openid" : "OpenID Connect", "profile" : "Name and groups", "email" : "Email (identifies your author profile)", "offline_access" : "Refresh tokens", "kof22:publish" : "Publish posts and photos to kof22.com" } } } }, "bearerAuth" : { "type" : "http", "scheme" : "bearer", "bearerFormat" : "JWT", "description" : "An access token from the kof22OAuth flow, pasted directly." } }, "parameters" : { "BlogSlug" : { "name" : "blogSlug", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, "PostId" : { "name" : "postId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, "UploadId" : { "name" : "uploadId", "in" : "path", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, "IdempotencyKey" : { "name" : "Idempotency-Key", "in" : "header", "required" : false, "description" : "8-255 characters; the same key and body replays the first response for 24 hours.", "schema" : { "type" : "string", "minLength" : 8, "maxLength" : 255 } }, "IfMatch" : { "name" : "If-Match", "in" : "header", "required" : true, "description" : "The ETag from the last read of this post.", "schema" : { "type" : "string" } }, "IfMatchOptional" : { "name" : "If-Match", "in" : "header", "required" : false, "schema" : { "type" : "string" } } }, "headers" : { "ETag" : { "description" : "Version of the returned post, for If-Match.", "schema" : { "type" : "string" } }, "Location" : { "description" : "URL of the created resource.", "schema" : { "type" : "string" } }, "RetryAfter" : { "description" : "Seconds to wait before retrying.", "schema" : { "type" : "integer" } } } } }