{ "components": { "responses": { "errors": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "General Error" } }, "schemas": { "flashcard-filter-front": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "sanction_list_version-filter-fetched_at": { "additionalProperties": false, "properties": { "eq": {}, "greater_than": {}, "greater_than_or_equal": {}, "in": { "items": {}, "type": "array" }, "is_distinct_from": {}, "is_nil": { "type": "boolean" }, "is_not_distinct_from": {}, "less_than": {}, "less_than_or_equal": {}, "not_eq": {} }, "type": "object" }, "sanction_list_version-filter-byte_size": { "additionalProperties": false, "properties": { "eq": { "type": "integer" }, "greater_than": { "type": "integer" }, "greater_than_or_equal": { "type": "integer" }, "in": { "items": { "type": "integer" }, "type": "array" }, "is_distinct_from": { "type": "integer" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "integer" }, "less_than": { "type": "integer" }, "less_than_or_equal": { "type": "integer" }, "not_eq": { "type": "integer" } }, "type": "object" }, "flashcard_deck-filter-published": { "additionalProperties": false, "properties": { "eq": { "type": "boolean" }, "greater_than": { "type": "boolean" }, "greater_than_or_equal": { "type": "boolean" }, "in": { "items": { "type": "boolean" }, "type": "array" }, "is_distinct_from": { "type": "boolean" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "boolean" }, "less_than": { "type": "boolean" }, "less_than_or_equal": { "type": "boolean" }, "not_eq": { "type": "boolean" } }, "type": "object" }, "request_log-filter": { "additionalProperties": false, "description": "Filters the query to results matching the given filter object", "example": "", "properties": { "and": { "items": { "$ref": "#/components/schemas/request_log-filter" }, "type": "array", "uniqueItems": true }, "duration_ms": { "$ref": "#/components/schemas/request_log-filter-duration_ms" }, "id": { "$ref": "#/components/schemas/request_log-filter-id" }, "ip": { "$ref": "#/components/schemas/request_log-filter-ip" }, "ip_info": { "$ref": "#/components/schemas/ip_info-filter" }, "method": { "$ref": "#/components/schemas/request_log-filter-method" }, "not": { "$ref": "#/components/schemas/request_log-filter" }, "or": { "items": { "$ref": "#/components/schemas/request_log-filter" }, "type": "array", "uniqueItems": true }, "path": { "$ref": "#/components/schemas/request_log-filter-path" }, "referrer": { "$ref": "#/components/schemas/request_log-filter-referrer" }, "request_id": { "$ref": "#/components/schemas/request_log-filter-request_id" }, "status": { "$ref": "#/components/schemas/request_log-filter-status" }, "timestamp": { "$ref": "#/components/schemas/request_log-filter-timestamp" }, "user_agent": { "$ref": "#/components/schemas/request_log-filter-user_agent" } }, "type": "object" }, "sanction_list_version-filter-content_type": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "flashcard_deck-filter": { "additionalProperties": false, "description": "Filters the query to results matching the given filter object", "example": "", "properties": { "and": { "items": { "$ref": "#/components/schemas/flashcard_deck-filter" }, "type": "array", "uniqueItems": true }, "author_email": { "$ref": "#/components/schemas/flashcard_deck-filter-author_email" }, "cards": { "$ref": "#/components/schemas/flashcard-filter" }, "id": { "$ref": "#/components/schemas/flashcard_deck-filter-id" }, "name": { "$ref": "#/components/schemas/flashcard_deck-filter-name" }, "not": { "$ref": "#/components/schemas/flashcard_deck-filter" }, "or": { "items": { "$ref": "#/components/schemas/flashcard_deck-filter" }, "type": "array", "uniqueItems": true }, "published": { "$ref": "#/components/schemas/flashcard_deck-filter-published" } }, "type": "object" }, "request_log-filter-duration_ms": { "additionalProperties": false, "properties": { "eq": { "type": "integer" }, "greater_than": { "type": "integer" }, "greater_than_or_equal": { "type": "integer" }, "in": { "items": { "type": "integer" }, "type": "array" }, "is_distinct_from": { "type": "integer" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "integer" }, "less_than": { "type": "integer" }, "less_than_or_equal": { "type": "integer" }, "not_eq": { "type": "integer" } }, "type": "object" }, "ip_info-filter-country": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "flashcard_image_upload": { "additionalProperties": false, "description": "A \"Resource object\" representing a flashcard_image_upload", "properties": { "attributes": { "additionalProperties": false, "properties": {}, "type": "object" }, "id": { "example": "", "type": "string" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" }, "relationships": { "additionalProperties": false, "description": "A relationships object for a flashcard_image_upload", "properties": {}, "type": "object" }, "type": { "enum": [ "flashcard_image_upload" ], "example": "flashcard_image_upload", "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "links": { "additionalProperties": { "$ref": "#/components/schemas/link" }, "type": "object" }, "flashcard-filter-id": { "additionalProperties": false, "properties": { "eq": { "format": "uuid", "type": "string" }, "greater_than": { "format": "uuid", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "type": "string" }, "in": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "type": "string" }, "less_than": { "format": "uuid", "type": "string" }, "less_than_or_equal": { "format": "uuid", "type": "string" }, "not_eq": { "format": "uuid", "type": "string" } }, "type": "object" }, "ip_info": { "additionalProperties": false, "description": "A \"Resource object\" representing a ip_info", "properties": { "attributes": { "additionalProperties": false, "properties": { "as_domain": { "example": "example.net", "minLength": 1, "nullable": true, "type": "string" }, "as_name": { "example": "Example Networks", "minLength": 1, "nullable": true, "type": "string" }, "asn": { "example": "AS64500", "minLength": 1, "nullable": true, "type": "string" }, "continent": { "example": "Europe", "minLength": 1, "nullable": true, "type": "string" }, "continent_code": { "example": "EU", "minLength": 1, "nullable": true, "type": "string" }, "country": { "example": "Poland", "minLength": 1, "nullable": true, "type": "string" }, "country_code": { "example": "PL", "minLength": 1, "nullable": true, "type": "string" } }, "type": "object" }, "id": { "example": "1", "type": "string" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" }, "relationships": { "additionalProperties": false, "description": "A relationships object for a ip_info", "properties": {}, "type": "object" }, "type": { "enum": [ "ip_info" ], "example": "ip_info", "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "sanction_list_version-filter-sha256": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "request_log-filter-ip": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "ip_info-filter": { "additionalProperties": false, "description": "Filters the query to results matching the given filter object", "example": "", "properties": { "and": { "items": { "$ref": "#/components/schemas/ip_info-filter" }, "type": "array", "uniqueItems": true }, "as_name": { "$ref": "#/components/schemas/ip_info-filter-as_name" }, "continent": { "$ref": "#/components/schemas/ip_info-filter-continent" }, "country": { "$ref": "#/components/schemas/ip_info-filter-country" }, "id": { "$ref": "#/components/schemas/ip_info-filter-id" }, "not": { "$ref": "#/components/schemas/ip_info-filter" }, "or": { "items": { "$ref": "#/components/schemas/ip_info-filter" }, "type": "array", "uniqueItems": true } }, "type": "object" }, "sanction_list_version-filter-storage_key": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "sanction_list_version-filter-source_slug": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "ip_info-filter-continent": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "flashcard-filter--getFlashcardDeck": { "additionalProperties": false, "minProperties": 1, "properties": { "and": { "items": { "$ref": "#/components/schemas/flashcard-filter--getFlashcardDeck" }, "minItems": 1, "type": "array", "uniqueItems": true }, "back": { "additionalProperties": false, "minProperties": 1, "properties": { "contains": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "eq": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than_or_equal": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "ilike": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "in": { "items": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "type": "array" }, "is_distinct_from": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than_or_equal": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "like": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "not_eq": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_ends_with": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_starts_with": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] } }, "type": "object" }, "decks": { "$ref": "#/components/schemas/flashcard_deck-filter--getFlashcardDeck" }, "editor_notes": { "additionalProperties": false, "minProperties": 1, "properties": { "contains": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "eq": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than_or_equal": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "ilike": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "in": { "items": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "type": "array" }, "is_distinct_from": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than_or_equal": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "like": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "not_eq": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_ends_with": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_starts_with": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] } }, "type": "object" }, "front": { "additionalProperties": false, "minProperties": 1, "properties": { "contains": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "eq": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than_or_equal": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "ilike": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "in": { "items": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "type": "array" }, "is_distinct_from": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than_or_equal": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "like": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "not_eq": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_ends_with": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_starts_with": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] } }, "type": "object" }, "id": { "additionalProperties": false, "minProperties": 1, "properties": { "eq": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "in": { "items": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than_or_equal": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "not_eq": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" } }, "type": "object" }, "not": { "$ref": "#/components/schemas/flashcard-filter--getFlashcardDeck" }, "or": { "items": { "$ref": "#/components/schemas/flashcard-filter--getFlashcardDeck" }, "minItems": 1, "type": "array", "uniqueItems": true } }, "type": "object" }, "sanction_list_version-filter-record_count": { "additionalProperties": false, "properties": { "eq": { "type": "integer" }, "greater_than": { "type": "integer" }, "greater_than_or_equal": { "type": "integer" }, "in": { "items": { "type": "integer" }, "type": "array" }, "is_distinct_from": { "type": "integer" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "integer" }, "less_than": { "type": "integer" }, "less_than_or_equal": { "type": "integer" }, "not_eq": { "type": "integer" } }, "type": "object" }, "ip_info-filter-as_name": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "request_log-filter--listRequestLogs": { "additionalProperties": false, "maxProperties": 16, "minProperties": 1, "properties": { "and": { "items": { "$ref": "#/components/schemas/request_log-filter--listRequestLogs" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true }, "duration_ms": { "additionalProperties": false, "maxProperties": 16, "minProperties": 1, "properties": { "eq": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "greater_than": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "greater_than_or_equal": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "in": { "items": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "maxItems": 32, "type": "array" }, "is_distinct_from": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "less_than": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "less_than_or_equal": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "not_eq": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, "type": "object" }, "ip": { "additionalProperties": false, "maxProperties": 16, "minProperties": 1, "properties": { "contains": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "ilike": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "in": { "items": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "maxItems": 32, "type": "array" }, "is_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "like": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "not_eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_ends_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_starts_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" } }, "type": "object" }, "ip_info": { "$ref": "#/components/schemas/ip_info-filter--listRequestLogs" }, "method": { "additionalProperties": false, "maxProperties": 16, "minProperties": 1, "properties": { "contains": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "ilike": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "in": { "items": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "maxItems": 32, "type": "array" }, "is_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "like": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "not_eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_ends_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_starts_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" } }, "type": "object" }, "not": { "$ref": "#/components/schemas/request_log-filter--listRequestLogs" }, "or": { "items": { "$ref": "#/components/schemas/request_log-filter--listRequestLogs" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true }, "path": { "additionalProperties": false, "maxProperties": 16, "minProperties": 1, "properties": { "contains": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "ilike": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "in": { "items": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "maxItems": 32, "type": "array" }, "is_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "like": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "not_eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_ends_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_starts_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" } }, "type": "object" }, "referrer": { "additionalProperties": false, "maxProperties": 16, "minProperties": 1, "properties": { "contains": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "ilike": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "in": { "items": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "maxItems": 32, "type": "array" }, "is_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "like": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "not_eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_ends_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_starts_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" } }, "type": "object" }, "request_id": { "additionalProperties": false, "maxProperties": 16, "minProperties": 1, "properties": { "contains": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "ilike": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "in": { "items": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "maxItems": 32, "type": "array" }, "is_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "like": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "not_eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_ends_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_starts_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" } }, "type": "object" }, "status": { "additionalProperties": false, "maxProperties": 16, "minProperties": 1, "properties": { "eq": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "greater_than": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "greater_than_or_equal": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "in": { "items": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "maxItems": 32, "type": "array" }, "is_distinct_from": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "less_than": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "less_than_or_equal": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "not_eq": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, "type": "object" }, "timestamp": { "additionalProperties": false, "maxProperties": 16, "minProperties": 1, "properties": { "eq": {}, "greater_than": {}, "greater_than_or_equal": {}, "in": { "items": {}, "maxItems": 32, "type": "array" }, "is_distinct_from": {}, "is_nil": { "type": "boolean" }, "is_not_distinct_from": {}, "less_than": {}, "less_than_or_equal": {}, "not_eq": {} }, "type": "object" }, "user_agent": { "additionalProperties": false, "maxProperties": 16, "minProperties": 1, "properties": { "contains": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "ilike": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "in": { "items": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "maxItems": 32, "type": "array" }, "is_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "like": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "not_eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_ends_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_starts_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" } }, "type": "object" } }, "type": "object" }, "sanction_screening-filter": { "additionalProperties": false, "description": "Filters the query to results matching the given filter object", "example": "", "properties": { "and": { "items": { "$ref": "#/components/schemas/sanction_screening-filter" }, "type": "array", "uniqueItems": true }, "not": { "$ref": "#/components/schemas/sanction_screening-filter" }, "or": { "items": { "$ref": "#/components/schemas/sanction_screening-filter" }, "type": "array", "uniqueItems": true } }, "type": "object" }, "sanction_list_version-filter-parser_module": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "request_log-filter-status": { "additionalProperties": false, "properties": { "eq": { "type": "integer" }, "greater_than": { "type": "integer" }, "greater_than_or_equal": { "type": "integer" }, "in": { "items": { "type": "integer" }, "type": "array" }, "is_distinct_from": { "type": "integer" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "integer" }, "less_than": { "type": "integer" }, "less_than_or_equal": { "type": "integer" }, "not_eq": { "type": "integer" } }, "type": "object" }, "flashcard_deck-filter-name": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "flashcard_image_upload-filter": { "additionalProperties": false, "description": "Filters the query to results matching the given filter object", "example": "", "properties": { "and": { "items": { "$ref": "#/components/schemas/flashcard_image_upload-filter" }, "type": "array", "uniqueItems": true }, "not": { "$ref": "#/components/schemas/flashcard_image_upload-filter" }, "or": { "items": { "$ref": "#/components/schemas/flashcard_image_upload-filter" }, "type": "array", "uniqueItems": true } }, "type": "object" }, "link": { "description": "A link MUST be represented as either: a string containing the link's URL or a link object.", "type": "string" }, "request_log-filter-timestamp": { "additionalProperties": false, "properties": { "eq": {}, "greater_than": {}, "greater_than_or_equal": {}, "in": { "items": {}, "type": "array" }, "is_distinct_from": {}, "is_nil": { "type": "boolean" }, "is_not_distinct_from": {}, "less_than": {}, "less_than_or_equal": {}, "not_eq": {} }, "type": "object" }, "flashcard-filter-back": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "sanction_list-filter-slug": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "request_log-filter-id": { "additionalProperties": false, "properties": { "eq": { "type": "integer" }, "greater_than": { "type": "integer" }, "greater_than_or_equal": { "type": "integer" }, "in": { "items": { "type": "integer" }, "type": "array" }, "is_distinct_from": { "type": "integer" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "integer" }, "less_than": { "type": "integer" }, "less_than_or_equal": { "type": "integer" }, "not_eq": { "type": "integer" } }, "type": "object" }, "sanction_screening": { "additionalProperties": false, "description": "A \"Resource object\" representing a sanction_screening", "properties": { "attributes": { "additionalProperties": false, "properties": {}, "type": "object" }, "id": { "example": "", "type": "string" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" }, "relationships": { "additionalProperties": false, "description": "A relationships object for a sanction_screening", "properties": {}, "type": "object" }, "type": { "enum": [ "sanction_screening" ], "example": "sanction_screening", "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "error": { "additionalProperties": false, "properties": { "code": { "description": "An application-specific error code, expressed as a string value.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "type": "string" }, "links": { "$ref": "#/components/schemas/links" }, "meta": { "additionalProperties": true, "type": "object" }, "source": { "properties": { "parameter": { "description": "A string indicating which query parameter caused the error.", "type": "string" }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute].", "type": "string" } }, "type": "object" }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", "type": "string" } }, "type": "object" }, "flashcard_deck-filter--getFlashcardDeck": { "additionalProperties": false, "minProperties": 1, "properties": { "and": { "items": { "$ref": "#/components/schemas/flashcard_deck-filter--getFlashcardDeck" }, "minItems": 1, "type": "array", "uniqueItems": true }, "author_email": { "additionalProperties": false, "minProperties": 1, "properties": { "contains": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "eq": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than_or_equal": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "ilike": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "in": { "items": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "type": "array" }, "is_distinct_from": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than_or_equal": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "like": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "not_eq": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_ends_with": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_starts_with": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" } }, "type": "object" }, "cards": { "$ref": "#/components/schemas/flashcard-filter--getFlashcardDeck" }, "id": { "additionalProperties": false, "minProperties": 1, "properties": { "eq": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "in": { "items": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than_or_equal": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "not_eq": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" } }, "type": "object" }, "name": { "additionalProperties": false, "minProperties": 1, "properties": { "contains": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "eq": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than_or_equal": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "ilike": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "in": { "items": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "type": "array" }, "is_distinct_from": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than_or_equal": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "like": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "not_eq": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_ends_with": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_starts_with": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] } }, "type": "object" }, "not": { "$ref": "#/components/schemas/flashcard_deck-filter--getFlashcardDeck" }, "or": { "items": { "$ref": "#/components/schemas/flashcard_deck-filter--getFlashcardDeck" }, "minItems": 1, "type": "array", "uniqueItems": true }, "published": { "additionalProperties": false, "minProperties": 1, "properties": { "eq": { "type": "boolean" }, "greater_than": { "type": "boolean" }, "greater_than_or_equal": { "type": "boolean" }, "in": { "items": { "type": "boolean" }, "type": "array" }, "is_distinct_from": { "type": "boolean" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "boolean" }, "less_than": { "type": "boolean" }, "less_than_or_equal": { "type": "boolean" }, "not_eq": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "flashcard-filter--getFlashcard": { "additionalProperties": false, "minProperties": 1, "properties": { "and": { "items": { "$ref": "#/components/schemas/flashcard-filter--getFlashcard" }, "minItems": 1, "type": "array", "uniqueItems": true }, "back": { "additionalProperties": false, "minProperties": 1, "properties": { "contains": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "eq": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than_or_equal": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "ilike": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "in": { "items": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "type": "array" }, "is_distinct_from": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than_or_equal": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "like": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "not_eq": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_ends_with": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_starts_with": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] } }, "type": "object" }, "decks": { "$ref": "#/components/schemas/flashcard_deck-filter--getFlashcard" }, "editor_notes": { "additionalProperties": false, "minProperties": 1, "properties": { "contains": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "eq": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than_or_equal": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "ilike": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "in": { "items": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "type": "array" }, "is_distinct_from": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than_or_equal": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "like": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "not_eq": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_ends_with": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_starts_with": { "allOf": [ { "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] } }, "type": "object" }, "front": { "additionalProperties": false, "minProperties": 1, "properties": { "contains": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "eq": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than_or_equal": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "ilike": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "in": { "items": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "type": "array" }, "is_distinct_from": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than_or_equal": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "like": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "not_eq": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_ends_with": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_starts_with": { "allOf": [ { "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] } }, "type": "object" }, "id": { "additionalProperties": false, "minProperties": 1, "properties": { "eq": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "in": { "items": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than_or_equal": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "not_eq": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" } }, "type": "object" }, "not": { "$ref": "#/components/schemas/flashcard-filter--getFlashcard" }, "or": { "items": { "$ref": "#/components/schemas/flashcard-filter--getFlashcard" }, "minItems": 1, "type": "array", "uniqueItems": true } }, "type": "object" }, "sanction_list": { "additionalProperties": false, "description": "A \"Resource object\" representing a sanction_list", "properties": { "attributes": { "additionalProperties": false, "properties": { "active_version": { "additionalProperties": false, "nullable": true, "properties": { "byte_size": { "example": 1024, "type": "integer" }, "content_type": { "example": "application/xml", "minLength": 1, "type": "string" }, "fetched_at": { "example": "2026-07-12T12:00:00.000000Z", "format": "date_time", "type": "string" }, "id": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "last_seen_at": { "example": "2026-07-12T12:00:00.000000Z", "format": "date_time", "type": "string" }, "parser_module": { "example": "BlogEx.Sanctions.Parsers.Ofac", "minLength": 1, "type": "string" }, "publish_date": { "example": "2026-07-12", "format": "date", "nullable": true, "type": "string" }, "record_count": { "example": 12345, "type": "integer" }, "sha256": { "example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "minLength": 1, "type": "string" }, "source_slug": { "example": "ofac_sdn", "minLength": 1, "type": "string" }, "storage_key": { "example": "sanctions/ofac_sdn/example.xml", "minLength": 1, "type": "string" } }, "type": "object" }, "active_version_id": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "format": "uuid", "maxLength": 36, "minLength": 36, "nullable": true, "type": "string" }, "slug": { "example": "ofac_sdn", "minLength": 1, "type": "string" }, "versions": { "items": { "additionalProperties": false, "properties": { "byte_size": { "example": 1024, "type": "integer" }, "content_type": { "example": "application/xml", "minLength": 1, "type": "string" }, "fetched_at": { "example": "2026-07-12T12:00:00.000000Z", "format": "date_time", "type": "string" }, "id": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "last_seen_at": { "example": "2026-07-12T12:00:00.000000Z", "format": "date_time", "type": "string" }, "parser_module": { "example": "BlogEx.Sanctions.Parsers.Ofac", "minLength": 1, "type": "string" }, "publish_date": { "example": "2026-07-12", "format": "date", "nullable": true, "type": "string" }, "record_count": { "example": 12345, "type": "integer" }, "sha256": { "example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "minLength": 1, "type": "string" }, "source_slug": { "example": "ofac_sdn", "minLength": 1, "type": "string" }, "storage_key": { "example": "sanctions/ofac_sdn/example.xml", "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "id": { "example": "ofac_sdn", "minLength": 1, "type": "string" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" }, "relationships": { "additionalProperties": false, "description": "A relationships object for a sanction_list", "properties": { "active_version": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "description": "An identifier for active_version", "nullable": true, "properties": { "id": { "type": "string" }, "meta": { "additionalProperties": true, "type": "object" }, "type": { "enum": [ "sanction_list_version" ], "example": "sanction_list_version", "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "type": "object" }, "versions": { "additionalProperties": false, "properties": { "data": { "description": "Relationship data for versions", "items": { "additionalProperties": false, "description": "Resource identifiers for versions", "properties": { "id": { "type": "string" }, "meta": { "additionalProperties": true, "type": "object" }, "type": { "enum": [ "sanction_list_version" ], "example": "sanction_list_version", "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "type": "array", "uniqueItems": true }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "type": "object" } }, "type": "object" }, "type": { "enum": [ "sanction_list" ], "example": "sanction_list", "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "errors": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/error" }, "type": "array" }, "jsonapi": { "additionalProperties": true, "type": "object" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "required": [ "errors" ], "type": "object" }, "request_log-filter-path": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "request_log-filter-request_id": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "sanction_list-filter-active_version_id": { "additionalProperties": false, "properties": { "eq": { "format": "uuid", "type": "string" }, "greater_than": { "format": "uuid", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "type": "string" }, "in": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "type": "string" }, "less_than": { "format": "uuid", "type": "string" }, "less_than_or_equal": { "format": "uuid", "type": "string" }, "not_eq": { "format": "uuid", "type": "string" } }, "type": "object" }, "ip_info-filter-id": { "additionalProperties": false, "properties": { "eq": { "type": "integer" }, "greater_than": { "type": "integer" }, "greater_than_or_equal": { "type": "integer" }, "in": { "items": { "type": "integer" }, "type": "array" }, "is_distinct_from": { "type": "integer" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "integer" }, "less_than": { "type": "integer" }, "less_than_or_equal": { "type": "integer" }, "not_eq": { "type": "integer" } }, "type": "object" }, "flashcard_deck-filter-id": { "additionalProperties": false, "properties": { "eq": { "format": "uuid", "type": "string" }, "greater_than": { "format": "uuid", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "type": "string" }, "in": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "type": "string" }, "less_than": { "format": "uuid", "type": "string" }, "less_than_or_equal": { "format": "uuid", "type": "string" }, "not_eq": { "format": "uuid", "type": "string" } }, "type": "object" }, "flashcard-filter": { "additionalProperties": false, "description": "Filters the query to results matching the given filter object", "example": "", "properties": { "and": { "items": { "$ref": "#/components/schemas/flashcard-filter" }, "type": "array", "uniqueItems": true }, "back": { "$ref": "#/components/schemas/flashcard-filter-back" }, "decks": { "$ref": "#/components/schemas/flashcard_deck-filter" }, "editor_notes": { "$ref": "#/components/schemas/flashcard-filter-editor_notes" }, "front": { "$ref": "#/components/schemas/flashcard-filter-front" }, "id": { "$ref": "#/components/schemas/flashcard-filter-id" }, "not": { "$ref": "#/components/schemas/flashcard-filter" }, "or": { "items": { "$ref": "#/components/schemas/flashcard-filter" }, "type": "array", "uniqueItems": true } }, "type": "object" }, "sanction_list_version-filter-last_seen_at": { "additionalProperties": false, "properties": { "eq": {}, "greater_than": {}, "greater_than_or_equal": {}, "in": { "items": {}, "type": "array" }, "is_distinct_from": {}, "is_nil": { "type": "boolean" }, "is_not_distinct_from": {}, "less_than": {}, "less_than_or_equal": {}, "not_eq": {} }, "type": "object" }, "request_log-filter-method": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "sanction_list_version-filter-publish_date": { "additionalProperties": false, "properties": { "eq": { "format": "date", "type": "string" }, "greater_than": { "format": "date", "type": "string" }, "greater_than_or_equal": { "format": "date", "type": "string" }, "in": { "items": { "format": "date", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "date", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "date", "type": "string" }, "less_than": { "format": "date", "type": "string" }, "less_than_or_equal": { "format": "date", "type": "string" }, "not_eq": { "format": "date", "type": "string" } }, "type": "object" }, "sanction_list-filter-id": { "additionalProperties": false, "properties": { "eq": { "format": "uuid", "type": "string" }, "greater_than": { "format": "uuid", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "type": "string" }, "in": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "type": "string" }, "less_than": { "format": "uuid", "type": "string" }, "less_than_or_equal": { "format": "uuid", "type": "string" }, "not_eq": { "format": "uuid", "type": "string" } }, "type": "object" }, "sanction_list_version-filter": { "additionalProperties": false, "description": "Filters the query to results matching the given filter object", "example": "", "properties": { "and": { "items": { "$ref": "#/components/schemas/sanction_list_version-filter" }, "type": "array", "uniqueItems": true }, "byte_size": { "$ref": "#/components/schemas/sanction_list_version-filter-byte_size" }, "content_type": { "$ref": "#/components/schemas/sanction_list_version-filter-content_type" }, "fetched_at": { "$ref": "#/components/schemas/sanction_list_version-filter-fetched_at" }, "id": { "$ref": "#/components/schemas/sanction_list_version-filter-id" }, "last_seen_at": { "$ref": "#/components/schemas/sanction_list_version-filter-last_seen_at" }, "not": { "$ref": "#/components/schemas/sanction_list_version-filter" }, "or": { "items": { "$ref": "#/components/schemas/sanction_list_version-filter" }, "type": "array", "uniqueItems": true }, "parser_module": { "$ref": "#/components/schemas/sanction_list_version-filter-parser_module" }, "publish_date": { "$ref": "#/components/schemas/sanction_list_version-filter-publish_date" }, "record_count": { "$ref": "#/components/schemas/sanction_list_version-filter-record_count" }, "sha256": { "$ref": "#/components/schemas/sanction_list_version-filter-sha256" }, "source_slug": { "$ref": "#/components/schemas/sanction_list_version-filter-source_slug" }, "storage_key": { "$ref": "#/components/schemas/sanction_list_version-filter-storage_key" } }, "type": "object" }, "request_log": { "additionalProperties": false, "description": "A \"Resource object\" representing a request_log", "properties": { "attributes": { "additionalProperties": false, "properties": { "duration_ms": { "example": 42, "maximum": 2147483647, "minimum": -2147483648, "nullable": true, "type": "integer" }, "ip": { "example": "203.0.113.10", "minLength": 1, "nullable": true, "type": "string" }, "method": { "example": "GET", "minLength": 1, "type": "string" }, "path": { "example": "/articles/example", "minLength": 1, "type": "string" }, "referrer": { "example": "https://example.com/", "minLength": 1, "nullable": true, "type": "string" }, "request_id": { "example": "F5-example-request", "minLength": 1, "nullable": true, "type": "string" }, "status": { "example": 200, "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "timestamp": { "example": "2026-07-12T12:00:00.000000Z", "format": "date_time", "type": "string" }, "user_agent": { "example": "ExampleClient/1.0", "minLength": 1, "nullable": true, "type": "string" } }, "type": "object" }, "id": { "example": "1", "type": "string" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" }, "relationships": { "additionalProperties": false, "description": "A relationships object for a request_log", "properties": { "ip_info": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "description": "An identifier for ip_info", "nullable": true, "properties": { "id": { "type": "string" }, "meta": { "additionalProperties": true, "type": "object" }, "type": { "enum": [ "ip_info" ], "example": "ip_info", "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "type": "object" } }, "type": "object" }, "type": { "enum": [ "request_log" ], "example": "request_log", "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "flashcard_deck-filter--getFlashcard": { "additionalProperties": false, "minProperties": 1, "properties": { "and": { "items": { "$ref": "#/components/schemas/flashcard_deck-filter--getFlashcard" }, "minItems": 1, "type": "array", "uniqueItems": true }, "author_email": { "additionalProperties": false, "minProperties": 1, "properties": { "contains": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "eq": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than_or_equal": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "ilike": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "in": { "items": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "type": "array" }, "is_distinct_from": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than_or_equal": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "like": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "not_eq": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_ends_with": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_starts_with": { "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" } }, "type": "object" }, "cards": { "$ref": "#/components/schemas/flashcard-filter--getFlashcard" }, "id": { "additionalProperties": false, "minProperties": 1, "properties": { "eq": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "in": { "items": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than_or_equal": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" }, "not_eq": { "format": "uuid", "maxLength": 36, "minLength": 36, "pattern": "^[^\u0000]*$", "type": "string" } }, "type": "object" }, "name": { "additionalProperties": false, "minProperties": 1, "properties": { "contains": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "eq": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "greater_than_or_equal": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "ilike": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "in": { "items": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "type": "array" }, "is_distinct_from": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "less_than_or_equal": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "like": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "not_eq": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_ends_with": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] }, "string_starts_with": { "allOf": [ { "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, { "pattern": "^[^\u0000]*$", "type": "string" } ] } }, "type": "object" }, "not": { "$ref": "#/components/schemas/flashcard_deck-filter--getFlashcard" }, "or": { "items": { "$ref": "#/components/schemas/flashcard_deck-filter--getFlashcard" }, "minItems": 1, "type": "array", "uniqueItems": true }, "published": { "additionalProperties": false, "minProperties": 1, "properties": { "eq": { "type": "boolean" }, "greater_than": { "type": "boolean" }, "greater_than_or_equal": { "type": "boolean" }, "in": { "items": { "type": "boolean" }, "type": "array" }, "is_distinct_from": { "type": "boolean" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "boolean" }, "less_than": { "type": "boolean" }, "less_than_or_equal": { "type": "boolean" }, "not_eq": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "flashcard_deck-filter-author_email": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "sanction_list-filter": { "additionalProperties": false, "description": "Filters the query to results matching the given filter object", "example": "", "properties": { "active_version": { "$ref": "#/components/schemas/sanction_list_version-filter" }, "active_version_id": { "$ref": "#/components/schemas/sanction_list-filter-active_version_id" }, "and": { "items": { "$ref": "#/components/schemas/sanction_list-filter" }, "type": "array", "uniqueItems": true }, "id": { "$ref": "#/components/schemas/sanction_list-filter-id" }, "not": { "$ref": "#/components/schemas/sanction_list-filter" }, "or": { "items": { "$ref": "#/components/schemas/sanction_list-filter" }, "type": "array", "uniqueItems": true }, "slug": { "$ref": "#/components/schemas/sanction_list-filter-slug" }, "versions": { "$ref": "#/components/schemas/sanction_list_version-filter" } }, "type": "object" }, "flashcard_deck": { "additionalProperties": false, "description": "A \"Resource object\" representing a flashcard_deck", "properties": { "attributes": { "additionalProperties": false, "properties": { "author_email": { "example": "author@example.com", "minLength": 1, "nullable": true, "type": "string" }, "cards": { "items": { "additionalProperties": false, "properties": { "back": { "example": "It prevents producers from overwhelming consumers.", "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "deck_ids": { "example": [ "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24" ], "items": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "type": "array" }, "editor_notes": { "example": "Source: Designing Elixir Systems with OTP", "maxLength": 50000, "minLength": 1, "nullable": true, "pattern": "^[^\\u0000]*$", "type": "string" }, "front": { "example": "Why does backpressure matter?", "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "id": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e25", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "inserted_at": { "example": "2026-07-10T12:00:00.000000Z", "format": "date_time", "type": "string" }, "tags": { "example": [ "elixir", "otp" ], "items": { "example": "elixir", "maxLength": 256, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "maxItems": 100, "type": "array" }, "updated_at": { "example": "2026-07-12T12:00:00.000000Z", "format": "date_time", "type": "string" } }, "type": "object" }, "type": "array" }, "inserted_at": { "example": "2026-07-10T12:00:00.000000Z", "format": "date_time", "type": "string" }, "name": { "example": "Elixir & OTP", "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "published": { "example": false, "type": "boolean" }, "updated_at": { "example": "2026-07-12T12:00:00.000000Z", "format": "date_time", "type": "string" } }, "type": "object" }, "id": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" }, "relationships": { "additionalProperties": false, "description": "A relationships object for a flashcard_deck", "properties": { "cards": { "additionalProperties": false, "properties": { "data": { "description": "Relationship data for cards", "items": { "additionalProperties": false, "description": "Resource identifiers for cards", "properties": { "id": { "type": "string" }, "meta": { "additionalProperties": true, "type": "object" }, "type": { "enum": [ "flashcard" ], "example": "flashcard", "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "type": "array", "uniqueItems": true }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "type": "object" } }, "type": "object" }, "type": { "enum": [ "flashcard_deck" ], "example": "flashcard_deck", "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "request_log-filter-referrer": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "sanction_list_version-filter-id": { "additionalProperties": false, "properties": { "eq": { "format": "uuid", "type": "string" }, "greater_than": { "format": "uuid", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "type": "string" }, "in": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "type": "string" }, "less_than": { "format": "uuid", "type": "string" }, "less_than_or_equal": { "format": "uuid", "type": "string" }, "not_eq": { "format": "uuid", "type": "string" } }, "type": "object" }, "ip_info-filter--listRequestLogs": { "additionalProperties": false, "maxProperties": 16, "minProperties": 1, "properties": { "and": { "items": { "$ref": "#/components/schemas/ip_info-filter--listRequestLogs" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true }, "as_name": { "additionalProperties": false, "maxProperties": 16, "minProperties": 1, "properties": { "contains": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "ilike": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "in": { "items": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "maxItems": 32, "type": "array" }, "is_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "like": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "not_eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_ends_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_starts_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" } }, "type": "object" }, "continent": { "additionalProperties": false, "maxProperties": 16, "minProperties": 1, "properties": { "contains": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "ilike": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "in": { "items": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "maxItems": 32, "type": "array" }, "is_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "like": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "not_eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_ends_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_starts_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" } }, "type": "object" }, "country": { "additionalProperties": false, "maxProperties": 16, "minProperties": 1, "properties": { "contains": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "greater_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "ilike": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "in": { "items": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "maxItems": 32, "type": "array" }, "is_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "less_than_or_equal": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "like": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "not_eq": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_ends_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" }, "string_starts_with": { "maxLength": 512, "minLength": 1, "pattern": "^[^\u0000]*$", "type": "string" } }, "type": "object" }, "not": { "$ref": "#/components/schemas/ip_info-filter--listRequestLogs" }, "or": { "items": { "$ref": "#/components/schemas/ip_info-filter--listRequestLogs" }, "maxItems": 32, "minItems": 1, "type": "array", "uniqueItems": true } }, "type": "object" }, "sanction_list_version": { "additionalProperties": false, "description": "A \"Resource object\" representing a sanction_list_version", "properties": { "attributes": { "additionalProperties": false, "properties": { "byte_size": { "example": 1024, "type": "integer" }, "content_type": { "example": "application/xml", "minLength": 1, "type": "string" }, "fetched_at": { "example": "2026-07-12T12:00:00.000000Z", "format": "date_time", "type": "string" }, "last_seen_at": { "example": "2026-07-12T12:00:00.000000Z", "format": "date_time", "type": "string" }, "parser_module": { "example": "BlogEx.Sanctions.Parsers.Ofac", "minLength": 1, "type": "string" }, "publish_date": { "example": "2026-07-12", "format": "date", "nullable": true, "type": "string" }, "record_count": { "example": 12345, "type": "integer" }, "sha256": { "example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "minLength": 1, "type": "string" }, "source_slug": { "example": "ofac_sdn", "minLength": 1, "type": "string" }, "storage_key": { "example": "sanctions/ofac_sdn/example.xml", "minLength": 1, "type": "string" } }, "type": "object" }, "id": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" }, "relationships": { "additionalProperties": false, "description": "A relationships object for a sanction_list_version", "properties": {}, "type": "object" }, "type": { "enum": [ "sanction_list_version" ], "example": "sanction_list_version", "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "flashcard-filter-editor_notes": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "flashcard": { "additionalProperties": false, "description": "A \"Resource object\" representing a flashcard", "properties": { "attributes": { "additionalProperties": false, "properties": { "back": { "example": "It prevents producers from overwhelming consumers.", "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "deck_ids": { "example": [ "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24" ], "items": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "type": "array" }, "decks": { "items": { "additionalProperties": false, "properties": { "author_email": { "example": "author@example.com", "minLength": 1, "nullable": true, "type": "string" }, "id": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "inserted_at": { "example": "2026-07-10T12:00:00.000000Z", "format": "date_time", "type": "string" }, "name": { "example": "Elixir & OTP", "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "published": { "example": false, "type": "boolean" }, "updated_at": { "example": "2026-07-12T12:00:00.000000Z", "format": "date_time", "type": "string" } }, "type": "object" }, "type": "array" }, "editor_notes": { "example": "Source: Designing Elixir Systems with OTP", "maxLength": 50000, "minLength": 1, "nullable": true, "pattern": "^[^\\u0000]*$", "type": "string" }, "front": { "example": "Why does backpressure matter?", "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "inserted_at": { "example": "2026-07-10T12:00:00.000000Z", "format": "date_time", "type": "string" }, "tags": { "example": [ "elixir", "otp" ], "items": { "example": "elixir", "maxLength": 256, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "maxItems": 100, "type": "array" }, "updated_at": { "example": "2026-07-12T12:00:00.000000Z", "format": "date_time", "type": "string" } }, "type": "object" }, "id": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e25", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" }, "relationships": { "additionalProperties": false, "description": "A relationships object for a flashcard", "properties": { "decks": { "additionalProperties": false, "properties": { "data": { "description": "Relationship data for decks", "items": { "additionalProperties": false, "description": "Resource identifiers for decks", "properties": { "id": { "type": "string" }, "meta": { "additionalProperties": true, "type": "object" }, "type": { "enum": [ "flashcard_deck" ], "example": "flashcard_deck", "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "type": "array", "uniqueItems": true }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "type": "object" } }, "type": "object" }, "type": { "enum": [ "flashcard" ], "example": "flashcard", "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "request_log-filter-user_agent": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" } }, "securitySchemes": { "ApiTokenAuth": { "scheme": "bearer", "type": "http" }, "bearerAuth": { "bearerFormat": "JWT", "description": "JWT for bearer authentication", "scheme": "bearer", "type": "http" } } }, "info": { "title": "Blog Ex API", "version": "1.0.0" }, "openapi": "3.0.0", "paths": { "/api/v1/flashcard-decks": { "get": { "callbacks": {}, "deprecated": false, "description": "List decks owned by the authenticated user and decks published by other authors. Supports offset pagination with `page[limit]` and `page[offset]`.", "operationId": "listFlashcardDecks", "parameters": [ { "description": "Paginates the response with the limit and offset or keyset pagination.", "in": "query", "name": "page", "required": false, "schema": { "additionalProperties": false, "example": { "limit": 25 }, "minProperties": 1, "properties": { "count": { "default": false, "example": false, "type": "boolean" }, "limit": { "default": 25, "example": 25, "maximum": 100, "minimum": 1, "type": "integer" }, "offset": { "example": 0, "maximum": 1000000, "minimum": 0, "type": "integer" } }, "type": "object" }, "style": "deepObject" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "example": "cards", "pattern": "^(cards)(,(cards))*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": false, "example": { "flashcard": "id,front,back,editor_notes,tags,deck_ids,decks", "flashcard_deck": "id,name,published,author_email,cards" }, "minProperties": 1, "properties": { "flashcard": { "example": "id,front,back,editor_notes,tags,deck_ids,decks", "minLength": 1, "pattern": "^(id|front|back|editor_notes|tags|deck_ids|decks)(,(id|front|back|editor_notes|tags|deck_ids|decks))*$", "type": "string" }, "flashcard_deck": { "example": "id,name,published,author_email,cards", "minLength": 1, "pattern": "^(id|name|published|author_email|cards)(,(id|name|published|author_email|cards))*$", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "example": { "data": [ { "attributes": { "author_email": "author@example.com", "inserted_at": "2026-07-10T12:00:00.000000Z", "name": "Elixir & OTP", "published": false, "updated_at": "2026-07-12T12:00:00.000000Z" }, "id": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "type": "flashcard_deck" } ] }, "schema": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/flashcard_deck" }, "type": "array", "uniqueItems": true }, "included": { "items": { "oneOf": [ { "$ref": "#/components/schemas/flashcard" }, { "$ref": "#/components/schemas/flashcard_deck" } ] }, "type": "array", "uniqueItems": true }, "jsonapi": { "additionalProperties": true, "type": "object" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Request validation failed." }, "401": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Authentication required." }, "403": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "The API token does not have the required permission." }, "429": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Rate limit exceeded." }, "default": { "$ref": "#/components/responses/errors" } }, "security": [ { "ApiTokenAuth": [] } ], "tags": [ "flashcard_deck" ], "x-required-permissions": [ "flashcards_read" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "Create a private deck owned by the authenticated user.", "operationId": "createFlashcardDeck", "parameters": [ { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "example": "cards", "pattern": "^(cards)(,(cards))*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": false, "example": { "flashcard": "id,front,back,editor_notes,tags,deck_ids,decks", "flashcard_deck": "id,name,published,author_email,cards" }, "minProperties": 1, "properties": { "flashcard": { "example": "id,front,back,editor_notes,tags,deck_ids,decks", "minLength": 1, "pattern": "^(id|front|back|editor_notes|tags|deck_ids|decks)(,(id|front|back|editor_notes|tags|deck_ids|decks))*$", "type": "string" }, "flashcard_deck": { "example": "id,name,published,author_email,cards", "minLength": 1, "pattern": "^(id|name|published|author_email|cards)(,(id|name|published|author_email|cards))*$", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "name": "Elixir & OTP" }, "type": "flashcard_deck" } }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "attributes": { "additionalProperties": false, "properties": { "name": { "example": "Elixir & OTP", "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": { "enum": [ "flashcard_deck" ], "example": "flashcard_deck", "type": "string" } }, "required": [ "type", "attributes" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "author_email": "author@example.com", "inserted_at": "2026-07-10T12:00:00.000000Z", "name": "Elixir & OTP", "published": false, "updated_at": "2026-07-12T12:00:00.000000Z" }, "id": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "type": "flashcard_deck" } }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/flashcard_deck" }, "included": { "items": { "oneOf": [ { "$ref": "#/components/schemas/flashcard" }, { "$ref": "#/components/schemas/flashcard_deck" } ] }, "type": "array", "uniqueItems": true }, "jsonapi": { "additionalProperties": true, "type": "object" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success", "links": { "DeleteCreatedFlashcardDeck": { "operationId": "deleteFlashcardDeck", "parameters": { "id": "$response.body#/data/id" } }, "GetCreatedFlashcardDeck": { "operationId": "getFlashcardDeck", "parameters": { "id": "$response.body#/data/id" } }, "UpdateCreatedFlashcardDeck": { "operationId": "updateFlashcardDeck", "parameters": { "id": "$response.body#/data/id" } } } }, "400": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Request validation failed." }, "401": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Authentication required." }, "403": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "The API token does not have the required permission." }, "429": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Rate limit exceeded." }, "default": { "$ref": "#/components/responses/errors" } }, "security": [ { "ApiTokenAuth": [] } ], "tags": [ "flashcard_deck" ], "x-required-permissions": [ "flashcards_write" ] } }, "/api/v1/flashcard-decks/{id}": { "delete": { "callbacks": {}, "deprecated": false, "description": "Delete a deck. Cards in the deck are retained.", "operationId": "deleteFlashcardDeck", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "style": "form" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "example": "cards", "pattern": "^(cards)(,(cards))*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": false, "example": { "flashcard": "id,front,back,editor_notes,tags,deck_ids,decks", "flashcard_deck": "id,name,published,author_email,cards" }, "minProperties": 1, "properties": { "flashcard": { "example": "id,front,back,editor_notes,tags,deck_ids,decks", "minLength": 1, "pattern": "^(id|front|back|editor_notes|tags|deck_ids|decks)(,(id|front|back|editor_notes|tags|deck_ids|decks))*$", "type": "string" }, "flashcard_deck": { "example": "id,name,published,author_email,cards", "minLength": 1, "pattern": "^(id|name|published|author_email|cards)(,(id|name|published|author_email|cards))*$", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "description": "Deleted successfully" }, "400": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Request validation failed." }, "401": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Authentication required." }, "403": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "The API token does not have the required permission." }, "429": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Rate limit exceeded." }, "default": { "$ref": "#/components/responses/errors" } }, "security": [ { "ApiTokenAuth": [] } ], "tags": [ "flashcard_deck" ], "x-required-permissions": [ "flashcards_write" ] }, "get": { "callbacks": {}, "deprecated": false, "description": "Get one deck owned by the authenticated user or published by another author.", "operationId": "getFlashcardDeck", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "style": "form" }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/flashcard_deck-filter--getFlashcardDeck" }, "style": "deepObject" }, { "in": "query", "name": "sort", "required": false, "schema": { "pattern": "^(id|\\-id|name|\\-name|published|\\-published|author_email|\\-author_email)(,(id|\\-id|name|\\-name|published|\\-published|author_email|\\-author_email))*$", "type": "string" }, "style": "form" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "example": "cards", "pattern": "^(cards)(,(cards))*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": false, "example": { "flashcard": "id,front,back,editor_notes,tags,deck_ids,decks", "flashcard_deck": "id,name,published,author_email,cards" }, "minProperties": 1, "properties": { "flashcard": { "example": "id,front,back,editor_notes,tags,deck_ids,decks", "minLength": 1, "pattern": "^(id|front|back|editor_notes|tags|deck_ids|decks)(,(id|front|back|editor_notes|tags|deck_ids|decks))*$", "type": "string" }, "flashcard_deck": { "example": "id,name,published,author_email,cards", "minLength": 1, "pattern": "^(id|name|published|author_email|cards)(,(id|name|published|author_email|cards))*$", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "author_email": "author@example.com", "inserted_at": "2026-07-10T12:00:00.000000Z", "name": "Elixir & OTP", "published": false, "updated_at": "2026-07-12T12:00:00.000000Z" }, "id": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "type": "flashcard_deck" } }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/flashcard_deck" }, "included": { "items": { "oneOf": [ { "$ref": "#/components/schemas/flashcard" }, { "$ref": "#/components/schemas/flashcard_deck" } ] }, "type": "array", "uniqueItems": true }, "jsonapi": { "additionalProperties": true, "type": "object" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Request validation failed." }, "401": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Authentication required." }, "403": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "The API token does not have the required permission." }, "429": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Rate limit exceeded." }, "default": { "$ref": "#/components/responses/errors" } }, "security": [ { "ApiTokenAuth": [] } ], "tags": [ "flashcard_deck" ], "x-required-permissions": [ "flashcards_read" ] }, "patch": { "callbacks": {}, "deprecated": false, "description": "Rename or publish a deck owned by the authenticated user.", "operationId": "updateFlashcardDeck", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "style": "form" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "example": "cards", "pattern": "^(cards)(,(cards))*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": false, "example": { "flashcard": "id,front,back,editor_notes,tags,deck_ids,decks", "flashcard_deck": "id,name,published,author_email,cards" }, "minProperties": 1, "properties": { "flashcard": { "example": "id,front,back,editor_notes,tags,deck_ids,decks", "minLength": 1, "pattern": "^(id|front|back|editor_notes|tags|deck_ids|decks)(,(id|front|back|editor_notes|tags|deck_ids|decks))*$", "type": "string" }, "flashcard_deck": { "example": "id,name,published,author_email,cards", "minLength": 1, "pattern": "^(id|name|published|author_email|cards)(,(id|name|published|author_email|cards))*$", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "id": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "name": "Elixir & OTP", "published": false }, "id": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "type": "flashcard_deck" } }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "attributes": { "additionalProperties": false, "properties": { "name": { "example": "Elixir & OTP", "maxLength": 80, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "published": { "example": false, "type": "boolean" } }, "type": "object" }, "id": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "type": { "enum": [ "flashcard_deck" ], "example": "flashcard_deck", "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "author_email": "author@example.com", "inserted_at": "2026-07-10T12:00:00.000000Z", "name": "Elixir & OTP", "published": false, "updated_at": "2026-07-12T12:00:00.000000Z" }, "id": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "type": "flashcard_deck" } }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/flashcard_deck" }, "included": { "items": { "oneOf": [ { "$ref": "#/components/schemas/flashcard" }, { "$ref": "#/components/schemas/flashcard_deck" } ] }, "type": "array", "uniqueItems": true }, "jsonapi": { "additionalProperties": true, "type": "object" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Request validation failed." }, "401": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Authentication required." }, "403": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "The API token does not have the required permission." }, "429": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Rate limit exceeded." }, "default": { "$ref": "#/components/responses/errors" } }, "security": [ { "ApiTokenAuth": [] } ], "tags": [ "flashcard_deck" ], "x-required-permissions": [ "flashcards_write" ] } }, "/api/v1/flashcard-images/upload": { "post": { "callbacks": {}, "deprecated": false, "description": "Upload a base64-encoded PNG, JPEG, GIF, or WebP image. PNG/JPEG images may be converted to WebP. The response includes a public URL and a ready-to-paste `image` code fence.", "operationId": "uploadFlashcardImage", "parameters": [], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "alt": "Producer and consumer queue", "content_base64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=", "content_type": "image/png", "filename": "queue.png" } }, "schema": { "properties": { "data": { "additionalProperties": false, "properties": { "alt": { "example": "Producer and consumer queue", "maxLength": 500, "minLength": 1, "nullable": true, "type": "string" }, "content_base64": { "example": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=", "maxLength": 13981016, "minLength": 4, "type": "string" }, "content_type": { "enum": [ "image/png", "image/jpeg", "image/gif", "image/webp" ], "example": "image/png", "type": "string", "x-enumDescriptions": {} }, "filename": { "example": "queue.png", "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "filename", "content_type", "content_base64" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/vnd.api+json": { "example": { "byte_size": 1024, "content_type": "image/webp", "filename": "queue.webp", "height": 480, "markdown": "```image\nsrc: https://cdn.example/cards/queue.webp\nalt: Queue\n```", "url": "https://cdn.example/cards/queue.webp", "width": 640 }, "schema": { "additionalProperties": false, "properties": { "byte_size": { "example": 1024, "minimum": 1, "type": "integer" }, "content_type": { "example": "image/webp", "minLength": 1, "type": "string" }, "filename": { "example": "queue.webp", "minLength": 1, "type": "string" }, "height": { "example": 480, "minimum": 1, "nullable": true, "type": "integer" }, "markdown": { "example": "```image\nsrc: https://cdn.example/cards/queue.webp\nalt: Queue\n```", "minLength": 1, "type": "string" }, "url": { "example": "https://cdn.example/cards/queue.webp", "minLength": 1, "type": "string" }, "width": { "example": 640, "minimum": 1, "nullable": true, "type": "integer" } }, "required": [ "url", "filename", "content_type", "byte_size", "markdown" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Request validation failed." }, "401": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Authentication required." }, "403": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "The API token does not have the required permission." }, "429": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Rate limit exceeded." }, "default": { "$ref": "#/components/responses/errors" } }, "security": [ { "ApiTokenAuth": [] } ], "tags": [ "flashcard_image_upload" ], "x-required-permissions": [ "flashcards_write" ] } }, "/api/v1/flashcards": { "get": { "callbacks": {}, "deprecated": false, "description": "List the authenticated user's cards with offset pagination up to 100 cards per page.", "operationId": "listFlashcards", "parameters": [ { "description": "Paginates the response with the limit and offset or keyset pagination.", "in": "query", "name": "page", "required": false, "schema": { "additionalProperties": false, "example": { "limit": 25 }, "minProperties": 1, "properties": { "count": { "default": false, "example": false, "type": "boolean" }, "limit": { "default": 25, "example": 25, "maximum": 100, "minimum": 1, "type": "integer" }, "offset": { "example": 0, "maximum": 1000000, "minimum": 0, "type": "integer" } }, "type": "object" }, "style": "deepObject" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "example": "decks", "pattern": "^(decks)(,(decks))*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": false, "example": { "flashcard": "id,front,back,editor_notes,tags,deck_ids,decks", "flashcard_deck": "id,name,published,author_email,cards" }, "minProperties": 1, "properties": { "flashcard": { "example": "id,front,back,editor_notes,tags,deck_ids,decks", "minLength": 1, "pattern": "^(id|front|back|editor_notes|tags|deck_ids|decks)(,(id|front|back|editor_notes|tags|deck_ids|decks))*$", "type": "string" }, "flashcard_deck": { "example": "id,name,published,author_email,cards", "minLength": 1, "pattern": "^(id|name|published|author_email|cards)(,(id|name|published|author_email|cards))*$", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "example": { "data": [ { "attributes": { "back": "It prevents producers from overwhelming consumers.", "deck_ids": [ "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24" ], "editor_notes": "Source: Designing Elixir Systems with OTP", "front": "Why does backpressure matter?", "inserted_at": "2026-07-10T12:00:00.000000Z", "tags": [ "elixir", "otp" ], "updated_at": "2026-07-12T12:00:00.000000Z" }, "id": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e25", "type": "flashcard" } ] }, "schema": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/flashcard" }, "type": "array", "uniqueItems": true }, "included": { "items": { "oneOf": [ { "$ref": "#/components/schemas/flashcard_deck" }, { "$ref": "#/components/schemas/flashcard" } ] }, "type": "array", "uniqueItems": true }, "jsonapi": { "additionalProperties": true, "type": "object" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Request validation failed." }, "401": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Authentication required." }, "403": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "The API token does not have the required permission." }, "429": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Rate limit exceeded." }, "default": { "$ref": "#/components/responses/errors" } }, "security": [ { "ApiTokenAuth": [] } ], "tags": [ "flashcard" ], "x-required-permissions": [ "flashcards_read" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "Create a private card.\n\n`front` and `back` support GitHub-Flavored Markdown: headings, emphasis, links,\nordered and unordered lists, tables, block quotes, inline code, and fenced code.\nPut a language after the opening fence for syntax highlighting:\n\n ```elixir\n IO.puts(\"hello\")\n ```\n\nImages use the custom static `image` fence. `src` and `alt` are required;\n`caption`, `url`, `width`, `height`, `align`, and `caption_align` are optional.\nAlignment accepts `left`, `center`, or `right`.\n\n ```image\n src: https://cdn.example/cards/queue.webp\n alt: Producer and consumer queue\n caption: Backpressure keeps the queue **bounded**.\n align: center\n ```\n\nArticle-only interactive code fences are not supported in cards. `editor_notes`\nis stored for notes and sources but is never shown during study. Tags are trimmed,\nlowercased, de-duplicated strings.", "operationId": "createFlashcard", "parameters": [ { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "example": "decks", "pattern": "^(decks)(,(decks))*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": false, "example": { "flashcard": "id,front,back,editor_notes,tags,deck_ids,decks", "flashcard_deck": "id,name,published,author_email,cards" }, "minProperties": 1, "properties": { "flashcard": { "example": "id,front,back,editor_notes,tags,deck_ids,decks", "minLength": 1, "pattern": "^(id|front|back|editor_notes|tags|deck_ids|decks)(,(id|front|back|editor_notes|tags|deck_ids|decks))*$", "type": "string" }, "flashcard_deck": { "example": "id,name,published,author_email,cards", "minLength": 1, "pattern": "^(id|name|published|author_email|cards)(,(id|name|published|author_email|cards))*$", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "back": "```elixir\nGenStage.ask(producer, 10)\n```\n\n```image\nsrc: https://cdn.example/queue.webp\nalt: A bounded queue\ncaption: Demand controls the producer.\n```", "deck_ids": [ "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24" ], "editor_notes": "Source: Designing Elixir Systems with OTP, chapter 8", "front": "Why use **backpressure**?", "tags": [ "elixir", "otp" ] }, "type": "flashcard" } }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "attributes": { "additionalProperties": false, "properties": { "back": { "example": "It prevents producers from overwhelming consumers.", "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "deck_ids": { "example": [ "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24" ], "items": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "nullable": true, "type": "array" }, "editor_notes": { "example": "Source: Designing Elixir Systems with OTP", "maxLength": 50000, "minLength": 1, "nullable": true, "pattern": "^[^\\u0000]*$", "type": "string" }, "front": { "example": "Why does backpressure matter?", "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "tags": { "example": [ "elixir", "otp" ], "items": { "example": "elixir", "maxLength": 256, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "maxItems": 100, "type": "array" } }, "required": [ "front", "back" ], "type": "object" }, "type": { "enum": [ "flashcard" ], "example": "flashcard", "type": "string" } }, "required": [ "type", "attributes" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "back": "It prevents producers from overwhelming consumers.", "deck_ids": [ "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24" ], "editor_notes": "Source: Designing Elixir Systems with OTP", "front": "Why does backpressure matter?", "inserted_at": "2026-07-10T12:00:00.000000Z", "tags": [ "elixir", "otp" ], "updated_at": "2026-07-12T12:00:00.000000Z" }, "id": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e25", "type": "flashcard" } }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/flashcard" }, "included": { "items": { "oneOf": [ { "$ref": "#/components/schemas/flashcard_deck" }, { "$ref": "#/components/schemas/flashcard" } ] }, "type": "array", "uniqueItems": true }, "jsonapi": { "additionalProperties": true, "type": "object" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success", "links": { "DeleteCreatedFlashcard": { "operationId": "deleteFlashcard", "parameters": { "id": "$response.body#/data/id" } }, "GetCreatedFlashcard": { "operationId": "getFlashcard", "parameters": { "id": "$response.body#/data/id" } }, "UpdateCreatedFlashcard": { "operationId": "updateFlashcard", "parameters": { "id": "$response.body#/data/id" } } } }, "400": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Request validation failed." }, "401": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Authentication required." }, "403": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "The API token does not have the required permission." }, "429": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Rate limit exceeded." }, "default": { "$ref": "#/components/responses/errors" } }, "security": [ { "ApiTokenAuth": [] } ], "tags": [ "flashcard" ], "x-required-permissions": [ "flashcards_write" ] } }, "/api/v1/flashcards/{id}": { "delete": { "callbacks": {}, "deprecated": false, "description": "Delete a card and remove it from decks and pending study sessions.", "operationId": "deleteFlashcard", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e25", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "style": "form" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "example": "decks", "pattern": "^(decks)(,(decks))*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": false, "example": { "flashcard": "id,front,back,editor_notes,tags,deck_ids,decks", "flashcard_deck": "id,name,published,author_email,cards" }, "minProperties": 1, "properties": { "flashcard": { "example": "id,front,back,editor_notes,tags,deck_ids,decks", "minLength": 1, "pattern": "^(id|front|back|editor_notes|tags|deck_ids|decks)(,(id|front|back|editor_notes|tags|deck_ids|decks))*$", "type": "string" }, "flashcard_deck": { "example": "id,name,published,author_email,cards", "minLength": 1, "pattern": "^(id|name|published|author_email|cards)(,(id|name|published|author_email|cards))*$", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "description": "Deleted successfully" }, "400": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Request validation failed." }, "401": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Authentication required." }, "403": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "The API token does not have the required permission." }, "429": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Rate limit exceeded." }, "default": { "$ref": "#/components/responses/errors" } }, "security": [ { "ApiTokenAuth": [] } ], "tags": [ "flashcard" ], "x-required-permissions": [ "flashcards_write" ] }, "get": { "callbacks": {}, "deprecated": false, "description": "Get one card owned by the authenticated user.", "operationId": "getFlashcard", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e25", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "style": "form" }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/flashcard-filter--getFlashcard" }, "style": "deepObject" }, { "in": "query", "name": "sort", "required": false, "schema": { "pattern": "^(id|\\-id|front|\\-front|back|\\-back|editor_notes|\\-editor_notes)(,(id|\\-id|front|\\-front|back|\\-back|editor_notes|\\-editor_notes))*$", "type": "string" }, "style": "form" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "example": "decks", "pattern": "^(decks)(,(decks))*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": false, "example": { "flashcard": "id,front,back,editor_notes,tags,deck_ids,decks", "flashcard_deck": "id,name,published,author_email,cards" }, "minProperties": 1, "properties": { "flashcard": { "example": "id,front,back,editor_notes,tags,deck_ids,decks", "minLength": 1, "pattern": "^(id|front|back|editor_notes|tags|deck_ids|decks)(,(id|front|back|editor_notes|tags|deck_ids|decks))*$", "type": "string" }, "flashcard_deck": { "example": "id,name,published,author_email,cards", "minLength": 1, "pattern": "^(id|name|published|author_email|cards)(,(id|name|published|author_email|cards))*$", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "back": "It prevents producers from overwhelming consumers.", "deck_ids": [ "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24" ], "editor_notes": "Source: Designing Elixir Systems with OTP", "front": "Why does backpressure matter?", "inserted_at": "2026-07-10T12:00:00.000000Z", "tags": [ "elixir", "otp" ], "updated_at": "2026-07-12T12:00:00.000000Z" }, "id": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e25", "type": "flashcard" } }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/flashcard" }, "included": { "items": { "oneOf": [ { "$ref": "#/components/schemas/flashcard_deck" }, { "$ref": "#/components/schemas/flashcard" } ] }, "type": "array", "uniqueItems": true }, "jsonapi": { "additionalProperties": true, "type": "object" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Request validation failed." }, "401": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Authentication required." }, "403": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "The API token does not have the required permission." }, "429": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Rate limit exceeded." }, "default": { "$ref": "#/components/responses/errors" } }, "security": [ { "ApiTokenAuth": [] } ], "tags": [ "flashcard" ], "x-required-permissions": [ "flashcards_read" ] }, "patch": { "callbacks": {}, "deprecated": false, "description": "Update any supplied card content fields. Omit `deck_ids` to preserve membership; pass `[]` to remove the card from every deck.\n\n`front` and `back` support GitHub-Flavored Markdown: headings, emphasis, links,\nordered and unordered lists, tables, block quotes, inline code, and fenced code.\nPut a language after the opening fence for syntax highlighting:\n\n ```elixir\n IO.puts(\"hello\")\n ```\n\nImages use the custom static `image` fence. `src` and `alt` are required;\n`caption`, `url`, `width`, `height`, `align`, and `caption_align` are optional.\nAlignment accepts `left`, `center`, or `right`.\n\n ```image\n src: https://cdn.example/cards/queue.webp\n alt: Producer and consumer queue\n caption: Backpressure keeps the queue **bounded**.\n align: center\n ```\n\nArticle-only interactive code fences are not supported in cards. `editor_notes`\nis stored for notes and sources but is never shown during study. Tags are trimmed,\nlowercased, de-duplicated strings.", "operationId": "updateFlashcard", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e25", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "style": "form" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "example": "decks", "pattern": "^(decks)(,(decks))*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": false, "example": { "flashcard": "id,front,back,editor_notes,tags,deck_ids,decks", "flashcard_deck": "id,name,published,author_email,cards" }, "minProperties": 1, "properties": { "flashcard": { "example": "id,front,back,editor_notes,tags,deck_ids,decks", "minLength": 1, "pattern": "^(id|front|back|editor_notes|tags|deck_ids|decks)(,(id|front|back|editor_notes|tags|deck_ids|decks))*$", "type": "string" }, "flashcard_deck": { "example": "id,name,published,author_email,cards", "minLength": 1, "pattern": "^(id|name|published|author_email|cards)(,(id|name|published|author_email|cards))*$", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "back": "It keeps producers from overwhelming consumers.", "deck_ids": [], "editor_notes": null, "front": "What does backpressure protect?", "tags": [ "distributed-systems" ] }, "id": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e25", "type": "flashcard" } }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "attributes": { "additionalProperties": false, "properties": { "back": { "example": "It prevents producers from overwhelming consumers.", "maxLength": 50000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "deck_ids": { "example": [ "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24" ], "items": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "nullable": true, "type": "array" }, "editor_notes": { "example": "Source: Designing Elixir Systems with OTP", "maxLength": 50000, "minLength": 1, "nullable": true, "pattern": "^[^\\u0000]*$", "type": "string" }, "front": { "example": "Why does backpressure matter?", "maxLength": 10000, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "tags": { "example": [ "elixir", "otp" ], "items": { "example": "elixir", "maxLength": 256, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "id": { "example": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e25", "format": "uuid", "maxLength": 36, "minLength": 36, "type": "string" }, "type": { "enum": [ "flashcard" ], "example": "flashcard", "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "back": "It prevents producers from overwhelming consumers.", "deck_ids": [ "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24" ], "editor_notes": "Source: Designing Elixir Systems with OTP", "front": "Why does backpressure matter?", "inserted_at": "2026-07-10T12:00:00.000000Z", "tags": [ "elixir", "otp" ], "updated_at": "2026-07-12T12:00:00.000000Z" }, "id": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e25", "type": "flashcard" } }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/flashcard" }, "included": { "items": { "oneOf": [ { "$ref": "#/components/schemas/flashcard_deck" }, { "$ref": "#/components/schemas/flashcard" } ] }, "type": "array", "uniqueItems": true }, "jsonapi": { "additionalProperties": true, "type": "object" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Request validation failed." }, "401": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Authentication required." }, "403": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "The API token does not have the required permission." }, "429": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Rate limit exceeded." }, "default": { "$ref": "#/components/responses/errors" } }, "security": [ { "ApiTokenAuth": [] } ], "tags": [ "flashcard" ], "x-required-permissions": [ "flashcards_write" ] } }, "/api/v1/projects/ss": { "get": { "callbacks": {}, "deprecated": false, "description": "Screen a name against loaded sanctions lists.", "operationId": "screenSanctions", "parameters": [ { "description": "Name to screen. Free-form; normalization (casefolding, diacritic stripping) is handled server-side.", "in": "query", "name": "name", "required": true, "schema": { "description": "Name to screen. Free-form; normalization (casefolding, diacritic stripping) is handled server-side.", "example": "Vladimir Putin", "minLength": 1, "pattern": "^[^\\u0000]*[^\\s\\u0000][^\\u0000]*$", "type": "string" }, "style": "form" }, { "description": "Filter results by entry type.", "in": "query", "name": "entity_type", "required": false, "schema": { "description": "Filter results by entry type.", "enum": [ "all", "individual", "entity", "vessel", "aircraft" ], "example": "all", "type": "string", "x-enumDescriptions": { "aircraft": "Planes, helicopters, and other aircraft.", "all": "No filtering — return every match.", "entity": "Organizations, companies, government bodies.", "individual": "Natural persons only.", "vessel": "Ships, boats, and other watercraft." } }, "style": "form" }, { "description": "Matching algorithm — see enum for per-version guidance.", "in": "query", "name": "algorithm", "required": false, "schema": { "description": "Matching algorithm — see enum for per-version guidance.", "enum": [ "ofac_v5_1", "ofac_v5_0", "ofac_v4_2", "ofac_v4_1", "ofac_v4_0", "ofac_v3", "ofac_v2", "ofac_v1", "exact_normalized" ], "example": "ofac_v5_1", "type": "string", "x-enumDescriptions": { "exact_normalized": "No fuzziness. Requires a post-normalization exact match (casefolded, diacritic-stripped).", "ofac_v1": "v1 — plain Jaro-Winkler on the full preprocessed string. Baseline.", "ofac_v2": "v2 — naive token-level Jaro-Winkler, averaged across query tokens.", "ofac_v3": "v3 — token Jaro-Winkler + Soundex secondary gate to reject same-prefix non-matches.", "ofac_v4_0": "v4.0 — adaptive gating: per-token gate for multi-token queries, +0.02 JW offset, short tokens dropped.", "ofac_v4_1": "v4.1 — v4.0 + display-format reversal so 'putin' matches records stored as 'PUTIN, Vladimir'.", "ofac_v4_2": "v4.2 — v4.1 + length-ratio guard on the entity full-string fallback.", "ofac_v5_0": "v5.0 — v4 + residual correction calibrated against OFAC's reported scores.", "ofac_v5_1": "v5.1 — greedy token pairing on top of v5.0. Closest to OFAC's behavior so far. Recommended default." } }, "style": "form" }, { "description": "Minimum similarity score for a match to be returned. 1.0 = exact; 0.85 is a sensible default; lower values widen recall at the cost of precision.", "in": "query", "name": "threshold", "required": false, "schema": { "description": "Minimum similarity score for a match to be returned. 1.0 = exact; 0.85 is a sensible default; lower values widen recall at the cost of precision.", "example": 0.85, "maximum": 1.0, "minimum": 0.0, "type": "number" }, "style": "form" }, { "description": "Cap on the number of matches returned, ordered by descending score.", "in": "query", "name": "max_results", "required": false, "schema": { "description": "Cap on the number of matches returned, ordered by descending score.", "example": 50, "maximum": 500, "minimum": 1, "type": "integer" }, "style": "form" }, { "description": "Comma-separated list of source slugs to search (e.g. `ofac_sdn,eu`). Must contain at least one source. Any requested source not yet indexed causes a 503 response.", "in": "query", "name": "sources", "required": false, "schema": { "description": "Comma-separated list of source slugs to search (e.g. `ofac_sdn,eu`). Must contain at least one source. Any requested source not yet indexed causes a 503 response.", "example": "ofac_sdn,ofac_cons", "minLength": 1, "pattern": "^,*[\t-\r …   - 
-
  　]*(?:ofac_sdn|ofac_cons|eu)[\t-\r …   - 
-
  　]*(?:,+[\t-\r …   - 
-
  　]*(?:ofac_sdn|ofac_cons|eu)[\t-\r …   - 
-
  　]*)*,*$", "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "example": { "algorithm": "ofac_v5_1", "matches": [ { "entry": { "entity_type": "individual", "id": "ofac-123", "primary_name": "Vladimir Putin", "source": "ofac_sdn" }, "list_version": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "matched_name": "Vladimir Putin", "score": 0.99 } ], "preprocessed_query": "vladimir putin", "query": "Vladimir Putin", "searched_lists": [ "ofac_sdn" ], "threshold": 0.85, "total_matches": 1 }, "schema": { "additionalProperties": false, "properties": { "algorithm": { "description": "Matching algorithm that produced these results.", "example": "ofac_v5_1", "type": "string" }, "matches": { "description": "Matches that cleared `threshold`, ordered by descending `score`.", "example": [ { "entry": { "entity_type": "individual", "id": "ofac-123", "primary_name": "Vladimir Putin", "source": "ofac_sdn" }, "list_version": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "matched_name": "Vladimir Putin", "score": 0.99 } ], "items": { "additionalProperties": false, "example": { "entry": { "entity_type": "individual", "id": "ofac-123", "primary_name": "Vladimir Putin", "source": "ofac_sdn" }, "list_version": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "matched_name": "Vladimir Putin", "score": 0.99 }, "properties": { "entry": { "additionalProperties": false, "description": "The sanctions list entry that matched, in the unified format.", "example": { "entity_type": "individual", "id": "ofac-123", "primary_name": "Vladimir Putin", "source": "ofac_sdn" }, "properties": { "addresses": { "description": "Known addresses associated with the entry.", "items": { "additionalProperties": false, "properties": { "city": { "description": "City or locality.", "minLength": 1, "nullable": true, "type": "string" }, "country": { "description": "Country name as published by the source list.", "minLength": 1, "nullable": true, "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code when available.", "minLength": 1, "nullable": true, "type": "string" }, "note": { "description": "Free-form address qualifier (e.g. \"last known\", \"business\").", "minLength": 1, "nullable": true, "type": "string" }, "postal_code": { "description": "Postal or ZIP code.", "minLength": 1, "nullable": true, "type": "string" }, "region": { "description": "State, province, oblast, or other sub-national region.", "minLength": 1, "nullable": true, "type": "string" }, "street": { "description": "Street line, including house or building number.", "minLength": 1, "nullable": true, "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "aliases": { "description": "Alternate names (aka/fka/nka) published by the source.", "items": { "additionalProperties": false, "properties": { "language": { "description": "Language of the alias as a free-form string or ISO 639 code.", "minLength": 1, "nullable": true, "type": "string" }, "name": { "description": "The alias name as published by the sanctions authority.", "minLength": 1, "type": "string" }, "quality": { "description": "Confidence tier for the alias.", "enum": [ "strong", "weak" ], "nullable": true, "type": "string" }, "script": { "description": "Writing system of the alias (e.g. `Latin`, `Cyrillic`, `Arabic`).", "minLength": 1, "nullable": true, "type": "string" }, "type": { "description": "Relationship of this alias to the entry's primary name.", "enum": [ "aka", "fka", "nka", "primary" ], "nullable": true, "type": "string" } }, "required": [ "name" ], "type": "object" }, "nullable": true, "type": "array" }, "citizenships": { "description": "Citizenships — distinct from nationalities in sources that track them separately.", "items": { "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "contact": { "additionalProperties": false, "description": "Phones, emails, websites, and crypto addresses linked to the entry.", "nullable": true, "properties": { "crypto_addresses": { "description": "Map of cryptocurrency network to addresses, keyed by ticker (e.g. `%{\"XBT\" => [\"1...\"], \"ETH\" => [\"0x...\"]}`).", "nullable": true, "type": "object" }, "emails": { "description": "Known email addresses.", "items": { "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "phones": { "description": "Known telephone numbers in E.164 or raw source format.", "items": { "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "swift_bic": { "description": "SWIFT/BIC code, typically present only for financial-institution entries.", "minLength": 1, "nullable": true, "type": "string" }, "websites": { "description": "URLs of websites operated by or linked to the entity.", "items": { "minLength": 1, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "cross_references": { "additionalProperties": false, "description": "Foreign keys into other sanctions lists (OFAC UID, UN reference, EU reference, OFSI group id) — useful for reconciling the same target across sources.", "nullable": true, "properties": { "eu_reference": { "description": "EU Council Regulation reference (e.g. `EU.12345.67`).", "minLength": 1, "nullable": true, "type": "string" }, "ofac_uid": { "description": "OFAC Unique Identifier, persistent across SDN/Consolidated list updates.", "minLength": 1, "nullable": true, "type": "string" }, "ofsi_group_id": { "description": "UK OFSI group identifier grouping related target records.", "minLength": 1, "nullable": true, "type": "string" }, "un_reference": { "description": "UN Security Council Consolidated List permanent reference (e.g. `QDi.001`).", "minLength": 1, "nullable": true, "type": "string" } }, "type": "object" }, "dates_of_birth": { "description": "One or more dates (or year ranges) of birth. Always an array; some lists publish multiple.", "items": { "additionalProperties": false, "properties": { "approximate?": { "description": "True when the source indicates the date is estimated (e.g. \"circa 1960\"), not confirmed.", "nullable": true, "type": "boolean" }, "calendar": { "description": "Calendar system the date is expressed in.", "enum": [ "gregorian", "islamic" ], "nullable": true, "type": "string" }, "date": { "description": "Exact date of birth when known.", "format": "date", "nullable": true, "type": "string" }, "from_year": { "description": "Lower bound of a year range when only an approximate span is published.", "nullable": true, "type": "integer" }, "to_year": { "description": "Upper bound of a year range when only an approximate span is published.", "nullable": true, "type": "integer" }, "year": { "description": "Year of birth when only the year is known.", "nullable": true, "type": "integer" } }, "type": "object" }, "nullable": true, "type": "array" }, "documents": { "description": "Identity documents (passports, national IDs, tax IDs, etc.) published by the source.", "items": { "additionalProperties": false, "properties": { "expiry_date": { "description": "Date the document expires or expired.", "format": "date", "nullable": true, "type": "string" }, "issued_date": { "description": "Date the document was issued.", "format": "date", "nullable": true, "type": "string" }, "issuing_authority": { "description": "Issuing authority or agency, when named by the source.", "minLength": 1, "nullable": true, "type": "string" }, "issuing_country": { "description": "Country of issue (free-form; ISO code when available in the source).", "minLength": 1, "nullable": true, "type": "string" }, "note": { "description": "Free-form qualifier (e.g. \"Issued in exile\", \"Previous number\").", "minLength": 1, "nullable": true, "type": "string" }, "number": { "description": "Document number as published; redaction and formatting follow the source.", "minLength": 1, "nullable": true, "type": "string" }, "type": { "description": "Document kind. Use `other` with `type_detail` when no category fits.", "enum": [ "passport", "national_id", "tax_id", "ssn", "drivers_license", "business_reg", "vessel_reg", "imo", "swift_bic", "other" ], "nullable": true, "type": "string" }, "type_detail": { "description": "Free-form refinement of `type` (e.g. \"Diplomatic Passport\").", "minLength": 1, "nullable": true, "type": "string" }, "validity": { "description": "Current status of the document as reported by the source.", "enum": [ "valid", "fraudulent", "expired", "lost", "revoked" ], "nullable": true, "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "entity_info": { "additionalProperties": false, "description": "Corporate-specific details; typically populated only when `entity_type` is `entity`.", "nullable": true, "properties": { "entity_type": { "description": "Source-published organization type (e.g. \"Limited liability company\", \"Government entity\"). Distinct from the top-level `entity_type` enum.", "minLength": 1, "nullable": true, "type": "string" }, "parent_company": { "description": "Name of the parent corporation or owning entity, if disclosed.", "minLength": 1, "nullable": true, "type": "string" }, "registration_numbers": { "description": "Corporate registry / tax / trade-register numbers as published.", "items": { "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "subsidiaries": { "description": "Names of known subsidiary or controlled entities.", "items": { "minLength": 1, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "entity_type": { "description": "High-level classification of the listed entity.", "enum": [ "individual", "entity", "vessel", "aircraft" ], "example": "individual", "type": "string" }, "gender": { "description": "Gender as recorded by the source list.", "enum": [ "male", "female" ], "nullable": true, "type": "string" }, "id": { "description": "Stable identifier within the source list (e.g. OFAC UID, EU reference).", "example": "ofac-123", "minLength": 1, "type": "string" }, "legal_basis": { "description": "Citation of the regulation, executive order, or resolution authorizing the listing.", "minLength": 1, "nullable": true, "type": "string" }, "listed_on": { "description": "Date the entry was first added to the list.", "format": "date", "nullable": true, "type": "string" }, "measures": { "description": "Specific restrictive measures applied — e.g. \"asset_freeze\", \"travel_ban\". Distinct from `programs`, which are bucket identifiers.", "items": { "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "name_parts": { "additionalProperties": false, "description": "Decomposed given/family/patronymic components when the source provides them.", "nullable": true, "properties": { "first_name": { "description": "Given name.", "minLength": 1, "nullable": true, "type": "string" }, "last_name": { "description": "Family name / surname.", "minLength": 1, "nullable": true, "type": "string" }, "maiden_name": { "description": "Maiden surname, when published separately from `last_name`.", "minLength": 1, "nullable": true, "type": "string" }, "matronymic": { "description": "Matronymic (name derived from the mother), e.g. in Icelandic naming.", "minLength": 1, "nullable": true, "type": "string" }, "middle_name": { "description": "Middle name or initial.", "minLength": 1, "nullable": true, "type": "string" }, "patronymic": { "description": "Patronymic (name derived from the father), common in Slavic naming conventions.", "minLength": 1, "nullable": true, "type": "string" } }, "type": "object" }, "nationalities": { "description": "Nationalities held by the individual, most-recent/primary first when ordering is implied.", "items": { "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "places_of_birth": { "description": "One or more places of birth.", "items": { "additionalProperties": false, "properties": { "city": { "description": "City or town of birth.", "minLength": 1, "nullable": true, "type": "string" }, "country": { "description": "Country of birth as published.", "minLength": 1, "nullable": true, "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code of the place of birth when available.", "minLength": 1, "nullable": true, "type": "string" }, "region": { "description": "State, province, or other sub-national region of birth.", "minLength": 1, "nullable": true, "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "positions": { "description": "Official roles or positions the person holds or held.", "items": { "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "primary_name": { "description": "Canonical name as published by the sanctions authority.", "example": "Vladimir Putin", "minLength": 1, "type": "string" }, "programs": { "description": "Program codes under which the listing is maintained (e.g. OFAC programs `SDGT`, `UKRAINE-EO13662`).", "items": { "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "remarks": { "description": "Free-form remarks from the source, often conveying provenance or context.", "minLength": 1, "nullable": true, "type": "string" }, "source": { "description": "Sanctions list the entry comes from.", "enum": [ "ofac_sdn", "ofac_cons", "eu" ], "example": "ofac_sdn", "type": "string" }, "titles": { "description": "Honorifics and ranks (e.g. \"Major General\", \"Dr.\").", "items": { "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "transport_info": { "additionalProperties": false, "description": "Vessel- or aircraft-specific details; populated when `entity_type` is `vessel` or `aircraft`.", "nullable": true, "properties": { "call_sign": { "description": "Radio call sign assigned to the vessel or aircraft.", "minLength": 1, "nullable": true, "type": "string" }, "construction_number": { "description": "Construction or build number as assigned by the shipyard or plant.", "minLength": 1, "nullable": true, "type": "string" }, "flag": { "description": "Current flag state (country of registration).", "minLength": 1, "nullable": true, "type": "string" }, "former_flags": { "description": "Previously held flags, newest first.", "items": { "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "gross_tonnage": { "description": "Gross tonnage as published.", "minLength": 1, "nullable": true, "type": "string" }, "hull_id": { "description": "Hull identification number or keel laying reference.", "minLength": 1, "nullable": true, "type": "string" }, "imo_number": { "description": "IMO number — permanent 7-digit vessel identifier.", "minLength": 1, "nullable": true, "type": "string" }, "length": { "description": "Overall length as published (unit varies by source).", "minLength": 1, "nullable": true, "type": "string" }, "manufacturer_serial": { "description": "MSN — manufacturer serial number specific to aircraft.", "minLength": 1, "nullable": true, "type": "string" }, "mmsi": { "description": "Maritime Mobile Service Identity — 9-digit radio identifier used by AIS.", "minLength": 1, "nullable": true, "type": "string" }, "model": { "description": "Aircraft or vessel model designation.", "minLength": 1, "nullable": true, "type": "string" }, "operator": { "description": "Current operator of the craft when distinct from owner.", "minLength": 1, "nullable": true, "type": "string" }, "serial_number": { "description": "Manufacturer serial number.", "minLength": 1, "nullable": true, "type": "string" }, "tail_number": { "description": "Aircraft tail number (ICAO/registration).", "minLength": 1, "nullable": true, "type": "string" }, "tonnage": { "description": "Deadweight tonnage as published; kept as string because sources use mixed units.", "minLength": 1, "nullable": true, "type": "string" }, "transponder_code": { "description": "Aircraft transponder (squawk) code, when published.", "minLength": 1, "nullable": true, "type": "string" }, "vessel_type": { "description": "Vessel category (e.g. \"Oil tanker\", \"Cargo\").", "minLength": 1, "nullable": true, "type": "string" }, "year_built": { "description": "Year the vessel or aircraft was built; string to preserve ranges (\"1995–1997\").", "minLength": 1, "nullable": true, "type": "string" } }, "type": "object" } }, "required": [ "id", "source", "entity_type", "primary_name" ], "type": "object" }, "list_version": { "description": "Version identifier of the source list used to produce this match, useful for audit/replay.", "example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "minLength": 1, "type": "string" }, "matched_name": { "description": "The specific name on the entry that scored the match (primary name or one of the aliases).", "example": "Vladimir Putin", "minLength": 1, "type": "string" }, "score": { "description": "Similarity score in the range 0.0–1.0. Higher is a closer match.", "example": 0.99, "type": "number" } }, "required": [ "entry", "matched_name", "score", "list_version" ], "type": "object" }, "nullable": true, "type": "array" }, "preprocessed_query": { "description": "The query after normalization (casefolding, diacritic stripping, etc.) — the form that was actually compared against list entries.", "example": "vladimir putin", "type": "string" }, "query": { "description": "The original name submitted by the caller, unchanged.", "example": "Vladimir Putin", "minLength": 1, "type": "string" }, "searched_lists": { "description": "Slug list of the sanction sources actually searched (e.g. `[\"ofac_sdn\"]`). Mirrors the requested `sources` once validity is checked.", "example": [ "ofac_sdn" ], "items": { "example": "ofac_sdn", "minLength": 1, "type": "string" }, "nullable": true, "type": "array" }, "threshold": { "description": "Minimum score a match had to clear to be included in `matches`.", "example": 0.85, "type": "number" }, "total_matches": { "description": "Number of entries in `matches`. Present for clients that paginate client-side.", "example": 1, "nullable": true, "type": "integer" } }, "required": [ "query", "preprocessed_query", "algorithm", "threshold" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Request validation failed." }, "422": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "`invalid_screening_parameters` — A screening query parameter is missing, malformed, or out of range" }, "429": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "`rate_limited` — Retry after the duration advertised in the Retry-After header" }, "503": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "`sources_not_ready` — Some requested sources are not yet indexed" }, "default": { "$ref": "#/components/responses/errors" } }, "security": [], "tags": [ "sanction_screening" ] } }, "/api/v1/request-logs": { "get": { "callbacks": {}, "deprecated": false, "description": "List request logs visible to the authenticated API token.", "operationId": "listRequestLogs", "parameters": [ { "description": "Filters the query to results with attributes matching the given filter object", "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/request_log-filter--listRequestLogs" }, "style": "deepObject" }, { "description": "Sort order to apply to the results", "explode": false, "in": "query", "name": "sort", "required": false, "schema": { "pattern": "^(id|\\-id|status|\\-status|duration_ms|\\-duration_ms|timestamp|\\-timestamp)(,(id|\\-id|status|\\-status|duration_ms|\\-duration_ms|timestamp|\\-timestamp))*$", "type": "string" }, "style": "form" }, { "description": "Paginates the response with the limit and offset or keyset pagination.", "in": "query", "name": "page", "required": false, "schema": { "additionalProperties": false, "example": { "limit": 25 }, "minProperties": 1, "not": { "required": [ "after", "before" ], "type": "object" }, "properties": { "after": { "minLength": 1, "type": "string" }, "before": { "minLength": 1, "type": "string" }, "count": { "default": false, "example": false, "type": "boolean" }, "limit": { "default": 25, "example": 25, "maximum": 100, "minimum": 1, "type": "integer" } }, "type": "object" }, "style": "deepObject" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "example": "ip_info", "pattern": "^(ip_info)(,(ip_info))*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": false, "example": { "ip_info": "id,asn,as_name,as_domain,country_code,country,continent_code,continent", "request_log": "method,path,status,duration_ms,ip,user_agent,referrer,request_id,timestamp" }, "minProperties": 1, "properties": { "ip_info": { "example": "id,asn,as_name,as_domain,country_code,country,continent_code,continent", "minLength": 1, "pattern": "^(id|asn|as_name|as_domain|country_code|country|continent_code|continent)(,(id|asn|as_name|as_domain|country_code|country|continent_code|continent))*$", "type": "string" }, "request_log": { "example": "method,path,status,duration_ms,ip,user_agent,referrer,request_id,timestamp", "minLength": 1, "pattern": "^(method|path|status|duration_ms|ip|user_agent|referrer|request_id|timestamp)(,(method|path|status|duration_ms|ip|user_agent|referrer|request_id|timestamp))*$", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "example": { "data": [ { "attributes": { "duration_ms": 42, "ip": "203.0.113.10", "method": "GET", "path": "/articles/example", "referrer": "https://example.com/", "request_id": "F5-example-request", "status": 200, "timestamp": "2026-07-12T12:00:00.000000Z", "user_agent": "ExampleClient/1.0" }, "id": "1", "type": "request_log" } ] }, "schema": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/request_log" }, "type": "array", "uniqueItems": true }, "included": { "items": { "oneOf": [ { "$ref": "#/components/schemas/ip_info" } ] }, "type": "array", "uniqueItems": true }, "jsonapi": { "additionalProperties": true, "type": "object" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Request validation failed." }, "401": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Authentication required." }, "403": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "The API token does not have the required permission." }, "429": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Rate limit exceeded." }, "default": { "$ref": "#/components/responses/errors" } }, "security": [ { "ApiTokenAuth": [] } ], "tags": [ "request_log" ], "x-filter-complexity-budget": { "maxDepth": 8, "maxItems": 32, "maxNodes": 100, "maxProperties": 16, "maxTextLength": 512 }, "x-required-permissions": [ "request_logs_read" ] } }, "/api/v1/sanction-lists": { "get": { "callbacks": {}, "deprecated": false, "description": "List configured sanctions sources and their active versions.", "operationId": "listSanctionLists", "parameters": [ { "description": "Paginates the response with the limit and offset or keyset pagination.", "in": "query", "name": "page", "required": false, "schema": { "additionalProperties": false, "example": { "limit": 1 }, "minProperties": 1, "not": { "required": [ "after", "before" ], "type": "object" }, "properties": { "after": { "minLength": 1, "type": "string" }, "before": { "minLength": 1, "type": "string" }, "count": { "default": false, "example": false, "type": "boolean" }, "limit": { "example": 1, "maximum": 250, "minimum": 1, "type": "integer" }, "offset": { "example": 0, "maximum": 1000000, "minimum": 0, "type": "integer" } }, "type": "object" }, "style": "deepObject" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "example": "active_version", "pattern": "^(active_version)(,(active_version))*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": false, "example": { "sanction_list": "id,slug,active_version_id,active_version,versions", "sanction_list_version": "id,source_slug,sha256,record_count,publish_date,storage_key,byte_size,content_type,parser_module,fetched_at,last_seen_at" }, "minProperties": 1, "properties": { "sanction_list": { "example": "id,slug,active_version_id,active_version,versions", "minLength": 1, "pattern": "^(id|slug|active_version_id|active_version|versions)(,(id|slug|active_version_id|active_version|versions))*$", "type": "string" }, "sanction_list_version": { "example": "id,source_slug,sha256,record_count,publish_date,storage_key,byte_size,content_type,parser_module,fetched_at,last_seen_at", "minLength": 1, "pattern": "^(id|source_slug|sha256|record_count|publish_date|storage_key|byte_size|content_type|parser_module|fetched_at|last_seen_at)(,(id|source_slug|sha256|record_count|publish_date|storage_key|byte_size|content_type|parser_module|fetched_at|last_seen_at))*$", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "example": { "data": [ { "attributes": { "active_version_id": "018f0f67-54f4-7c7d-8f4f-9bb38f1c4e24", "slug": "ofac_sdn" }, "id": "ofac_sdn", "type": "sanction_list" } ] }, "schema": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/sanction_list" }, "type": "array", "uniqueItems": true }, "included": { "items": { "oneOf": [ { "$ref": "#/components/schemas/sanction_list_version" } ] }, "type": "array", "uniqueItems": true }, "jsonapi": { "additionalProperties": true, "type": "object" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "Request validation failed." }, "default": { "$ref": "#/components/responses/errors" } }, "security": [], "tags": [ "sanction_list" ] } } }, "security": [ { "bearerAuth": [] } ], "servers": [ { "url": "https://aight.blog", "variables": {} } ], "tags": [] }