{"basePath": "/api/1", "consumes": ["application/json"], "definitions": {"AccessAudience (read)": {"properties": {"condition": {"enum": ["yes", "no", "under_condition"], "example": "yes", "type": "string"}, "role": {"enum": ["local_authority_and_administration", "company_and_association", "private"], "example": "local_authority_and_administration", "type": "string"}}, "type": "object"}, "AccessAudience (write)": {"properties": {"condition": {"enum": ["yes", "no", "under_condition"], "example": "yes", "type": "string"}, "role": {"enum": ["local_authority_and_administration", "company_and_association", "private"], "example": "local_authority_and_administration", "type": "string"}}, "type": "object"}, "Activity (read)": {"properties": {"actor": {"description": "Who performed the action", "readOnly": true, "type": "object"}, "changes": {"description": "Changed attributes as list", "items": {"description": "Changed attributes as list", "readOnly": true, "type": "string"}, "readOnly": true, "type": "array"}, "created_at": {"description": "When the action has been performed", "format": "date-time", "readOnly": true, "type": "string"}, "extras": {"description": "Extras attributes as key-value pairs", "readOnly": true, "type": "object"}, "icon": {"description": "The icon of the activity", "readOnly": true, "type": "string"}, "id": {"readOnly": true, "type": "string"}, "key": {"description": "The key of the activity", "readOnly": true, "type": "string"}, "label": {"description": "The label of the activity", "readOnly": true, "type": "string"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "The organization who performed the action", "readOnly": true}, "related_to": {"description": "The activity target name", "readOnly": true, "type": "string"}, "related_to_id": {"description": "The activity target object identifier", "readOnly": true, "type": "string"}, "related_to_kind": {"description": "The activity target object class name", "readOnly": true, "type": "string"}, "related_to_url": {"description": "The activity target url", "readOnly": true, "type": "string"}}, "required": ["actor", "created_at", "id", "related_to"], "type": "object"}, "ActivityPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Activity (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "ApiToken (read)": {"properties": {"created_at": {"description": "Token creation date", "format": "date-time", "readOnly": true, "type": "string"}, "expires_at": {"description": "When this token expires", "format": "date-time", "type": "string"}, "id": {"readOnly": true, "type": "string"}, "kind": {"description": "Token type", "enum": ["api_key"], "example": "api_key", "readOnly": true, "type": "string"}, "last_used_at": {"description": "Last time this token was used", "format": "date-time", "readOnly": true, "type": "string"}, "name": {"description": "User-given label for this token", "maxLength": 255, "type": "string"}, "revoked_at": {"description": "When this token was revoked", "format": "date-time", "readOnly": true, "type": "string"}, "scopes": {"description": "Token scopes", "items": {"description": "Token scopes", "enum": ["admin"], "example": "admin", "type": "string"}, "type": "array"}, "token_prefix": {"description": "First characters of the token for identification", "readOnly": true, "type": "string"}, "user_agents": {"description": "User agents that have used this token", "items": {"description": "User agents that have used this token", "readOnly": true, "type": "string"}, "readOnly": true, "type": "array"}}, "required": ["created_at", "id", "token_prefix"], "type": "object"}, "ApiToken (write)": {"properties": {"expires_at": {"description": "When this token expires", "format": "date-time", "type": "string"}, "name": {"description": "User-given label for this token", "maxLength": 255, "type": "string"}, "scopes": {"description": "Token scopes", "items": {"description": "Token scopes", "enum": ["admin"], "example": "admin", "type": "string"}, "type": "array"}}, "type": "object"}, "ApiTokenCreated": {"allOf": [{"$ref": "#/definitions/ApiToken (read)"}, {"properties": {"token": {"description": "The plaintext token (shown only once at creation)", "readOnly": true, "type": "string"}}, "type": "object"}]}, "Assignment (read)": {"properties": {"created_at": {"format": "date-time", "readOnly": true, "type": "string"}, "id": {"readOnly": true, "type": "string"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "readOnly": true}, "subject": {"type": "object"}, "user": {"$ref": "#/definitions/UserReference"}}, "required": ["id", "organization", "subject", "user"], "type": "object"}, "Badge (read)": {"properties": {"kind": {"type": "string"}}, "required": ["kind"], "type": "object"}, "Badge (write)": {"properties": {"kind": {"type": "string"}}, "required": ["kind"], "type": "object"}, "BaseReference": {"discriminator": "class", "properties": {"class": {"description": "The object class", "type": "string"}, "id": {"description": "The object unique identifier", "type": "string"}}, "required": ["class", "id"], "type": "object"}, "CatalogSchema": {"properties": {"consolidation_dataset_id": {"type": "string"}, "contact": {"type": "string"}, "datapackage_description": {"description": "Only present if the schema is inside a datapackage", "type": "string"}, "datapackage_name": {"description": "Only present if the schema is inside a datapackage", "type": "string"}, "datapackage_title": {"description": "Only present if the schema is inside a datapackage", "type": "string"}, "description": {"type": "string"}, "examples": {"items": {"$ref": "#/definitions/CatalogSchemaExample"}, "type": "array"}, "external_doc": {"type": "string"}, "external_tool": {"description": "Link to tools to create a file with this schema", "type": "string"}, "homepage": {"type": "string"}, "labels": {"items": {"type": "string"}, "type": "array"}, "name": {"type": "string"}, "schema_type": {"enum": ["tableschema", "datapackage", "jsonschema", "other"], "example": "tableschema", "type": "string"}, "schema_url": {"description": "Often the link to the latest version", "type": "string"}, "title": {"type": "string"}, "versions": {"items": {"$ref": "#/definitions/CatalogSchemaVersion"}, "type": "array"}}, "type": "object"}, "CatalogSchemaExample": {"properties": {"path": {"type": "string"}, "title": {"type": "string"}}, "type": "object"}, "CatalogSchemaVersion": {"properties": {"schema_url": {"type": "string"}, "version_name": {"type": "string"}}, "type": "object"}, "Chart (read)": {"properties": {"created_at": {"format": "date-time", "readOnly": true, "type": "string"}, "deleted_at": {"format": "date-time", "readOnly": true, "type": "string"}, "description": {"format": "markdown", "type": "string"}, "extras": {"type": "object"}, "id": {"readOnly": true, "type": "string"}, "image": {"description": "URL of the image", "readOnly": true, "type": "string"}, "last_modified": {"format": "date-time", "readOnly": true, "type": "string"}, "metrics": {"readOnly": true, "type": "object"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user."}, "owner": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "Only present if organization is not set. Can only be set to the current authenticated user."}, "permissions": {"allOf": [{"$ref": "#/definitions/VisualizationPermissions"}], "readOnly": true}, "private": {"type": "boolean"}, "series": {"items": {"$ref": "#/definitions/DataSeries (read)"}, "type": "array"}, "slug": {"maxLength": 255, "readOnly": true, "type": "string"}, "title": {"type": "string"}, "x_axis": {"$ref": "#/definitions/XAxis (read)"}, "y_axis": {"$ref": "#/definitions/YAxis (read)"}}, "required": ["created_at", "description", "id", "last_modified", "series", "slug", "title", "x_axis"], "type": "object"}, "Chart (write)": {"properties": {"description": {"format": "markdown", "type": "string"}, "extras": {"type": "object"}, "organization": {"description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user.", "type": "string"}, "owner": {"description": "Only present if organization is not set. Can only be set to the current authenticated user.", "type": "string"}, "private": {"type": "boolean"}, "series": {"items": {"$ref": "#/definitions/DataSeries (write)"}, "type": "array"}, "title": {"type": "string"}, "x_axis": {"$ref": "#/definitions/XAxis (write)"}, "y_axis": {"$ref": "#/definitions/YAxis (write)"}}, "required": ["description", "series", "title", "x_axis"], "type": "object"}, "ChartPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Chart (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "Checksum": {"properties": {"type": {"default": "sha1", "description": "The hashing algorithm used to compute the checksum", "enum": ["sha1", "sha2", "sha256", "md5", "crc"], "example": "sha1", "type": "string"}, "value": {"description": "The resulting checksum/hash", "type": "string"}}, "required": ["value"], "type": "object"}, "CommunityResource": {"allOf": [{"$ref": "#/definitions/Resource"}, {"properties": {"dataset": {"allOf": [{"$ref": "#/definitions/DatasetReference"}], "description": "Reference to the associated dataset"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "The producer organization"}, "owner": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The user information"}, "permissions": {"$ref": "#/definitions/DatasetPermissions"}}, "type": "object"}]}, "CommunityResourcePage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/CommunityResource"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "ContactPoint (read)": {"properties": {"contact_form": {"type": "string"}, "email": {"maxLength": 255, "type": "string"}, "id": {"readOnly": true, "type": "string"}, "name": {"maxLength": 255, "type": "string"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user."}, "owner": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "Only present if organization is not set. Can only be set to the current authenticated user."}, "role": {"enum": ["contact", "creator", "publisher", "rightsHolder", "custodian", "distributor", "originator", "principalInvestigator", "processor", "resourceProvider", "user"], "example": "contact", "type": "string"}}, "required": ["id", "role"], "type": "object"}, "ContactPoint (write)": {"properties": {"contact_form": {"type": "string"}, "email": {"maxLength": 255, "type": "string"}, "name": {"maxLength": 255, "type": "string"}, "organization": {"description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user.", "type": "string"}, "owner": {"description": "Only present if organization is not set. Can only be set to the current authenticated user.", "type": "string"}, "role": {"enum": ["contact", "creator", "publisher", "rightsHolder", "custodian", "distributor", "originator", "principalInvestigator", "processor", "resourceProvider", "user"], "example": "contact", "type": "string"}}, "required": ["role"], "type": "object"}, "ContactPointPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/ContactPoint (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "ContactPointReference": {"allOf": [{"$ref": "#/definitions/BaseReference"}, {"properties": {}, "type": "object"}]}, "ContactPointRoles": {"properties": {"id": {"description": "The contact role identifier", "type": "string"}, "label": {"description": "The contact role display name", "type": "string"}}, "type": "object"}, "Crontab (read)": {"properties": {"day_of_month": {"type": "string"}, "day_of_week": {"type": "string"}, "hour": {"type": "string"}, "minute": {"type": "string"}, "month_of_year": {"type": "string"}}, "required": ["day_of_month", "day_of_week", "hour", "minute", "month_of_year"], "type": "object"}, "Crontab (write)": {"properties": {"day_of_month": {"type": "string"}, "day_of_week": {"type": "string"}, "hour": {"type": "string"}, "minute": {"type": "string"}, "month_of_year": {"type": "string"}}, "required": ["day_of_month", "day_of_week", "hour", "minute", "month_of_year"], "type": "object"}, "DataSeries (read)": {"properties": {"aggregate_y": {"enum": ["avg", "sum", "count", "min", "max"], "example": "avg", "type": "string"}, "column_x_name_override": {"type": "string"}, "column_y": {"type": "string"}, "filters": {"type": "object"}, "resource_id": {"type": "string"}, "type": {"enum": ["line", "histogram"], "example": "line", "type": "string"}}, "required": ["resource_id"], "type": "object"}, "DataSeries (write)": {"properties": {"aggregate_y": {"enum": ["avg", "sum", "count", "min", "max"], "example": "avg", "type": "string"}, "column_x_name_override": {"type": "string"}, "column_y": {"type": "string"}, "filters": {"type": "object"}, "resource_id": {"type": "string"}, "type": {"enum": ["line", "histogram"], "example": "line", "type": "string"}}, "required": ["resource_id"], "type": "object"}, "Dataservice (read)": {"properties": {"access_audiences": {"items": {"$ref": "#/definitions/AccessAudience (read)"}, "type": "array"}, "access_type": {"enum": ["open", "open_with_account", "restricted"], "example": "open", "type": "string"}, "access_type_reason": {"type": "string"}, "access_type_reason_category": {"enum": ["confidentiality_of_proceedings_of_public_authorities", "international_relations_public_security_or_national_defence", "course_of_justice_or_fair_trial", "confidentiality_of_commercial_or_industrial_information", "intellectual_property_rights", "confidentiality_of_personal_data", "protection_of_voluntary_information_suppliers", "protection_of_environment"], "example": "confidentiality_of_proceedings_of_public_authorities", "type": "string"}, "acronym": {"maxLength": 128, "type": "string"}, "archived_at": {"format": "date-time", "type": "string"}, "authorization_request_url": {"type": "string"}, "availability": {"example": "99.99", "type": "number"}, "availability_url": {"type": "string"}, "badges": {"items": {"allOf": [{"$ref": "#/definitions/Badge (read)"}], "readOnly": true}, "readOnly": true, "type": "array"}, "base_api_url": {"type": "string"}, "business_documentation_url": {"type": "string"}, "contact_points": {"items": {"$ref": "#/definitions/ContactPoint (read)"}, "type": "array"}, "created_at": {"format": "date-time", "readOnly": true, "type": "string"}, "datasets": {"description": "Visit this API link to see the list.", "type": "object"}, "deleted_at": {"format": "date-time", "type": "string"}, "description": {"format": "markdown", "type": "string"}, "extras": {"type": "object"}, "featured": {"readOnly": true, "type": "boolean"}, "format": {"enum": ["REST", "WMS", "WSL"], "example": "REST", "type": "string"}, "harvest": {"allOf": [{"$ref": "#/definitions/HarvestDataserviceMetadata (read)"}], "readOnly": true}, "id": {"readOnly": true, "type": "string"}, "license": {"description": "The ID of the license", "type": "string"}, "machine_documentation_url": {"description": "Swagger link, OpenAPI format, WMS XML\u2026", "type": "string"}, "metadata_modified_at": {"format": "date-time", "readOnly": true, "type": "string"}, "metrics": {"readOnly": true, "type": "object"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user."}, "owner": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "Only present if organization is not set. Can only be set to the current authenticated user."}, "permissions": {"allOf": [{"$ref": "#/definitions/DataservicePermissions"}], "readOnly": true}, "private": {"description": "Is the dataservice private to the owner or the organization", "type": "boolean"}, "rate_limiting": {"type": "string"}, "rate_limiting_url": {"type": "string"}, "self_api_url": {"description": "Link to the API endpoint for this dataservice", "readOnly": true, "type": "string"}, "self_web_url": {"description": "Link to the udata web page for this dataservice", "readOnly": true, "type": "string"}, "slug": {"maxLength": 255, "readOnly": true, "type": "string"}, "tags": {"items": {"type": "string"}, "type": "array"}, "technical_documentation_url": {"description": "HTML version of a Swagger\u2026", "type": "string"}, "title": {"example": "My awesome API", "type": "string"}}, "required": ["created_at", "id", "metadata_modified_at", "slug", "title"], "type": "object"}, "Dataservice (write)": {"properties": {"access_audiences": {"items": {"$ref": "#/definitions/AccessAudience (write)"}, "type": "array"}, "access_type": {"enum": ["open", "open_with_account", "restricted"], "example": "open", "type": "string"}, "access_type_reason": {"type": "string"}, "access_type_reason_category": {"enum": ["confidentiality_of_proceedings_of_public_authorities", "international_relations_public_security_or_national_defence", "course_of_justice_or_fair_trial", "confidentiality_of_commercial_or_industrial_information", "intellectual_property_rights", "confidentiality_of_personal_data", "protection_of_voluntary_information_suppliers", "protection_of_environment"], "example": "confidentiality_of_proceedings_of_public_authorities", "type": "string"}, "acronym": {"maxLength": 128, "type": "string"}, "archived_at": {"format": "date-time", "type": "string"}, "authorization_request_url": {"type": "string"}, "availability": {"example": "99.99", "type": "number"}, "availability_url": {"type": "string"}, "base_api_url": {"type": "string"}, "business_documentation_url": {"type": "string"}, "contact_points": {"items": {"description": "ID of the reference", "type": "string"}, "type": "array"}, "datasets": {"items": {"description": "ID of the reference", "type": "string"}, "type": "array"}, "deleted_at": {"format": "date-time", "type": "string"}, "description": {"format": "markdown", "type": "string"}, "extras": {"type": "object"}, "format": {"enum": ["REST", "WMS", "WSL"], "example": "REST", "type": "string"}, "license": {"description": "The ID of the license", "type": "string"}, "machine_documentation_url": {"description": "Swagger link, OpenAPI format, WMS XML\u2026", "type": "string"}, "organization": {"description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user.", "type": "string"}, "owner": {"description": "Only present if organization is not set. Can only be set to the current authenticated user.", "type": "string"}, "private": {"description": "Is the dataservice private to the owner or the organization", "type": "boolean"}, "rate_limiting": {"type": "string"}, "rate_limiting_url": {"type": "string"}, "tags": {"items": {"type": "string"}, "type": "array"}, "technical_documentation_url": {"description": "HTML version of a Swagger\u2026", "type": "string"}, "title": {"example": "My awesome API", "type": "string"}}, "required": ["title"], "type": "object"}, "DataserviceDatasetsAdd": {"properties": {"id": {"description": "Id of the dataset to add", "type": "string"}}, "required": ["id"], "type": "object"}, "DataservicePage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Dataservice (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "DataservicePermissions": {"properties": {"delete": {"type": "boolean"}, "edit": {"type": "boolean"}}, "type": "object"}, "DataservicePreview": {"properties": {"self_api_url": {"description": "The dataservice API URL (fake)", "type": "object"}, "self_web_url": {"description": "The dataservice webpage URL (fake)", "type": "object"}, "title": {"example": "My awesome API", "type": "string"}}, "required": ["title"], "type": "object"}, "DataserviceReference": {"allOf": [{"$ref": "#/definitions/BaseReference"}, {"properties": {"self_api_url": {"description": "Link to the API endpoint for this dataservice", "readOnly": true, "type": "string"}, "self_web_url": {"description": "Link to the udata web page for this dataservice", "readOnly": true, "type": "string"}, "title": {"example": "My awesome API", "type": "string"}}, "required": ["title"], "type": "object"}]}, "DataserviceSuggestion": {"properties": {"acronym": {"description": "An optional dataservice acronym", "readOnly": true, "type": "string"}, "id": {"description": "The dataservice identifier", "readOnly": true, "type": "string"}, "page": {"description": "The dataservice web page URL", "readOnly": true, "type": "string"}, "slug": {"description": "The dataservice permalink string", "readOnly": true, "type": "string"}, "title": {"description": "The dataservice title", "readOnly": true, "type": "string"}}, "type": "object"}, "Dataset": {"properties": {"access_audiences": {"items": {"$ref": "#/definitions/AccessAudience (read)"}, "type": "array"}, "access_type": {"type": "string"}, "access_type_reason": {"type": "string"}, "access_type_reason_category": {"type": "string"}, "acronym": {"description": "An optional dataset acronym", "type": "string"}, "archived": {"description": "The archival date if archived", "format": "date-time", "type": "string"}, "authorization_request_url": {"type": "string"}, "badges": {"description": "The dataset badges", "items": {"$ref": "#/definitions/Badge (read)"}, "readOnly": true, "type": "array"}, "community_resources": {"items": {"allOf": [{"$ref": "#/definitions/CommunityResource"}], "description": "The dataset community submitted resources"}, "type": "array"}, "contact_points": {"items": {"allOf": [{"$ref": "#/definitions/ContactPoint (read)"}], "description": "The dataset contact points"}, "type": "array"}, "created_at": {"description": "This date is computed between harvested creation date if any and site's internal creation date", "format": "date-time", "readOnly": true, "type": "string"}, "deleted": {"description": "The deletion date if deleted", "format": "date-time", "readOnly": true, "type": "string"}, "description": {"description": "The dataset description in markdown", "format": "markdown", "type": "string"}, "description_short": {"description": "The dataset short description", "type": "string"}, "doi": {"description": "The DOI minted for this dataset", "readOnly": true, "type": "string"}, "extras": {"description": "Extras attributes as key-value pairs", "type": "object"}, "featured": {"description": "Is the dataset featured", "type": "boolean"}, "frequency": {"default": "unknown", "description": "The update frequency", "enum": ["continuous", "oneMinute", "fiveMinutes", "tenMinutes", "fifteenMinutes", "thirtyMinutes", "hourly", "bihourly", "trihourly", "twelveHours", "severalTimesADay", "threeTimesADay", "semidaily", "daily", "fiveTimesAWeek", "threeTimesAWeek", "semiweekly", "weekly", "biweekly", "threeTimesAMonth", "semimonthly", "monthly", "bimonthly", "quarterly", "threeTimesAYear", "semiannual", "annual", "biennial", "triennial", "quadrennial", "quinquennial", "decennial", "bidecennial", "tridecennial", "punctual", "irregular", "never", "notPlanned", "other", "unknown"], "example": "continuous", "type": "string"}, "frequency_date": {"description": "Next expected update date, you will be notified once that date is reached.", "format": "date-time", "type": "string"}, "geopf": {"allOf": [{"$ref": "#/definitions/GeopfDatasetMetadata"}], "description": "G\u00e9oplateforme sync status metadata", "readOnly": true}, "harvest": {"allOf": [{"$ref": "#/definitions/HarvestDatasetMetadata"}], "description": "Dataset harvest metadata attributes", "readOnly": true}, "id": {"description": "The dataset identifier", "readOnly": true, "type": "string"}, "internal": {"allOf": [{"$ref": "#/definitions/DatasetInternals"}], "description": "Site internal and specific object's data", "readOnly": true}, "last_modified": {"description": "The dataset last modification date", "format": "date-time", "readOnly": true, "type": "string"}, "last_update": {"description": "The resources last modification date", "format": "date-time", "type": "string"}, "license": {"default": "notspecified", "description": "The dataset license", "type": "string"}, "metrics": {"description": "The dataset metrics", "type": "object"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "The producer organization"}, "owner": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The user information"}, "page": {"description": "The dataset web page URL", "readOnly": true, "type": "string"}, "permissions": {"$ref": "#/definitions/DatasetPermissions"}, "private": {"description": "Is the dataset private to the owner or the organization", "type": "boolean"}, "quality": {"description": "The dataset quality", "readOnly": true, "type": "object"}, "resources": {"items": {"allOf": [{"$ref": "#/definitions/Resource"}], "description": "The dataset resources"}, "type": "array"}, "schema": {"allOf": [{"$ref": "#/definitions/Schema"}], "description": "Reference to the associated schema"}, "slug": {"description": "The dataset permalink string", "readOnly": true, "type": "string"}, "spatial": {"allOf": [{"$ref": "#/definitions/SpatialCoverage (read)"}], "description": "The spatial coverage"}, "tags": {"items": {"type": "string"}, "type": "array"}, "temporal_coverage": {"allOf": [{"$ref": "#/definitions/TemporalCoverage"}], "description": "The temporal coverage"}, "title": {"description": "The dataset title", "type": "string"}, "uri": {"description": "The API URI for this dataset", "readOnly": true, "type": "string"}}, "required": ["created_at", "description", "frequency", "last_modified", "last_update", "title"], "type": "object", "x-mask": "{id,title,acronym,slug,description,description_short,created_at,last_modified,deleted,private,tags,badges,resources,frequency,frequency_date,extras,harvest,geopf,metrics,organization,owner,schema,temporal_coverage,spatial,license,access_type,access_audiences,authorization_request_url,access_type_reason_category,access_type_reason,uri,page,last_update,archived,doi,quality,internal,contact_points,featured,permissions}"}, "Dataset (read)": {"properties": {"access_audiences": {"items": {"$ref": "#/definitions/AccessAudience (read)"}, "type": "array"}, "access_type": {"enum": ["open", "open_with_account", "restricted"], "example": "open", "type": "string"}, "access_type_reason": {"type": "string"}, "access_type_reason_category": {"enum": ["confidentiality_of_proceedings_of_public_authorities", "international_relations_public_security_or_national_defence", "course_of_justice_or_fair_trial", "confidentiality_of_commercial_or_industrial_information", "intellectual_property_rights", "confidentiality_of_personal_data", "protection_of_voluntary_information_suppliers", "protection_of_environment"], "example": "confidentiality_of_proceedings_of_public_authorities", "type": "string"}, "acronym": {"maxLength": 128, "type": "string"}, "archived": {"format": "date-time", "type": "string"}, "authorization_request_url": {"type": "string"}, "badges": {"items": {"allOf": [{"$ref": "#/definitions/Badge (read)"}], "readOnly": true}, "readOnly": true, "type": "array"}, "contact_points": {"items": {"$ref": "#/definitions/ContactPointReference"}, "type": "array"}, "created_at_internal": {"format": "date-time", "type": "string"}, "deleted": {"format": "date-time", "type": "string"}, "description": {"format": "markdown", "type": "string"}, "description_short": {"maxLength": 200, "type": "string"}, "doi": {"description": "The DOI minted for this dataset, set by the DOI endpoint. A dataset that has one can no longer be deleted, only archived.", "readOnly": true, "type": "string"}, "ext": {"type": "object"}, "extras": {"type": "object"}, "featured": {"type": "boolean"}, "frequency": {"enum": ["continuous", "oneMinute", "fiveMinutes", "tenMinutes", "fifteenMinutes", "thirtyMinutes", "hourly", "bihourly", "trihourly", "twelveHours", "severalTimesADay", "threeTimesADay", "semidaily", "daily", "fiveTimesAWeek", "threeTimesAWeek", "semiweekly", "weekly", "biweekly", "threeTimesAMonth", "semimonthly", "monthly", "bimonthly", "quarterly", "threeTimesAYear", "semiannual", "annual", "biennial", "triennial", "quadrennial", "quinquennial", "decennial", "bidecennial", "tridecennial", "punctual", "irregular", "never", "notPlanned", "other", "unknown"], "example": "continuous", "type": "string"}, "frequency_date": {"format": "date-time", "type": "string"}, "geopf": {"$ref": "#/definitions/GeopfDatasetMetadata (read)"}, "harvest": {"allOf": [{"$ref": "#/definitions/HarvestDatasetMetadata (read)"}], "readOnly": true}, "id": {"readOnly": true, "type": "string"}, "last_modified_internal": {"format": "date-time", "type": "string"}, "last_update": {"format": "date-time", "type": "string"}, "license": {"type": "string"}, "metrics": {"readOnly": true, "type": "object"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user."}, "owner": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "Only present if organization is not set. Can only be set to the current authenticated user."}, "private": {"type": "boolean"}, "quality_cached": {"type": "object"}, "resources": {"items": {"$ref": "#/definitions/Resource (read)"}, "type": "array"}, "schema": {"$ref": "#/definitions/Schema (read)"}, "slug": {"maxLength": 255, "type": "string"}, "spatial": {"$ref": "#/definitions/SpatialCoverage (read)"}, "tags": {"items": {"type": "string"}, "type": "array"}, "temporal_coverage": {"$ref": "#/definitions/TemporalCoverage"}, "title": {"type": "string"}}, "required": ["created_at_internal", "description", "featured", "id", "last_modified_internal", "last_update", "slug", "title"], "type": "object"}, "DatasetInternals": {"properties": {"created_at_internal": {"description": "The dataset's internal creation date on the site", "format": "date-time", "type": "string"}, "last_modified_internal": {"description": "The dataset's internal last modification date", "format": "date-time", "type": "string"}}, "required": ["created_at_internal", "last_modified_internal"], "type": "object"}, "DatasetPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Dataset (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "DatasetPermissions": {"properties": {"delete": {"type": "boolean"}, "edit": {"type": "boolean"}, "edit_resources": {"type": "boolean"}}, "type": "object"}, "DatasetPreview": {"properties": {"access_audiences": {"items": {"$ref": "#/definitions/AccessAudience (read)"}, "type": "array"}, "access_type": {"type": "string"}, "access_type_reason": {"type": "string"}, "access_type_reason_category": {"type": "string"}, "acronym": {"description": "An optional dataset acronym", "type": "string"}, "archived": {"description": "The archival date if archived", "format": "date-time", "type": "string"}, "authorization_request_url": {"type": "string"}, "badges": {"description": "The dataset badges", "items": {"$ref": "#/definitions/Badge (read)"}, "readOnly": true, "type": "array"}, "community_resources": {"items": {"allOf": [{"$ref": "#/definitions/CommunityResource"}], "description": "The dataset community submitted resources"}, "type": "array"}, "contact_points": {"items": {"allOf": [{"$ref": "#/definitions/ContactPoint (read)"}], "description": "The dataset contact points"}, "type": "array"}, "created_at": {"description": "This date is computed between harvested creation date if any and site's internal creation date", "format": "date-time", "readOnly": true, "type": "string"}, "deleted": {"description": "The deletion date if deleted", "format": "date-time", "readOnly": true, "type": "string"}, "description": {"description": "The dataset description in markdown", "format": "markdown", "type": "string"}, "description_short": {"description": "The dataset short description", "type": "string"}, "doi": {"description": "The DOI minted for this dataset", "readOnly": true, "type": "string"}, "extras": {"description": "Extras attributes as key-value pairs", "type": "object"}, "featured": {"description": "Is the dataset featured", "type": "boolean"}, "frequency": {"default": "unknown", "description": "The update frequency", "enum": ["continuous", "oneMinute", "fiveMinutes", "tenMinutes", "fifteenMinutes", "thirtyMinutes", "hourly", "bihourly", "trihourly", "twelveHours", "severalTimesADay", "threeTimesADay", "semidaily", "daily", "fiveTimesAWeek", "threeTimesAWeek", "semiweekly", "weekly", "biweekly", "threeTimesAMonth", "semimonthly", "monthly", "bimonthly", "quarterly", "threeTimesAYear", "semiannual", "annual", "biennial", "triennial", "quadrennial", "quinquennial", "decennial", "bidecennial", "tridecennial", "punctual", "irregular", "never", "notPlanned", "other", "unknown"], "example": "continuous", "type": "string"}, "frequency_date": {"description": "Next expected update date, you will be notified once that date is reached.", "format": "date-time", "type": "string"}, "geopf": {"allOf": [{"$ref": "#/definitions/GeopfDatasetMetadata"}], "description": "G\u00e9oplateforme sync status metadata", "readOnly": true}, "harvest": {"allOf": [{"$ref": "#/definitions/HarvestDatasetMetadata"}], "description": "Dataset harvest metadata attributes", "readOnly": true}, "id": {"description": "The dataset identifier", "readOnly": true, "type": "string"}, "internal": {"allOf": [{"$ref": "#/definitions/DatasetInternals"}], "description": "Site internal and specific object's data", "readOnly": true}, "last_modified": {"description": "The dataset last modification date", "format": "date-time", "readOnly": true, "type": "string"}, "last_update": {"description": "The resources last modification date", "format": "date-time", "type": "string"}, "license": {"default": "notspecified", "description": "The dataset license", "type": "string"}, "metrics": {"description": "The dataset metrics", "type": "object"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "The producer organization"}, "owner": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The user information"}, "page": {"description": "The dataset page URL (fake)", "type": "object"}, "permissions": {"$ref": "#/definitions/DatasetPermissions"}, "private": {"description": "Is the dataset private to the owner or the organization", "type": "boolean"}, "quality": {"description": "The dataset quality", "readOnly": true, "type": "object"}, "resources": {"items": {"allOf": [{"$ref": "#/definitions/Resource"}], "description": "The dataset resources"}, "type": "array"}, "schema": {"allOf": [{"$ref": "#/definitions/Schema"}], "description": "Reference to the associated schema"}, "slug": {"description": "The dataset permalink string", "readOnly": true, "type": "string"}, "spatial": {"allOf": [{"$ref": "#/definitions/SpatialCoverage (read)"}], "description": "The spatial coverage"}, "tags": {"items": {"type": "string"}, "type": "array"}, "temporal_coverage": {"allOf": [{"$ref": "#/definitions/TemporalCoverage"}], "description": "The temporal coverage"}, "title": {"description": "The dataset title", "type": "string"}, "uri": {"description": "The dataset API URL (fake)", "type": "object"}}, "required": ["created_at", "description", "frequency", "last_modified", "last_update", "title"], "type": "object"}, "DatasetReference": {"allOf": [{"$ref": "#/definitions/BaseReference"}, {"properties": {}, "type": "object"}]}, "DatasetSuggestion": {"properties": {"acronym": {"description": "An optional dataset acronym", "type": "string"}, "id": {"description": "The dataset identifier", "type": "string"}, "image_url": {"description": "The dataset (organization) logo URL", "readOnly": true, "type": "string"}, "page": {"description": "The dataset web page URL", "readOnly": true, "type": "string"}, "slug": {"description": "The dataset permalink string", "type": "string"}, "title": {"description": "The dataset title", "type": "string"}}, "type": "object"}, "Discussion (read)": {"properties": {"closed": {"description": "The discussion closing date", "format": "date-time", "readOnly": true, "type": "string"}, "closed_by": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The user who closed the discussion", "readOnly": true}, "closed_by_organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "The organization who closed the discussion", "readOnly": true}, "created": {"description": "The discussion creation date", "format": "date-time", "readOnly": true, "type": "string"}, "discussion": {"description": "The list of messages in the discussion", "items": {"allOf": [{"$ref": "#/definitions/Message (read)"}], "description": "The list of messages in the discussion", "readOnly": true}, "readOnly": true, "type": "array"}, "extras": {"description": "Extra attributes as key-value pairs", "type": "object"}, "id": {"readOnly": true, "type": "string"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "The organization to publish on behalf of"}, "permissions": {"allOf": [{"$ref": "#/definitions/DiscussionPermissions"}], "readOnly": true}, "self_web_url": {"description": "The discussion web URL", "readOnly": true, "type": "string"}, "subject": {"allOf": [{"$ref": "#/definitions/ModelReference"}], "description": "The discussion target object"}, "title": {"description": "The discussion title", "type": "string"}, "url": {"description": "The discussion API URI", "readOnly": true, "type": "string"}, "user": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The discussion author", "readOnly": true}}, "required": ["created", "id", "subject", "title"], "type": "object"}, "DiscussionEdit": {"properties": {"title": {"description": "The new title", "type": "string"}}, "required": ["title"], "type": "object"}, "DiscussionEditComment": {"properties": {"comment": {"description": "The new comment", "type": "string"}}, "required": ["comment"], "type": "object"}, "DiscussionMessagePermissions": {"properties": {"delete": {"type": "boolean"}, "edit": {"type": "boolean"}}, "type": "object"}, "DiscussionPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Discussion (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "DiscussionPermissions": {"properties": {"close": {"type": "boolean"}, "delete": {"type": "boolean"}, "edit": {"type": "boolean"}}, "type": "object"}, "DiscussionResponse": {"properties": {"close": {"description": "Is this a closing response. Only subject owner can close", "type": "boolean"}, "comment": {"description": "The comment to submit", "type": "string"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "Publish in the name of this organization"}}, "required": ["comment"], "type": "object"}, "DiscussionStart": {"properties": {"comment": {"description": "The content of the initial comment", "type": "string"}, "extras": {"description": "Extras attributes as key-value pairs", "type": "object"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "Publish in the name of this organization"}, "subject": {"allOf": [{"$ref": "#/definitions/ModelReference"}], "description": "The discussion target object"}, "title": {"description": "The title of the discussion to open", "type": "string"}}, "required": ["comment", "subject", "title"], "type": "object"}, "Error": {"properties": {"message": {"type": "string"}}, "type": "object"}, "Follow (read)": {"properties": {"follower": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The follower", "readOnly": true}, "id": {"readOnly": true, "type": "string"}, "since": {"description": "The date from which the user started following", "format": "date-time", "readOnly": true, "type": "string"}}, "required": ["follower", "id", "since"], "type": "object"}, "FollowPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Follow (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "Frequency": {"properties": {"id": {"description": "The frequency identifier", "type": "string"}, "label": {"description": "The frequency display name", "type": "string"}}, "type": "object"}, "GenericReference": {"properties": {"class": {"type": "string"}, "id": {"type": "string"}}, "type": "object"}, "GeoGranularity": {"properties": {"id": {"description": "The granularity identifier", "type": "string"}, "name": {"description": "The granularity name", "type": "string"}}, "required": ["id", "name"], "type": "object"}, "GeoJSON": {"properties": {"coordinates": {"description": "The geometry as coordinates lists", "items": {"type": "object"}, "type": "array"}, "type": {"description": "The GeoJSON Type", "enum": ["Point", "LineString", "Polygon", "MultiPoint", "MultiLineString", "MultiPolygon"], "example": "Point", "type": "string"}}, "required": ["coordinates", "type"], "type": "object"}, "GeoJSONFeature": {"properties": {"geometry": {"$ref": "#/definitions/GeoJSON"}, "id": {"type": "string"}, "properties": {"type": "object"}, "type": {"enum": ["Feature"], "example": "Feature", "type": "string"}}, "required": ["geometry", "type"], "type": "object"}, "GeoJSONFeatureCollection": {"properties": {"features": {"items": {"$ref": "#/definitions/GeoJSONFeature"}, "type": "array"}, "type": {"enum": ["FeatureCollection"], "example": "FeatureCollection", "type": "string"}}, "required": ["features", "type"], "type": "object"}, "GeoLevel": {"properties": {"id": {"description": "The level identifier", "type": "string"}, "name": {"description": "The level name", "type": "string"}}, "required": ["id", "name"], "type": "object"}, "GeoZoneReference": {"allOf": [{"$ref": "#/definitions/BaseReference"}, {"properties": {"code": {"description": "The zone unique code in the level", "type": "string"}, "level": {"description": "The zone level", "type": "string"}, "name": {"description": "The zone name", "type": "string"}, "slug": {"description": "The zone slug", "type": "string"}, "uri": {"description": "The zone uri", "type": "string"}}, "required": ["code", "level", "name", "slug"], "type": "object"}]}, "GeopfDatasetMetadata": {"properties": {"datasheet_url": {"description": "Public G\u00e9oplateforme fiche (dashboard) url, once pushed", "readOnly": true, "type": "string"}}, "type": "object"}, "GeopfDatasetMetadata (read)": {"properties": {}, "type": "object"}, "GeopfDatasetPullMetadata (read)": {"properties": {"error": {"description": "The last pull error, if any", "readOnly": true, "type": "string"}, "last_synced_at": {"description": "Last successful pull date", "format": "date-time", "readOnly": true, "type": "string"}, "status": {"description": "Pull status: null (never run), pending, done or error", "enum": ["pending", "done", "error"], "example": "pending", "readOnly": true, "type": "string"}, "task_id": {"description": "The last pull Celery task's id", "readOnly": true, "type": "string"}}, "type": "object"}, "GeopfDatasetPushMetadata (read)": {"properties": {"datasheet_url": {"description": "The cartes.gouv.fr fiche de donn\u00e9es url for this dataset", "readOnly": true, "type": "string"}, "datastore_id": {"description": "The geopf datastore configured for this dataset's pushes", "readOnly": true, "type": "string"}}, "type": "object"}, "GeopfDatasetStatus": {"properties": {"offerings": {"description": "Resources that came back from a pull as geopf offerings", "items": {"$ref": "#/definitions/GeopfOfferingResource"}, "type": "array"}, "pull": {"$ref": "#/definitions/GeopfDatasetPullMetadata (read)"}, "push": {"$ref": "#/definitions/GeopfDatasetPushMetadata (read)"}, "pushable": {"description": "Resources eligible for a push", "items": {"$ref": "#/definitions/GeopfPushableResource"}, "type": "array"}}, "type": "object"}, "GeopfDatastore": {"properties": {"datastore_id": {"description": "The datastore id", "type": "string"}, "name": {"description": "The datastore display name", "type": "string"}, "rights": {"description": "The current user's rights on this datastore", "items": {"type": "string"}, "type": "array"}}, "type": "object"}, "GeopfOfferingResource": {"properties": {"format": {"description": "The resource format", "type": "string"}, "id": {"description": "The resource id", "type": "string"}, "offering": {"$ref": "#/definitions/GeopfResourceOfferingMetadata (read)"}, "title": {"description": "The resource title", "type": "string"}, "url": {"description": "The resource url", "type": "string"}}, "type": "object"}, "GeopfPushRequest": {"properties": {"datastore_id": {"description": "The datastore to push to. Optional if the dataset already has one configured from a previous push.", "type": "string"}}, "type": "object"}, "GeopfPushableResource": {"properties": {"format": {"description": "The resource format", "type": "string"}, "id": {"description": "The resource id", "type": "string"}, "push": {"$ref": "#/definitions/GeopfResourcePushMetadata (read)"}, "title": {"description": "The resource title", "type": "string"}, "url": {"description": "The resource url", "type": "string"}}, "type": "object"}, "GeopfResourceMetadata": {"properties": {"offering_id": {"description": "G\u00e9oplateforme offering id, if this resource was created from a geopf offering pull", "readOnly": true, "type": "string"}, "push_status": {"description": "Push status to G\u00e9oplateforme, if this resource has ever been pushed", "enum": ["pending", "done", "error", "timeout"], "example": "pending", "readOnly": true, "type": "string"}}, "type": "object"}, "GeopfResourceOfferingMetadata (read)": {"properties": {"id": {"description": "The geopf offering id", "readOnly": true, "type": "string"}, "last_synced_at": {"description": "Last successful pull date for this offering", "format": "date-time", "readOnly": true, "type": "string"}}, "type": "object"}, "GeopfResourcePushMetadata (read)": {"properties": {"error": {"description": "The last push error, if any", "readOnly": true, "type": "string"}, "last_synced_at": {"description": "Last successful push date", "format": "date-time", "readOnly": true, "type": "string"}, "status": {"description": "Push status: null (never run), pending, done, error or timeout", "enum": ["pending", "done", "error", "timeout"], "example": "pending", "readOnly": true, "type": "string"}, "stored_data_id": {"description": "The geopf stored_data id produced by the last push", "readOnly": true, "type": "string"}, "task_id": {"description": "The last push Celery task's id", "readOnly": true, "type": "string"}}, "type": "object"}, "GeopfStatus": {"properties": {"connected": {"description": "Whether the current user has an active, usable geopf link", "type": "boolean"}, "expires_at": {"description": "The stored geopf token's expiration date", "format": "date-time", "type": "string"}}, "type": "object"}, "GeopfTask": {"properties": {"task_id": {"description": "The id of the enqueued Celery task", "type": "string"}}, "type": "object"}, "HarvestBackend": {"properties": {"extra_configs": {"description": "The backend extra configuration variables", "items": {"$ref": "#/definitions/HarvestExtraConfig"}, "type": "array"}, "features": {"description": "The backend optional features", "items": {"$ref": "#/definitions/HarvestFeature"}, "type": "array"}, "filters": {"description": "The backend supported filters", "items": {"$ref": "#/definitions/HarvestFilter"}, "type": "array"}, "id": {"description": "The backend identifier", "type": "string"}, "label": {"description": "The backend display name", "type": "string"}}, "type": "object"}, "HarvestDataserviceMetadata (read)": {"properties": {"archived_at": {"format": "date-time", "type": "string"}, "archived_reason": {"type": "string"}, "backend": {"type": "string"}, "created_at": {"description": "Date of creation as provided by the harvested catalog", "format": "date-time", "type": "string"}, "domain": {"type": "string"}, "issued_at": {"description": "Date of release as provided by the harvested catalog", "format": "date-time", "type": "string"}, "last_update": {"description": "Date of last harvest", "format": "date-time", "type": "string"}, "modified_at": {"description": "Date of last modification as provided by the harvested catalog", "format": "date-time", "type": "string"}, "remote_id": {"type": "string"}, "remote_url": {"type": "string"}, "source_id": {"type": "string"}, "source_url": {"type": "string"}, "uri": {"description": "RDF node ID if it's an `URIRef`. `None` if it's not present or if it's a random auto-generated ID inside the graph.", "type": "string"}}, "type": "object"}, "HarvestDatasetMetadata": {"properties": {"archived_at": {"description": "The archive date", "format": "date-time", "type": "string"}, "archived_reason": {"description": "The reason the dataset has been archived", "type": "string"}, "backend": {"description": "Harvest backend used", "type": "string"}, "created_at": {"description": "The dataset harvested creation date", "format": "date-time", "readOnly": true, "type": "string"}, "dct_identifier": {"description": "The dct:identifier property from the harvested dataset", "type": "string"}, "doi": {"description": "The DOI the source declares for the dataset (dct:identifier, adms:identifier or owl:sameAs)", "readOnly": true, "type": "string"}, "domain": {"description": "The harvested domain", "type": "string"}, "issued_at": {"description": "The dataset harvested release date", "format": "date-time", "readOnly": true, "type": "string"}, "last_update": {"description": "The dataset last harvest date", "format": "date-time", "type": "string"}, "modified_at": {"description": "The dataset harvest last modification date", "format": "date-time", "readOnly": true, "type": "string"}, "remote_id": {"description": "The dataset remote id on the source portal", "type": "string"}, "remote_url": {"description": "The dataset remote url", "type": "string"}, "source_id": {"description": "The harvester id", "type": "string"}, "source_url": {"description": "The harvester source url", "type": "string"}, "uri": {"description": "The dataset harveted uri", "type": "string"}}, "type": "object"}, "HarvestDatasetMetadata (read)": {"properties": {"archived_at": {"format": "date-time", "type": "string"}, "archived_reason": {"type": "string"}, "backend": {"type": "string"}, "created_at": {"description": "Date of creation as provided by the harvested catalog", "format": "date-time", "type": "string"}, "domain": {"type": "string"}, "issued_at": {"description": "Date of release as provided by the harvested catalog", "format": "date-time", "type": "string"}, "last_update": {"description": "Date of last harvest", "format": "date-time", "type": "string"}, "modified_at": {"description": "Date of last modification as provided by the harvested catalog", "format": "date-time", "type": "string"}, "remote_id": {"type": "string"}, "remote_url": {"type": "string"}, "source_id": {"type": "string"}, "source_url": {"type": "string"}}, "type": "object"}, "HarvestError (read)": {"properties": {"created_at": {"description": "The error creation date", "format": "date-time", "readOnly": true, "type": "string"}, "details": {"description": "Optional details (only for super-admins)", "readOnly": true, "type": "string"}, "message": {"description": "The error short message", "type": "string"}}, "required": ["created_at"], "type": "object"}, "HarvestExtraConfig": {"properties": {"default": {"description": "The config default value", "type": "string"}, "description": {"description": "Some details about the behavior", "type": "string"}, "key": {"description": "The config key", "type": "string"}, "label": {"description": "A localized human-readable and descriptive label", "type": "string"}}, "type": "object"}, "HarvestFeature": {"properties": {"default": {"description": "The feature default state (true is enabled)", "type": "boolean"}, "description": {"description": "Some details about the behavior", "type": "string"}, "key": {"description": "The feature key", "type": "string"}, "label": {"description": "A localized human-readable and descriptive label", "type": "string"}}, "type": "object"}, "HarvestFilter": {"properties": {"description": {"description": "The filter details", "type": "string"}, "key": {"description": "The filter key", "type": "string"}, "label": {"description": "A localized human-readable label", "type": "string"}, "type": {"description": "The filter expected type", "type": "string"}}, "type": "object"}, "HarvestItem (read)": {"properties": {"args": {"description": "The item positional arguments", "items": {"description": "The item positional arguments", "type": "string"}, "type": "array"}, "created": {"description": "The item creation date", "format": "date-time", "readOnly": true, "type": "string"}, "dataservice": {"allOf": [{"$ref": "#/definitions/DataserviceReference"}], "description": "The processed dataservice"}, "dataset": {"allOf": [{"$ref": "#/definitions/DatasetReference"}], "description": "The processed dataset"}, "ended": {"description": "The item end date", "format": "date-time", "type": "string"}, "errors": {"description": "The item errors", "items": {"allOf": [{"$ref": "#/definitions/HarvestError (read)"}], "description": "The item errors"}, "type": "array"}, "kwargs": {"description": "The item keyword arguments", "type": "object"}, "logs": {"description": "The item logs", "items": {"allOf": [{"$ref": "#/definitions/HarvestLog (read)"}], "description": "The item logs"}, "type": "array"}, "remote_id": {"description": "The item remote ID to process", "type": "string"}, "remote_url": {"description": "The item remote url (if available)", "type": "string"}, "started": {"description": "The item start date", "format": "date-time", "type": "string"}, "status": {"description": "The item status", "enum": ["pending", "started", "done", "failed", "skipped", "archived"], "example": "pending", "type": "string"}}, "required": ["created", "status"], "type": "object"}, "HarvestItemPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/HarvestItem (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "HarvestItemPreview": {"properties": {"args": {"description": "The item positional arguments", "items": {"description": "The item positional arguments", "type": "string"}, "type": "array"}, "created": {"description": "The item creation date", "format": "date-time", "readOnly": true, "type": "string"}, "dataservice": {"allOf": [{"$ref": "#/definitions/DataservicePreview"}], "description": "The processed dataservice"}, "dataset": {"allOf": [{"$ref": "#/definitions/DatasetPreview"}], "description": "The processed dataset"}, "ended": {"description": "The item end date", "format": "date-time", "type": "string"}, "errors": {"description": "The item errors", "items": {"allOf": [{"$ref": "#/definitions/HarvestError (read)"}], "description": "The item errors"}, "type": "array"}, "kwargs": {"description": "The item keyword arguments", "type": "object"}, "logs": {"description": "The item logs", "items": {"allOf": [{"$ref": "#/definitions/HarvestLog (read)"}], "description": "The item logs"}, "type": "array"}, "remote_id": {"description": "The item remote ID to process", "type": "string"}, "remote_url": {"description": "The item remote url (if available)", "type": "string"}, "started": {"description": "The item start date", "format": "date-time", "type": "string"}, "status": {"description": "The item status", "enum": ["pending", "started", "done", "failed", "skipped", "archived"], "example": "pending", "type": "string"}}, "required": ["created", "status"], "type": "object"}, "HarvestJob (read)": {"properties": {"created": {"description": "The job creation date", "format": "date-time", "readOnly": true, "type": "string"}, "ended": {"description": "The job end date", "format": "date-time", "readOnly": true, "type": "string"}, "errors": {"description": "The job initialization errors", "items": {"allOf": [{"$ref": "#/definitions/HarvestError (read)"}], "description": "The job initialization errors", "readOnly": true}, "readOnly": true, "type": "array"}, "id": {"readOnly": true, "type": "string"}, "items": {"description": "Visit this API link to see the list.", "readOnly": true, "type": "object"}, "source": {"allOf": [{"$ref": "#/definitions/HarvestSourceReference"}], "description": "The source owning the job", "readOnly": true}, "started": {"description": "The job start date", "format": "date-time", "readOnly": true, "type": "string"}, "status": {"description": "The job status", "enum": ["pending", "initializing", "initialized", "processing", "done", "done-errors", "failed"], "example": "pending", "readOnly": true, "type": "string"}}, "required": ["created", "id", "status"], "type": "object"}, "HarvestJobPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/HarvestJob (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "HarvestJobPreview": {"properties": {"created": {"description": "The job creation date", "format": "date-time", "readOnly": true, "type": "string"}, "ended": {"description": "The job end date", "format": "date-time", "readOnly": true, "type": "string"}, "errors": {"description": "The job initialization errors", "items": {"allOf": [{"$ref": "#/definitions/HarvestError (read)"}], "description": "The job initialization errors", "readOnly": true}, "readOnly": true, "type": "array"}, "id": {"readOnly": true, "type": "string"}, "items": {"description": "The job collected items", "items": {"$ref": "#/definitions/HarvestItemPreview"}, "type": "array"}, "source": {"allOf": [{"$ref": "#/definitions/HarvestSourceReference"}], "description": "The source owning the job", "readOnly": true}, "started": {"description": "The job start date", "format": "date-time", "readOnly": true, "type": "string"}, "status": {"description": "The job status", "enum": ["pending", "initializing", "initialized", "processing", "done", "done-errors", "failed"], "example": "pending", "readOnly": true, "type": "string"}}, "required": ["created", "id", "status"], "type": "object"}, "HarvestLog (read)": {"properties": {"level": {"type": "string"}, "message": {"type": "string"}}, "required": ["level", "message"], "type": "object"}, "HarvestResourceMetadata": {"properties": {"issued_at": {"description": "The resource harvested release date", "format": "date-time", "readOnly": true, "type": "string"}, "last_update": {"description": "The resource last harvest date", "format": "date-time", "readOnly": true, "type": "string"}, "modified_at": {"description": "The resource harvest last modification date", "format": "date-time", "readOnly": true, "type": "string"}, "uri": {"description": "The resource harvest uri", "type": "string"}}, "type": "object"}, "HarvestSource (read)": {"properties": {"active": {"description": "Is this source active", "type": "boolean"}, "autoarchive": {"description": "If enabled, datasets not present on the remote source will be automatically archived", "type": "boolean"}, "backend": {"description": "The source backend", "type": "string"}, "config": {"description": "The configuration as key-value pairs", "type": "object"}, "created_at": {"description": "The source creation date", "format": "date-time", "readOnly": true, "type": "string"}, "deleted": {"description": "The source deletion date", "format": "date-time", "readOnly": true, "type": "string"}, "description": {"description": "The source description", "format": "markdown", "type": "string"}, "id": {"readOnly": true, "type": "string"}, "last_job": {"allOf": [{"$ref": "#/definitions/HarvestJob (read)"}], "description": "The last job for this source", "readOnly": true}, "name": {"description": "The source display name", "maxLength": 255, "type": "string"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user."}, "owner": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "Only present if organization is not set. Can only be set to the current authenticated user."}, "permissions": {"allOf": [{"$ref": "#/definitions/HarvestSourcePermissions"}], "readOnly": true}, "schedule": {"description": "The source schedule (interval or cron expression)", "readOnly": true, "type": "string"}, "slug": {"description": "The source permalink string", "maxLength": 255, "readOnly": true, "type": "string"}, "url": {"description": "The source base URL", "type": "string"}, "validation": {"allOf": [{"$ref": "#/definitions/HarvestSourceValidation (read)"}], "description": "Has the source been validated", "readOnly": true}}, "required": ["backend", "created_at", "id", "name", "slug", "url"], "type": "object"}, "HarvestSource (write)": {"properties": {"active": {"description": "Is this source active", "type": "boolean"}, "autoarchive": {"description": "If enabled, datasets not present on the remote source will be automatically archived", "type": "boolean"}, "backend": {"description": "The source backend", "type": "string"}, "config": {"description": "The configuration as key-value pairs", "type": "object"}, "description": {"description": "The source description", "format": "markdown", "type": "string"}, "name": {"description": "The source display name", "maxLength": 255, "type": "string"}, "organization": {"description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user.", "type": "string"}, "owner": {"description": "Only present if organization is not set. Can only be set to the current authenticated user.", "type": "string"}, "url": {"description": "The source base URL", "type": "string"}}, "required": ["backend", "name", "url"], "type": "object"}, "HarvestSourcePage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/HarvestSource (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "HarvestSourcePermissions": {"properties": {"delete": {"type": "boolean"}, "edit": {"type": "boolean"}, "preview": {"type": "boolean"}, "run": {"type": "boolean"}, "schedule": {"type": "boolean"}, "validate": {"type": "boolean"}}, "type": "object"}, "HarvestSourceReference": {"allOf": [{"$ref": "#/definitions/BaseReference"}, {"properties": {}, "type": "object"}]}, "HarvestSourceValidation (read)": {"properties": {"by": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "Who performed the validation", "readOnly": true}, "comment": {"description": "A comment about the validation. Required on rejection", "type": "string"}, "on": {"description": "Date on which validation was performed", "format": "date-time", "readOnly": true, "type": "string"}, "state": {"description": "Is it validated or not", "enum": ["pending", "accepted", "refused"], "example": "pending", "type": "string"}}, "required": ["state"], "type": "object"}, "HarvestSourceValidation (write)": {"properties": {"comment": {"description": "A comment about the validation. Required on rejection", "type": "string"}, "state": {"description": "Is it validated or not", "enum": ["pending", "accepted", "refused"], "example": "pending", "type": "string"}}, "required": ["state"], "type": "object"}, "Interval (read)": {"properties": {"every": {"minimum": 0, "type": "integer"}, "period": {"enum": ["days", "hours", "minutes", "seconds", "microseconds"], "example": "days", "type": "string"}}, "required": ["every", "period"], "type": "object"}, "Interval (write)": {"properties": {"every": {"minimum": 0, "type": "integer"}, "period": {"enum": ["days", "hours", "minutes", "seconds", "microseconds"], "example": "days", "type": "string"}}, "required": ["every", "period"], "type": "object"}, "LazyReference": {"properties": {"class": {"type": "object"}, "id": {"type": "object"}}, "type": "object"}, "License": {"properties": {"alternate_titles": {"description": "Same alternative known titles (improve rematch)", "items": {"type": "string"}, "type": "array"}, "alternate_urls": {"description": "Same alternative known URLs (improve rematch)", "items": {"type": "string"}, "type": "array"}, "flags": {"description": "Some arbitry flags", "items": {"type": "string"}, "type": "array"}, "id": {"description": "The license identifier", "type": "string"}, "maintainer": {"description": "The license official maintainer", "type": "string"}, "title": {"description": "The resource title", "type": "string"}, "url": {"description": "The license official URL", "type": "string"}}, "required": ["id", "title"], "type": "object"}, "Member (read)": {"properties": {"label": {"readOnly": true, "type": "string"}, "role": {"enum": ["admin", "editor", "partial_editor"], "example": "admin", "type": "string"}, "since": {"format": "date-time", "readOnly": true, "type": "string"}, "user": {"allOf": [{"$ref": "#/definitions/UserReferenceWithEmail"}], "readOnly": true}}, "required": ["since"], "type": "object"}, "Member (write)": {"properties": {"role": {"enum": ["admin", "editor", "partial_editor"], "example": "admin", "type": "string"}}, "type": "object"}, "MembershipInvite": {"properties": {"assignments": {"description": "Objects to assign on acceptance (for partial_editor invitations)", "items": {"$ref": "#/definitions/GenericReference"}, "type": "array"}, "comment": {"description": "Invitation message", "type": "string"}, "email": {"description": "Email to invite (if user not registered)", "type": "string"}, "role": {"default": "editor", "description": "The role to assign", "enum": ["admin", "editor", "partial_editor"], "example": "admin", "type": "string"}, "user": {"description": "User ID to invite", "type": "string"}}, "type": "object"}, "MembershipRequest": {"properties": {"assignments": {"description": "Objects to assign on acceptance (for partial_editor invitations)", "items": {"$ref": "#/definitions/GenericReference"}, "type": "array"}, "comment": {"description": "A request comment from the user", "type": "string"}, "created": {"description": "The request creation date", "format": "date-time", "readOnly": true, "type": "string"}, "email": {"description": "Email for non-registered user invitations", "type": "string"}, "id": {"readOnly": true, "type": "string"}, "kind": {"default": "request", "description": "The request kind (request or invitation)", "enum": ["request", "invitation"], "example": "request", "type": "string"}, "role": {"default": "editor", "description": "The role to assign", "enum": ["admin", "editor", "partial_editor"], "example": "admin", "type": "string"}, "status": {"description": "The current request status", "enum": ["pending", "accepted", "refused", "canceled"], "example": "pending", "type": "string"}, "user": {"$ref": "#/definitions/UserReferenceWithEmail"}}, "required": ["status"], "type": "object"}, "MembershipRequest (write)": {"properties": {"comment": {"type": "string"}}, "type": "object"}, "Message (read)": {"properties": {"content": {"description": "The message body", "maxLength": 50000, "type": "string"}, "id": {"description": "The message identifier", "readOnly": true, "type": "string"}, "last_modified_at": {"description": "The message last edit date", "format": "date-time", "readOnly": true, "type": "string"}, "permissions": {"allOf": [{"$ref": "#/definitions/DiscussionMessagePermissions"}], "readOnly": true}, "posted_by": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The message author", "readOnly": true}, "posted_by_organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "The organization to show to users", "readOnly": true}, "posted_on": {"description": "The message posting date", "format": "date-time", "readOnly": true, "type": "string"}}, "required": ["content", "posted_on"], "type": "object"}, "ModelReference": {"properties": {"class": {"description": "The model class", "type": "string"}, "id": {"description": "The object identifier", "type": "string"}}, "required": ["class", "id"], "type": "object"}, "MyMetrics": {"properties": {"datasets_count": {"description": "The user's datasets number", "readOnly": true, "type": "integer"}, "datasets_org_count": {"description": "The user's orgs datasets number", "readOnly": true, "type": "integer"}, "followers_count": {"description": "The user's followers number", "readOnly": true, "type": "integer"}, "followers_org_count": {"description": "The user's orgs followers number", "readOnly": true, "type": "integer"}, "id": {"description": "The user identifier", "type": "string"}, "resources_availability": {"description": "The user's resources availability percentage", "readOnly": true, "type": "number"}}, "required": ["id"], "type": "object"}, "Notification (read)": {"properties": {"created_at": {"format": "date-time", "readOnly": true, "type": "string"}, "details": {"type": "object"}, "handled_at": {"format": "date-time", "type": "string"}, "id": {"type": "string"}, "last_modified": {"format": "date-time", "readOnly": true, "type": "string"}, "reasons": {"items": {"enum": ["owner", "organization.admin", "organization.editor", "organization.partial_editor", "discussion.participant", "explicit_subscriber", "contributor", "discussant", "requester"], "example": "owner", "readOnly": true, "type": "string"}, "readOnly": true, "type": "array"}, "requires_action": {"description": "Whether the notification is resolved by acting on its subject rather than by reading it", "readOnly": true, "type": "boolean"}, "type": {"enum": ["discussion.new", "discussion.comment", "discussion.closed", "organization.membership.requested", "organization.membership.invited", "organization.membership.accepted", "organization.membership.refused", "organization.badge.certified", "organization.badge.public-service", "organization.badge.company", "organization.badge.association", "organization.badge.local-authority", "reuse.created", "dataservice.created", "transfer.requested", "harvest.source.pending", "harvest.source.accepted", "harvest.source.refused"], "example": "discussion.new", "readOnly": true, "type": "string"}, "user": {"allOf": [{"$ref": "#/definitions/UserReference"}], "readOnly": true}}, "required": ["created_at", "id", "last_modified", "type"], "type": "object"}, "NotificationFollow": {"properties": {"event": {"description": "A notification type or a prefix of some, every notification without one", "type": "string"}, "followed": {"description": "Follow, or stop following", "type": "boolean"}, "scope": {"allOf": [{"$ref": "#/definitions/ModelReference"}], "description": "The subject"}}, "required": ["followed", "scope"], "type": "object"}, "NotificationPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Notification (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "NotificationResolved": {"properties": {"event": {"description": "The event asked about", "type": "string"}, "followed_events": {"description": "The narrower events the user still follows on it", "items": {"type": "string"}, "type": "array"}, "heard": {"description": "Whether the user hears about it, pause aside", "type": "boolean"}, "heard_types": {"description": "The types asked about the user hears on it", "items": {"type": "string"}, "type": "array"}, "muted": {"description": "Whether the user said no to this subject and event", "type": "boolean"}, "partial": {"description": "Whether the user hears only some of the types that can be about it", "type": "boolean"}, "reasons": {"description": "Why the user is concerned", "items": {"type": "string"}, "type": "array"}, "scope": {"allOf": [{"$ref": "#/definitions/ModelReference"}], "description": "The subject asked about"}, "subject": {"allOf": [{"$ref": "#/definitions/NotificationSubjectSummary"}], "description": "The subject as the user may see it, null when out of reach"}}, "type": "object"}, "NotificationSetting (read)": {"properties": {"enabled": {"type": "boolean"}, "event": {"description": "A notification type, or a dotted prefix of some (`discussion` covers `discussion.*`), null for every notification", "type": "string"}, "id": {"readOnly": true, "type": "string"}, "origin": {"description": "What made the user follow the subject: by hand, by editing it, or by taking part in its discussions", "enum": ["followed", "edited", "discussed"], "example": "followed", "readOnly": true, "type": "string"}, "scope": {"allOf": [{"$ref": "#/definitions/ModelReference"}], "description": "The subject the rule is about, null for everywhere"}, "subject": {"allOf": [{"$ref": "#/definitions/NotificationSubjectSummary"}], "description": "The subject as the user may see it today, null once out of reach", "readOnly": true}}, "required": ["enabled", "id"], "type": "object"}, "NotificationSetting (write)": {"properties": {"enabled": {"type": "boolean"}, "event": {"description": "A notification type, or a dotted prefix of some (`discussion` covers `discussion.*`), null for every notification", "type": "string"}, "scope": {"allOf": [{"$ref": "#/definitions/LazyReference"}], "description": "The subject the rule is about, null for everywhere"}}, "required": ["enabled"], "type": "object"}, "NotificationSettingPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/NotificationSetting (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "NotificationSubjectSummary": {"properties": {"organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "The organization the subject belongs to, null for an organization"}, "page": {"description": "The subject web page", "type": "string"}, "title": {"description": "The subject title", "type": "string"}}, "type": "object"}, "Organization (read)": {"properties": {"acronym": {"maxLength": 128, "type": "string"}, "badges": {"items": {"allOf": [{"$ref": "#/definitions/Badge (read)"}], "readOnly": true}, "readOnly": true, "type": "array"}, "banner_color": {"description": "Hex color code (e.g. #000091) for the organization page banner", "type": "string"}, "banner_image": {"description": "The organization page banner image URL", "readOnly": true, "type": "string"}, "banner_image_position": {"description": "Vertical position of the banner image, as a percentage matching CSS background-position-y (0 = top, 50 = centered, 100 = bottom)", "maximum": 100, "minimum": 0, "type": "integer"}, "business_number_id": {"maxLength": 14, "type": "string"}, "created_at": {"format": "date-time", "readOnly": true, "type": "string"}, "deleted": {"format": "date-time", "type": "string"}, "description": {"format": "markdown", "type": "string"}, "ext": {"readOnly": true, "type": "object"}, "extras": {"type": "object"}, "id": {"readOnly": true, "type": "string"}, "image_url": {"type": "string"}, "last_modified": {"format": "date-time", "readOnly": true, "type": "string"}, "logo": {"description": "URL of the image", "readOnly": true, "type": "string"}, "logo_thumbnail": {"description": "URL of the cropped and squared image (100x100)", "readOnly": true, "type": "string"}, "members": {"items": {"allOf": [{"$ref": "#/definitions/Member (read)"}], "readOnly": true}, "readOnly": true, "type": "array"}, "metrics": {"readOnly": true, "type": "object"}, "name": {"type": "string"}, "page": {"description": "Link to the udata web page for this organization", "readOnly": true, "type": "string"}, "permissions": {"allOf": [{"$ref": "#/definitions/OrganizationPermissions"}], "readOnly": true}, "presentation_blocs": {"items": {"type": "object"}, "type": "array"}, "presentation_blocs_published_at": {"description": "Publication date of the organization presentation blocs. Set it to make the blocs publicly visible; leave it empty to keep them hidden (draft). Organization administrators always see the blocs regardless of this date.", "format": "date-time", "type": "string"}, "slug": {"maxLength": 255, "readOnly": true, "type": "string"}, "teams": {"items": {"allOf": [{"$ref": "#/definitions/Team (read)"}], "readOnly": true}, "readOnly": true, "type": "array"}, "uri": {"description": "Link to the API endpoint for this organization", "readOnly": true, "type": "string"}, "url": {"type": "string"}, "zone": {"readOnly": true, "type": "string"}}, "required": ["created_at", "description", "id", "last_modified", "name", "slug"], "type": "object", "x-mask": "{id,created_at,last_modified,badges,metrics,name,acronym,slug,description,url,image_url,logo,logo_thumbnail,banner_color,banner_image,banner_image_position,business_number_id,members,teams,ext,zone,extras,presentation_blocs_published_at,deleted,page,permissions,uri}"}, "Organization (write)": {"properties": {"acronym": {"maxLength": 128, "type": "string"}, "banner_color": {"description": "Hex color code (e.g. #000091) for the organization page banner", "type": "string"}, "banner_image_position": {"description": "Vertical position of the banner image, as a percentage matching CSS background-position-y (0 = top, 50 = centered, 100 = bottom)", "maximum": 100, "minimum": 0, "type": "integer"}, "business_number_id": {"maxLength": 14, "type": "string"}, "deleted": {"format": "date-time", "type": "string"}, "description": {"format": "markdown", "type": "string"}, "extras": {"type": "object"}, "image_url": {"type": "string"}, "name": {"type": "string"}, "presentation_blocs": {"items": {"type": "object"}, "type": "array"}, "presentation_blocs_published_at": {"description": "Publication date of the organization presentation blocs. Set it to make the blocs publicly visible; leave it empty to keep them hidden (draft). Organization administrators always see the blocs regardless of this date.", "format": "date-time", "type": "string"}, "url": {"type": "string"}}, "required": ["description", "name"], "type": "object"}, "OrganizationPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Organization (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "OrganizationPermissions": {"properties": {"delete": {"type": "boolean"}, "edit": {"type": "boolean"}, "harvest": {"type": "boolean"}, "members": {"type": "boolean"}, "private": {"type": "boolean"}}, "type": "object"}, "OrganizationReference": {"allOf": [{"$ref": "#/definitions/BaseReference"}, {"properties": {"acronym": {"maxLength": 128, "type": "string"}, "badges": {"items": {"allOf": [{"$ref": "#/definitions/Badge (read)"}], "readOnly": true}, "readOnly": true, "type": "array"}, "logo": {"description": "URL of the image", "readOnly": true, "type": "string"}, "logo_thumbnail": {"description": "URL of the cropped and squared image (100x100)", "readOnly": true, "type": "string"}, "name": {"type": "string"}, "page": {"description": "Link to the udata web page for this organization", "readOnly": true, "type": "string"}, "permissions": {"allOf": [{"$ref": "#/definitions/OrganizationPermissions"}], "readOnly": true}, "slug": {"maxLength": 255, "readOnly": true, "type": "string"}, "uri": {"description": "Link to the API endpoint for this organization", "readOnly": true, "type": "string"}}, "required": ["name", "slug"], "type": "object"}]}, "OrganizationRole": {"properties": {"description": {"description": "What the role allows, for display in the UI", "type": "string"}, "id": {"description": "The role identifier", "type": "string"}, "label": {"description": "The role label", "type": "string"}}, "type": "object"}, "OrganizationSuggestion": {"properties": {"acronym": {"description": "The organization acronym", "readOnly": true, "type": "string"}, "id": {"description": "The organization identifier", "readOnly": true, "type": "string"}, "image_url": {"description": "The organization logo URL", "readOnly": true, "type": "string"}, "name": {"description": "The organization name", "readOnly": true, "type": "string"}, "page": {"description": "The organization web page URL", "readOnly": true, "type": "string"}, "slug": {"description": "The organization permalink string", "readOnly": true, "type": "string"}}, "type": "object"}, "PendingInvitation": {"properties": {"assignments": {"description": "Objects to assign on acceptance (for partial_editor invitations)", "items": {"$ref": "#/definitions/GenericReference"}, "type": "array"}, "comment": {"description": "Invitation message", "type": "string"}, "created": {"description": "The invitation creation date", "format": "date-time", "readOnly": true, "type": "string"}, "id": {"readOnly": true, "type": "string"}, "organization": {"$ref": "#/definitions/OrganizationReference"}, "role": {"default": "editor", "description": "The role to assign", "enum": ["admin", "editor", "partial_editor"], "example": "admin", "type": "string"}}, "type": "object"}, "PeriodicTask (read)": {"properties": {"args": {"description": "The job execution arguments", "items": {"type": "object"}, "type": "array"}, "crontab": {"$ref": "#/definitions/Crontab (read)"}, "description": {"description": "The job description", "type": "string"}, "enabled": {"description": "Is this job enabled", "type": "boolean"}, "id": {"readOnly": true, "type": "string"}, "interval": {"$ref": "#/definitions/Interval (read)"}, "kwargs": {"description": "The job execution keyword arguments", "type": "object"}, "last_run_at": {"description": "The last job execution date", "format": "date-time", "readOnly": true, "type": "string"}, "name": {"description": "The job unique name", "type": "string"}, "schedule": {"description": "The schedule display", "readOnly": true, "type": "string"}, "task": {"description": "The task name", "enum": ["test-high-queue", "test-default-queue", "update-badges", "purge-datasets", "purge-dataservices", "recommendations-clean", "compute-site-metrics", "recommendations-add", "test-log", "purge-reuses", "purge-visualizations", "purge-organizations", "test-low-queue", "compute-geozones-metrics", "count-tags", "check-integrity", "export-csv", "harvest", "test-error", "purge-topics-elements", "send-notification-digests", "notify-inactive-users", "purge-chunks", "bind-tabular-dataservice", "generate-sitemaps", "purge-harvesters", "delete-expired-notifications", "delete-inactive-users", "purge-harvest-jobs", "map-transport-datasets", "update-metrics"], "example": "test-high-queue", "type": "string"}}, "required": ["id", "name", "task"], "type": "object"}, "PeriodicTask (write)": {"properties": {"args": {"description": "The job execution arguments", "items": {"type": "object"}, "type": "array"}, "crontab": {"$ref": "#/definitions/Crontab (write)"}, "description": {"description": "The job description", "type": "string"}, "enabled": {"description": "Is this job enabled", "type": "boolean"}, "interval": {"$ref": "#/definitions/Interval (write)"}, "kwargs": {"description": "The job execution keyword arguments", "type": "object"}, "name": {"description": "The job unique name", "type": "string"}, "task": {"description": "The task name", "enum": ["test-high-queue", "test-default-queue", "update-badges", "purge-datasets", "purge-dataservices", "recommendations-clean", "compute-site-metrics", "recommendations-add", "test-log", "purge-reuses", "purge-visualizations", "purge-organizations", "test-low-queue", "compute-geozones-metrics", "count-tags", "check-integrity", "export-csv", "harvest", "test-error", "purge-topics-elements", "send-notification-digests", "notify-inactive-users", "purge-chunks", "bind-tabular-dataservice", "generate-sitemaps", "purge-harvesters", "delete-expired-notifications", "delete-inactive-users", "purge-harvest-jobs", "map-transport-datasets", "update-metrics"], "example": "test-high-queue", "type": "string"}}, "required": ["name", "task"], "type": "object"}, "Post (read)": {"properties": {"ancestors": {"description": "The ancestor pages, from the root page to the parent", "items": {"$ref": "#/definitions/PostAncestor"}, "readOnly": true, "type": "array"}, "blocs": {"items": {"type": "object"}, "type": "array"}, "body_type": {"enum": ["markdown", "html", "blocs"], "example": "markdown", "type": "string"}, "content": {"format": "markdown", "type": "string"}, "created_at": {"format": "date-time", "readOnly": true, "type": "string"}, "credit_to": {"description": "An optional credit line (associated to the image)", "type": "string"}, "credit_url": {"description": "An optional link associated to the credits", "type": "string"}, "datasets": {"description": "The post datasets", "items": {"allOf": [{"$ref": "#/definitions/Dataset"}], "description": "The post datasets"}, "type": "array"}, "headline": {"type": "string"}, "id": {"readOnly": true, "type": "string"}, "image": {"description": "URL of the image", "readOnly": true, "type": "string"}, "image_thumbnail": {"description": "URL of the cropped and squared image (100x100)", "readOnly": true, "type": "string"}, "image_url": {"type": "string"}, "kind": {"description": "Post kind (news or page)", "enum": ["news", "page"], "example": "news", "type": "string"}, "last_modified": {"format": "date-time", "readOnly": true, "type": "string"}, "name": {"maxLength": 255, "type": "string"}, "owner": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The owner user", "readOnly": true}, "page": {"description": "The post web page URL", "readOnly": true, "type": "string"}, "parent": {"allOf": [{"$ref": "#/definitions/PostAncestor"}], "description": "The parent page, only for pages"}, "published": {"description": "The post publication date", "format": "date-time", "readOnly": true, "type": "string"}, "reuses": {"description": "The post reuses", "items": {"allOf": [{"$ref": "#/definitions/ReuseReference"}], "description": "The post reuses"}, "type": "array"}, "slug": {"maxLength": 255, "type": "string"}, "tags": {"description": "Some keywords to help in search", "items": {"description": "Some keywords to help in search", "type": "string"}, "type": "array"}, "uri": {"description": "The API URI for this post", "readOnly": true, "type": "string"}}, "required": ["created_at", "id", "last_modified", "name", "slug"], "type": "object"}, "Post (write)": {"properties": {"blocs": {"items": {"type": "object"}, "type": "array"}, "body_type": {"enum": ["markdown", "html", "blocs"], "example": "markdown", "type": "string"}, "content": {"format": "markdown", "type": "string"}, "credit_to": {"description": "An optional credit line (associated to the image)", "type": "string"}, "credit_url": {"description": "An optional link associated to the credits", "type": "string"}, "datasets": {"description": "The post datasets", "items": {"description": "The post datasets", "type": "string"}, "type": "array"}, "headline": {"type": "string"}, "image_url": {"type": "string"}, "kind": {"description": "Post kind (news or page)", "enum": ["news", "page"], "example": "news", "type": "string"}, "name": {"maxLength": 255, "type": "string"}, "parent": {"description": "The parent page, only for pages", "type": "string"}, "reuses": {"description": "The post reuses", "items": {"description": "The post reuses", "type": "string"}, "type": "array"}, "slug": {"maxLength": 255, "type": "string"}, "tags": {"description": "Some keywords to help in search", "items": {"description": "Some keywords to help in search", "type": "string"}, "type": "array"}}, "required": ["name", "slug"], "type": "object"}, "PostAncestor": {"properties": {"id": {"description": "The post identifier", "readOnly": true, "type": "string"}, "name": {"description": "The post name", "readOnly": true, "type": "string"}, "page": {"description": "The post web page URL", "readOnly": true, "type": "string"}}, "type": "object"}, "PostPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Post (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object", "x-mask": "{data{id,created_at,last_modified,name,slug,headline,content,image_url,image,image_thumbnail,credit_to,credit_url,tags,datasets,reuses,owner,published,body_type,kind,parent,ancestors,page,uri},*}"}, "RefuseMembership": {"properties": {"comment": {"description": "The refusal comment.", "type": "string"}}, "type": "object"}, "Report (read)": {"properties": {"by": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "Only set if a user was connected when reporting an element.", "readOnly": true}, "callbacks_count": {"description": "Number of pending callbacks to execute when dismissed", "readOnly": true, "type": "integer"}, "dismissed_at": {"format": "date-time", "type": "string"}, "dismissed_by": {"$ref": "#/definitions/UserReference"}, "id": {"readOnly": true, "type": "string"}, "message": {"type": "string"}, "reason": {"enum": ["auto_spam", "explicit_content", "illegal_content", "others", "personal_data", "security", "spam"], "example": "auto_spam", "type": "string"}, "reported_at": {"format": "date-time", "readOnly": true, "type": "string"}, "self_api_url": {"description": "Link to the API endpoint for this report", "readOnly": true, "type": "string"}, "subject": {"$ref": "#/definitions/LazyReference"}, "subject_deleted_at": {"format": "date-time", "readOnly": true, "type": "string"}, "subject_deleted_by": {"allOf": [{"$ref": "#/definitions/UserReference"}], "readOnly": true}, "subject_embed_id": {"description": "UUID of the embedded document within the subject (e.g., a Message within a Discussion)", "type": "string"}, "subject_label": {"description": "Title or slug of the subject, saved at report creation for future reference.", "readOnly": true, "type": "string"}}, "required": ["id", "reason", "reported_at", "subject"], "type": "object"}, "Report (write)": {"properties": {"dismissed_at": {"format": "date-time", "type": "string"}, "dismissed_by": {"description": "ID of the reference", "type": "string"}, "message": {"type": "string"}, "reason": {"enum": ["auto_spam", "explicit_content", "illegal_content", "others", "personal_data", "security", "spam"], "example": "auto_spam", "type": "string"}, "subject": {"$ref": "#/definitions/LazyReference"}, "subject_embed_id": {"description": "UUID of the embedded document within the subject (e.g., a Message within a Discussion)", "type": "string"}}, "required": ["reason", "subject"], "type": "object"}, "ReportPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Report (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "Resource": {"properties": {"checksum": {"allOf": [{"$ref": "#/definitions/Checksum"}], "description": "A checksum to validate file validity"}, "created_at": {"description": "The resource creation date", "format": "date-time", "readOnly": true, "type": "string"}, "description": {"description": "The resource markdown description", "format": "markdown", "type": "string"}, "extras": {"description": "Extra attributes as key-value pairs", "type": "object"}, "filesize": {"description": "The resource file size in bytes", "type": "integer"}, "filetype": {"description": "Whether the resource is an uploaded file, a remote file or an API", "enum": ["file", "remote"], "example": "file", "type": "string"}, "format": {"description": "The resource format", "type": "string"}, "geopf": {"allOf": [{"$ref": "#/definitions/GeopfResourceMetadata"}], "description": "G\u00e9oplateforme sync status metadata", "readOnly": true}, "harvest": {"allOf": [{"$ref": "#/definitions/HarvestResourceMetadata"}], "description": "Harvest attributes metadata information", "readOnly": true}, "id": {"description": "The resource unique ID", "readOnly": true, "type": "string"}, "internal": {"allOf": [{"$ref": "#/definitions/ResourceInternals"}], "description": "Site internal and specific object's data", "readOnly": true}, "last_modified": {"description": "The resource last modification date", "format": "date-time", "readOnly": true, "type": "string"}, "latest": {"description": "The permanent URL redirecting to the latest version of the resource. When the resource data is updated, the URL will change, the latest URL won't.", "readOnly": true, "type": "string"}, "metrics": {"description": "The resource metrics", "readOnly": true, "type": "object"}, "mime": {"description": "The resource mime type", "type": "string"}, "preview_url": {"description": "An optional preview URL to be loaded as a standalone page (ie. iframe or new page)", "readOnly": true, "type": "string"}, "schema": {"allOf": [{"$ref": "#/definitions/Schema"}], "description": "Reference to the associated schema"}, "title": {"description": "The resource title", "type": "string"}, "type": {"description": "Resource type (documentation, API...)", "enum": ["main", "documentation", "update", "api", "code", "other"], "example": "main", "type": "string"}, "url": {"description": "The resource URL", "type": "string"}}, "required": ["filetype", "format", "title", "type", "url"], "type": "object"}, "Resource (read)": {"properties": {"metrics": {"readOnly": true, "type": "object"}}, "type": "object"}, "ResourceInternals": {"properties": {"created_at_internal": {"description": "The resource's internal creation date on the site", "format": "date-time", "type": "string"}, "last_modified_internal": {"description": "The resource's internal last modification date", "format": "date-time", "type": "string"}}, "required": ["created_at_internal", "last_modified_internal"], "type": "object"}, "ResourceType": {"properties": {"id": {"description": "The resource type identifier", "type": "string"}, "label": {"description": "The resource type display name", "type": "string"}}, "type": "object"}, "Reuse (read)": {"properties": {"archived": {"format": "date-time", "type": "string"}, "badges": {"items": {"allOf": [{"$ref": "#/definitions/Badge (read)"}], "readOnly": true}, "readOnly": true, "type": "array"}, "created_at": {"format": "date-time", "readOnly": true, "type": "string"}, "dataservices": {"items": {"$ref": "#/definitions/DataserviceReference"}, "type": "array"}, "datasets": {"items": {"$ref": "#/definitions/Dataset"}, "type": "array"}, "deleted": {"format": "date-time", "type": "string"}, "description": {"format": "markdown", "type": "string"}, "extras": {"type": "object"}, "featured": {"readOnly": true, "type": "boolean"}, "id": {"readOnly": true, "type": "string"}, "image": {"description": "URL of the image", "readOnly": true, "type": "string"}, "image_thumbnail": {"description": "URL of the cropped and squared image (500x500)", "readOnly": true, "type": "string"}, "last_modified": {"format": "date-time", "readOnly": true, "type": "string"}, "metrics": {"readOnly": true, "type": "object"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user."}, "owner": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "Only present if organization is not set. Can only be set to the current authenticated user."}, "page": {"description": "Link to the udata web page for this reuse", "readOnly": true, "type": "string"}, "permissions": {"allOf": [{"$ref": "#/definitions/ReusePermissions"}], "readOnly": true}, "private": {"type": "boolean"}, "slug": {"maxLength": 255, "readOnly": true, "type": "string"}, "tags": {"items": {"type": "string"}, "type": "array"}, "title": {"type": "string"}, "topic": {"enum": ["health", "transport_and_mobility", "housing_and_development", "food_and_agriculture", "culture_and_recreation", "economy_and_business", "environment_and_energy", "work_and_training", "politics_and_public_life", "safety_and_security", "education_and_research", "society_and_demography", "law_and_justice", "open_data_tools", "others"], "example": "health", "type": "string"}, "type": {"enum": ["api", "application", "idea", "news_article", "paper", "post", "visualization", "hardware"], "example": "api", "type": "string"}, "uri": {"description": "Link to the API endpoint for this reuse", "readOnly": true, "type": "string"}, "url": {"description": "The remote URL (website)", "type": "string"}}, "required": ["created_at", "description", "id", "last_modified", "slug", "title", "topic", "type", "url"], "type": "object"}, "Reuse (write)": {"properties": {"archived": {"format": "date-time", "type": "string"}, "dataservices": {"items": {"description": "ID of the reference", "type": "string"}, "type": "array"}, "datasets": {"items": {"description": "ID of the reference", "type": "string"}, "type": "array"}, "deleted": {"format": "date-time", "type": "string"}, "description": {"format": "markdown", "type": "string"}, "extras": {"type": "object"}, "organization": {"description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user.", "type": "string"}, "owner": {"description": "Only present if organization is not set. Can only be set to the current authenticated user.", "type": "string"}, "private": {"type": "boolean"}, "tags": {"items": {"type": "string"}, "type": "array"}, "title": {"type": "string"}, "topic": {"enum": ["health", "transport_and_mobility", "housing_and_development", "food_and_agriculture", "culture_and_recreation", "economy_and_business", "environment_and_energy", "work_and_training", "politics_and_public_life", "safety_and_security", "education_and_research", "society_and_demography", "law_and_justice", "open_data_tools", "others"], "example": "health", "type": "string"}, "type": {"enum": ["api", "application", "idea", "news_article", "paper", "post", "visualization", "hardware"], "example": "api", "type": "string"}, "url": {"description": "The remote URL (website)", "type": "string"}}, "required": ["description", "title", "topic", "type", "url"], "type": "object"}, "ReusePage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Reuse (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "ReusePermissions": {"properties": {"delete": {"type": "boolean"}, "edit": {"type": "boolean"}}, "type": "object"}, "ReuseReference": {"allOf": [{"$ref": "#/definitions/BaseReference"}, {"properties": {"image": {"description": "URL of the image", "readOnly": true, "type": "string"}, "image_thumbnail": {"description": "URL of the cropped and squared image (500x500)", "readOnly": true, "type": "string"}, "page": {"description": "Link to the udata web page for this reuse", "readOnly": true, "type": "string"}, "title": {"type": "string"}, "uri": {"description": "Link to the API endpoint for this reuse", "readOnly": true, "type": "string"}}, "required": ["title"], "type": "object"}]}, "ReuseSuggestion": {"properties": {"id": {"description": "The reuse identifier", "readOnly": true, "type": "string"}, "image_url": {"description": "The reuse thumbnail URL", "readOnly": true, "type": "string"}, "page": {"description": "The reuse web page URL", "readOnly": true, "type": "string"}, "slug": {"description": "The reuse permalink string", "readOnly": true, "type": "string"}, "title": {"description": "The reuse title", "readOnly": true, "type": "string"}}, "type": "object"}, "ReuseTopic": {"properties": {"id": {"description": "The reuse topic identifier", "type": "string"}, "label": {"description": "The reuse topic display name", "type": "string"}}, "type": "object"}, "ReuseType": {"properties": {"id": {"description": "The reuse type identifier", "type": "string"}, "label": {"description": "The reuse type display name", "type": "string"}}, "type": "object"}, "Schema": {"properties": {"name": {"type": "string"}, "url": {"type": "string"}, "version": {"type": "string"}}, "type": "object"}, "Schema (read)": {"properties": {}, "type": "object"}, "Site (read)": {"properties": {"dataservices_blocs": {"items": {"type": "object"}, "type": "array"}, "datasets_blocs": {"items": {"type": "object"}, "type": "array"}, "feed_size": {"type": "integer"}, "id": {"readOnly": true, "type": "string"}, "keywords": {"items": {"type": "string"}, "type": "array"}, "metrics": {"readOnly": true, "type": "object"}, "reuses_blocs": {"items": {"type": "object"}, "type": "array"}, "title": {"description": "The site display title", "type": "string"}, "version": {"description": "The current version of udata", "readOnly": true, "type": "string"}}, "required": ["feed_size", "id", "title"], "type": "object", "x-mask": "{id,metrics,title,keywords,feed_size,version}"}, "Site (write)": {"properties": {"dataservices_blocs": {"items": {"type": "object"}, "type": "array"}, "datasets_blocs": {"items": {"type": "object"}, "type": "array"}, "feed_size": {"type": "integer"}, "keywords": {"items": {"type": "string"}, "type": "array"}, "reuses_blocs": {"items": {"type": "object"}, "type": "array"}, "title": {"description": "The site display title", "type": "string"}}, "required": ["feed_size", "title"], "type": "object"}, "SpatialCoverage (read)": {"properties": {"geom": {"allOf": [{"$ref": "#/definitions/GeoJSON"}], "description": "A multipolygon for the whole coverage"}, "granularity": {"default": "other", "description": "The spatial/territorial granularity (full Granularity object if `X-Get-Datasets-Full-Objects` is set, ID of the granularity otherwise)", "type": "object"}, "zones": {"description": "The covered zones identifiers (full GeoZone objects if `X-Get-Datasets-Full-Objects` is set, IDs of the zones otherwise)", "type": "object"}}, "type": "object"}, "Task": {"properties": {"exc": {"description": "The exception thrown during execution", "type": "string"}, "id": {"description": "Tha task execution ID", "readOnly": true, "type": "string"}, "result": {"description": "The task results if exists", "type": "string"}, "status": {"description": "Cron expression for hour", "enum": ["RETRY", "RECEIVED", "FAILURE", "REVOKED", "PENDING", "SUCCESS", "STARTED"], "example": "RETRY", "readOnly": true, "type": "string"}, "traceback": {"description": "The execution traceback", "type": "string"}}, "type": "object"}, "Team (read)": {"properties": {}, "type": "object"}, "TemporalCoverage": {"properties": {"end": {"description": "The temporal coverage end date", "format": "date-time", "type": "string"}, "start": {"description": "The temporal coverage start date", "format": "date-time", "type": "string"}}, "required": ["start"], "type": "object"}, "TerritorySuggestion": {"properties": {"code": {"description": "The territory main code", "type": "string"}, "id": {"description": "The territory identifier", "type": "string"}, "level": {"description": "The territory administrative level", "type": "string"}, "name": {"description": "The territory name", "type": "string"}, "uri": {"description": "The zone uri", "type": "string"}}, "required": ["code", "id", "level", "name", "uri"], "type": "object"}, "TopicReference": {"allOf": [{"$ref": "#/definitions/BaseReference"}, {"properties": {"name": {"type": "string"}, "page": {"description": "Link to the udata web page for this topic", "readOnly": true, "type": "string"}, "uri": {"description": "Link to the API endpoint for this topic", "readOnly": true, "type": "string"}}, "required": ["name"], "type": "object"}]}, "Transfer": {"properties": {"comment": {"description": "A comment about the transfer request", "readOnly": true, "type": "string"}, "created": {"description": "The transfer request date", "format": "date-time", "readOnly": true, "type": "string"}, "id": {"description": "The transfer unique identifier", "readOnly": true, "type": "string"}, "owner": {"allOf": [{"$ref": "#/definitions/BaseReference"}], "description": "The user or organization currently owning the transfered object", "readOnly": true}, "recipient": {"allOf": [{"$ref": "#/definitions/BaseReference"}], "description": "The user or organization receiving the transfered object", "readOnly": true}, "reponse_comment": {"description": "A comment about the transfer response", "readOnly": true, "type": "string"}, "responded": {"description": "The transfer response date", "format": "date-time", "readOnly": true, "type": "string"}, "status": {"description": "The current transfer request status", "enum": ["pending", "accepted", "refused"], "example": "pending", "type": "string"}, "subject": {"allOf": [{"$ref": "#/definitions/BaseReference"}], "description": "The transfered object", "readOnly": true}, "user": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The user who requested the transfer", "readOnly": true}}, "type": "object"}, "TransferRequest": {"properties": {"comment": {"description": "An explanation about the transfer request", "type": "string"}, "recipient": {"allOf": [{"$ref": "#/definitions/BaseReference"}], "description": "The transfer recipient, either an user or an organization"}, "subject": {"allOf": [{"$ref": "#/definitions/BaseReference"}], "description": "The transfered subject"}}, "required": ["comment", "recipient", "subject"], "type": "object"}, "TransferResponse": {"properties": {"comment": {"description": "An optional comment about the transfer response", "type": "string"}, "response": {"description": "The response", "enum": ["accept", "refuse"], "example": "accept", "type": "string"}}, "required": ["response"], "type": "object"}, "UploadStatus": {"properties": {"error": {"type": "string"}, "success": {"type": "boolean"}}, "type": "object"}, "UploadedCommunityResource": {"allOf": [{"$ref": "#/definitions/CommunityResource"}, {"properties": {"success": {"default": true, "description": "Whether the upload succeeded or not.", "readOnly": true, "type": "boolean"}}, "type": "object"}]}, "UploadedImage": {"properties": {"image": {"type": "string"}, "success": {"default": true, "description": "Whether the upload succeeded or not.", "readOnly": true, "type": "boolean"}}, "type": "object"}, "UploadedResource": {"allOf": [{"$ref": "#/definitions/Resource"}, {"properties": {"success": {"default": true, "description": "Whether the upload succeeded or not.", "readOnly": true, "type": "boolean"}}, "type": "object"}]}, "User (read)": {"properties": {"about": {"format": "markdown", "type": "string"}, "active": {"readOnly": true, "type": "boolean"}, "avatar": {"description": "URL of the image", "readOnly": true, "type": "string"}, "avatar_thumbnail": {"description": "URL of the cropped and squared image (500x500)", "readOnly": true, "type": "string"}, "deleted": {"description": "The date the account was deleted, null for a live account", "format": "date-time", "readOnly": true, "type": "string"}, "email": {"maxLength": 255, "type": "string"}, "first_name": {"maxLength": 255, "type": "string"}, "id": {"readOnly": true, "type": "string"}, "last_login_at": {"format": "date-time", "readOnly": true, "type": "string"}, "last_name": {"maxLength": 255, "type": "string"}, "mail_cadence": {"enum": ["immediate", "daily", "weekly"], "example": "immediate", "type": "string"}, "metrics": {"readOnly": true, "type": "object"}, "notifications_paused": {"type": "boolean"}, "organizations": {"description": "The organizations the user belongs to", "items": {"$ref": "#/definitions/OrganizationReference"}, "readOnly": true, "type": "array"}, "page": {"description": "Link to the udata web page for this user", "readOnly": true, "type": "string"}, "password_rotation_demanded": {"format": "date-time", "readOnly": true, "type": "string"}, "password_rotation_performed": {"format": "date-time", "readOnly": true, "type": "string"}, "roles": {"items": {"readOnly": true, "type": "string"}, "readOnly": true, "type": "array"}, "since": {"format": "date-time", "readOnly": true, "type": "string"}, "slug": {"maxLength": 255, "readOnly": true, "type": "string"}, "uri": {"description": "Link to the API endpoint for this user", "readOnly": true, "type": "string"}, "website": {"type": "string"}}, "required": ["email", "first_name", "id", "last_name", "mail_cadence", "since", "slug"], "type": "object"}, "User (write)": {"properties": {"about": {"format": "markdown", "type": "string"}, "email": {"maxLength": 255, "type": "string"}, "first_name": {"maxLength": 255, "type": "string"}, "last_name": {"maxLength": 255, "type": "string"}, "mail_cadence": {"enum": ["immediate", "daily", "weekly"], "example": "immediate", "type": "string"}, "notifications_paused": {"type": "boolean"}, "website": {"type": "string"}}, "required": ["email", "first_name", "last_name", "mail_cadence"], "type": "object"}, "UserPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/User (read)"}, "type": "array"}, "next_page": {"description": "The next page URL if exists", "type": "string"}, "page": {"description": "The current page", "minimum": 1, "type": "integer"}, "page_size": {"description": "The page size used for pagination", "minimum": 0, "type": "integer"}, "previous_page": {"description": "The previous page URL if exists", "type": "string"}, "total": {"description": "The total paginated items", "minimum": 0, "type": "integer"}}, "required": ["page", "page_size", "total"], "type": "object"}, "UserReference": {"allOf": [{"$ref": "#/definitions/BaseReference"}, {"properties": {"avatar": {"description": "URL of the image", "readOnly": true, "type": "string"}, "avatar_thumbnail": {"description": "URL of the cropped and squared image (500x500)", "readOnly": true, "type": "string"}, "deleted": {"description": "The date the account was deleted, null for a live account", "format": "date-time", "readOnly": true, "type": "string"}, "first_name": {"maxLength": 255, "type": "string"}, "last_name": {"maxLength": 255, "type": "string"}, "page": {"description": "Link to the udata web page for this user", "readOnly": true, "type": "string"}, "slug": {"maxLength": 255, "readOnly": true, "type": "string"}, "uri": {"description": "Link to the API endpoint for this user", "readOnly": true, "type": "string"}}, "required": ["first_name", "last_name", "slug"], "type": "object"}]}, "UserReferenceWithEmail": {"allOf": [{"$ref": "#/definitions/UserReference"}, {"properties": {"email": {"description": "The user email, obfuscated unless the caller may see it", "readOnly": true, "type": "string"}, "last_login_at": {"format": "date-time", "readOnly": true, "type": "string"}}, "type": "object"}]}, "UserRole": {"properties": {"name": {"description": "The role name", "readOnly": true, "type": "string"}}, "type": "object"}, "UserSuggestion": {"properties": {"avatar_url": {"description": "The user avatar URL", "readOnly": true, "type": "string"}, "email": {"description": "The user email (only the domain for non-admin user)", "readOnly": true, "type": "object"}, "first_name": {"description": "The user first name", "readOnly": true, "type": "string"}, "id": {"description": "The user identifier", "readOnly": true, "type": "string"}, "last_name": {"description": "The user last name", "readOnly": true, "type": "string"}, "slug": {"description": "The user permalink string", "readOnly": true, "type": "string"}}, "type": "object"}, "ValidationError": {"properties": {"errors": {"type": "object"}, "message": {"type": "string"}}, "type": "object"}, "VisualizationPermissions": {"properties": {"delete": {"type": "boolean"}, "edit": {"type": "boolean"}}, "type": "object"}, "XAxis (read)": {"properties": {"column_x": {"type": "string"}, "sort_x_by": {"enum": ["axis_x", "axis_y"], "example": "axis_x", "type": "string"}, "sort_x_direction": {"enum": ["asc", "desc"], "example": "asc", "type": "string"}, "type": {"enum": ["discrete", "continuous"], "example": "discrete", "type": "string"}}, "required": ["column_x", "type"], "type": "object"}, "XAxis (write)": {"properties": {"column_x": {"type": "string"}, "sort_x_by": {"enum": ["axis_x", "axis_y"], "example": "axis_x", "type": "string"}, "sort_x_direction": {"enum": ["asc", "desc"], "example": "asc", "type": "string"}, "type": {"enum": ["discrete", "continuous"], "example": "discrete", "type": "string"}}, "required": ["column_x", "type"], "type": "object"}, "YAxis (read)": {"properties": {"label": {"type": "string"}, "max": {"type": "number"}, "min": {"type": "number"}, "unit": {"type": "string"}, "unit_position": {"enum": ["prefix", "suffix"], "example": "prefix", "type": "string"}}, "type": "object"}, "YAxis (write)": {"properties": {"label": {"type": "string"}, "max": {"type": "number"}, "min": {"type": "number"}, "unit": {"type": "string"}, "unit_position": {"enum": ["prefix", "suffix"], "example": "prefix", "type": "string"}}, "type": "object"}}, "host": "geodata229.bj", "info": {"description": "uData API", "title": "uData API", "version": "1.0"}, "paths": {"/access_type/reason_categories/": {"get": {"operationId": "reason_categories", "responses": {"200": {"description": "Success"}}, "summary": "List all limitation reason categories", "tags": ["access_type"]}}, "/activity/": {"get": {"operationId": "activity", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"default": "-created_at", "description": "The field (and direction) on which sorting apply", "enum": ["created_at", "-created_at"], "in": "query", "name": "sort", "type": "string"}, {"description": "Filter activities for that particular user", "in": "query", "name": "user", "type": "string"}, {"description": "Filter activities for that particular organization", "in": "query", "name": "organization", "type": "string"}, {"collectionFormat": "multi", "description": "Filter activities on those keys (ex : dataset:updated). Repeatable.", "in": "query", "items": {"type": "string"}, "name": "key", "type": "array"}, {"description": "Filter activities for that particular object id (ex : reuse, dataset, etc.)", "in": "query", "name": "related_to", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ActivityPage"}}}, "summary": "Fetch site activity, optionally filtered by user or org", "tags": ["site"]}}, "/avatars/{identifier}/{size}/": {"get": {"operationId": "avatars", "responses": {"200": {"description": "Success"}}, "summary": "Get a deterministic avatar given an identifier at a given size", "tags": ["avatars"]}, "parameters": [{"in": "path", "name": "identifier", "required": true, "type": "string"}, {"in": "path", "name": "size", "required": true, "type": "integer"}]}, "/contacts/": {"post": {"operationId": "create_contact_point", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/ContactPoint%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ContactPoint%20%28read%29"}}, "400": {"description": "Validation error"}}, "summary": "Creates a contact point", "tags": ["contacts"]}}, "/contacts/roles/": {"get": {"operationId": "contact_point_roles", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/ContactPointRoles"}, "type": "array"}}}, "summary": "List all contact point roles", "tags": ["contacts"]}}, "/contacts/{contact_point}/": {"delete": {"operationId": "delete_contact_point", "responses": {"204": {"description": "Contact point deleted"}, "404": {"description": "Contact point not found"}}, "summary": "Deletes a contact point given its identifier", "tags": ["contacts"]}, "get": {"operationId": "get_contact_point", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ContactPoint%20%28read%29"}}, "404": {"description": "Contact point not found"}}, "summary": "Get a contact point given its identifier", "tags": ["contacts"]}, "parameters": [{"in": "path", "name": "contact_point", "required": true, "type": "string"}], "put": {"operationId": "update_contact_point", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/ContactPoint%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ContactPoint%20%28read%29"}}, "400": {"description": "Validation error"}, "404": {"description": "Contact point not found"}}, "summary": "Updates a contact point given its identifier", "tags": ["contacts"]}}, "/dataservices/": {"get": {"operationId": "list_dataservices", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "The field (and direction) on which sorting apply", "enum": ["followers", "views", "title", "base_api_url", "created", "last_modified", "-followers", "-views", "-title", "-base_api_url", "-created", "-last_modified"], "in": "query", "name": "sort", "type": "string"}, {"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"in": "query", "name": "topic", "type": "string"}, {"in": "query", "name": "reuse", "type": "string"}, {"in": "query", "name": "owner", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"format": "my-custom-format", "in": "query", "name": "organization_badge", "type": "string"}, {"enum": ["open", "open_with_account", "restricted"], "in": "query", "name": "access_type", "type": "string"}, {"collectionFormat": "multi", "in": "query", "items": {"type": "string"}, "name": "tag", "type": "array"}, {"in": "query", "name": "featured", "type": "boolean"}, {"in": "query", "name": "contact_point", "type": "string"}, {"in": "query", "name": "dataset", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DataservicePage"}}}, "summary": "List or search all dataservices", "tags": ["dataservices"]}, "post": {"operationId": "create_dataservice", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Dataservice%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/Dataservice%20%28read%29"}}, "400": {"description": "Validation error"}}, "tags": ["dataservices"]}}, "/dataservices/recent.atom": {"get": {"operationId": "recent_dataservices_atom_feed", "responses": {"200": {"description": "Success"}}, "tags": ["dataservices"]}}, "/dataservices/suggest/": {"get": {"operationId": "suggest_dataservices", "parameters": [{"description": "The string to autocomplete/suggest", "in": "query", "name": "q", "required": true, "type": "string"}, {"default": 10, "description": "The amount of suggestion to fetch", "in": "query", "name": "size", "type": "integer"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/DataserviceSuggestion"}, "type": "array"}}}, "summary": "Dataservices suggest endpoint using mongoDB contains", "tags": ["dataservices"]}}, "/dataservices/{dataservice}/": {"delete": {"operationId": "delete_dataservice", "parameters": [{"default": false, "description": "Send formal legal notice with appeal information to owner (admin only)", "in": "query", "name": "send_legal_notice", "type": "boolean"}], "responses": {"204": {"description": "dataservice deleted"}}, "tags": ["dataservices"]}, "get": {"operationId": "get_dataservice", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Dataservice%20%28read%29"}}}, "tags": ["dataservices"]}, "parameters": [{"in": "path", "name": "dataservice", "required": true, "type": "string"}], "patch": {"operationId": "update_dataservice", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Dataservice%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Dataservice%20%28read%29"}}, "400": {"description": "Validation error"}}, "tags": ["dataservices"]}}, "/dataservices/{dataservice}/datasets/": {"parameters": [{"description": "The dataservice ID or slug", "in": "path", "name": "dataservice", "required": true, "type": "string"}], "post": {"operationId": "dataservice_datasets_create", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"items": {"$ref": "#/definitions/DataserviceDatasetsAdd"}, "type": "array"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Dataservice%20%28read%29"}}, "400": {"description": "Malformed object id(s) in request"}, "403": {"description": "Forbidden"}, "404": {"description": "Dataservice not found"}, "410": {"description": "Dataservice has been deleted"}}, "tags": ["dataservices"]}}, "/dataservices/{dataservice}/datasets/{dataset}/": {"delete": {"operationId": "delete_dataservice_dataset_api_/dataservices/<dataservice:dataservice>/datasets/<dataset:dataset>/", "responses": {"404": {"description": "Dataservice not found"}}, "tags": ["dataservices"]}, "parameters": [{"description": "The dataservice ID or slug", "in": "path", "name": "dataservice", "required": true, "type": "string"}, {"in": "path", "name": "dataset", "required": true, "type": "string"}]}, "/dataservices/{dataservice}/featured/": {"delete": {"operationId": "unfeature_dataservice", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Dataservice%20%28read%29"}}}, "summary": "Unmark a dataservice as featured", "tags": ["dataservices"]}, "parameters": [{"description": "The dataservice ID or slug", "in": "path", "name": "dataservice", "required": true, "type": "string"}], "post": {"operationId": "feature_dataservice", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Dataservice%20%28read%29"}}}, "summary": "Mark a dataservice as featured", "tags": ["dataservices"]}}, "/dataservices/{dataservice}/rdf": {"get": {"operationId": "rdf_dataservice", "responses": {"404": {"description": "Dataservice not found"}, "410": {"description": "Dataservice has been deleted"}}, "tags": ["dataservices"]}, "parameters": [{"description": "The dataservice ID or slug", "in": "path", "name": "dataservice", "required": true, "type": "string"}]}, "/dataservices/{dataservice}/rdf.{_format}": {"get": {"operationId": "rdf_dataservice_format", "responses": {"404": {"description": "Dataservice not found"}, "410": {"description": "Dataservice has been deleted"}}, "tags": ["dataservices"]}, "parameters": [{"description": "The dataservice ID or slug", "in": "path", "name": "dataservice", "required": true, "type": "string"}, {"in": "path", "name": "_format", "required": true, "type": "string"}]}, "/dataservices/{id}/followers/": {"delete": {"description": "Returns the number of followers left after the operation", "operationId": "unfollow_dataservice", "responses": {"200": {"description": "Success"}}, "summary": "Unfollow an object given its ID", "tags": ["dataservices"]}, "get": {"operationId": "list_dataservice_followers", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "Filter follower by user, it allows to check if a user is following the object", "in": "query", "name": "user", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/FollowPage"}}}, "summary": "List all followers for a given object", "tags": ["dataservices"]}, "parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}], "post": {"description": "Returns the number of followers left after the operation", "operationId": "follow_dataservice", "responses": {"200": {"description": "Success"}}, "summary": "Follow an object given its ID", "tags": ["dataservices"]}}, "/datasets/": {"get": {"operationId": "list_datasets", "parameters": [{"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"description": "The field (and direction) on which sorting apply", "enum": ["title", "created", "last_update", "reuses", "followers", "views", "-title", "-created", "-last_update", "-reuses", "-followers", "-views"], "in": "query", "name": "sort", "type": "string"}, {"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"collectionFormat": "multi", "in": "query", "items": {"type": "string"}, "name": "tag", "type": "array"}, {"in": "query", "name": "license", "type": "string"}, {"description": "If set to true, it will filter on featured datasets only. If set to false, it will exclude featured datasets.", "in": "query", "name": "featured", "type": "boolean"}, {"in": "query", "name": "geozone", "type": "string"}, {"in": "query", "name": "granularity", "type": "string"}, {"in": "query", "name": "temporal_coverage", "type": "string"}, {"enum": ["open", "open_with_account", "restricted"], "in": "query", "name": "access_type", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"enum": ["pivotal-data", "spd", "inspire", "hvd", "sl", "sr"], "in": "query", "name": "badge", "type": "string"}, {"enum": ["public-service", "certified", "association", "company", "local-authority"], "in": "query", "name": "organization_badge", "type": "string"}, {"in": "query", "name": "owner", "type": "string"}, {"description": "(beta, subject to change/be removed)", "in": "query", "name": "followed_by", "type": "string"}, {"in": "query", "name": "format", "type": "string"}, {"in": "query", "name": "schema", "type": "string"}, {"in": "query", "name": "schema_version", "type": "string"}, {"in": "query", "name": "topic", "type": "string"}, {"in": "query", "name": "credit", "type": "string"}, {"in": "query", "name": "dataservice", "type": "string"}, {"in": "query", "name": "reuse", "type": "string"}, {"description": "If set to true, it will filter on archived datasets only. If set to false, it will exclude archived datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "archived", "type": "boolean"}, {"description": "If set to true, it will filter on deleted datasets only. If set to false, it will exclude deleted datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "deleted", "type": "boolean"}, {"description": "If set to true, it will filter on private datasets only. If set to false, it will exclude private datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "private", "type": "boolean"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DatasetPage"}}}, "summary": "List or search all datasets", "tags": ["datasets"]}, "post": {"operationId": "create_dataset", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Dataset"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/Dataset"}}, "400": {"description": "Validation error"}}, "summary": "Create a new dataset", "tags": ["datasets"]}}, "/datasets/badges/": {"get": {"operationId": "available_dataset_badges", "responses": {"200": {"description": "Success"}}, "summary": "List all available dataset badges and their labels", "tags": ["datasets"]}}, "/datasets/community_resources/": {"get": {"operationId": "list_community_resources", "parameters": [{"default": "-created_at_internal", "description": "The sorting attribute", "in": "query", "name": "sort", "type": "string"}, {"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "Filter activities for that particular organization", "in": "query", "name": "organization", "type": "string"}, {"description": "Filter activities for that particular dataset", "in": "query", "name": "dataset", "type": "string"}, {"description": "Filter activities for that particular user", "in": "query", "name": "owner", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CommunityResourcePage"}}}, "summary": "List all community resources", "tags": ["datasets"]}, "post": {"operationId": "create_community_resource", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/CommunityResource"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/CommunityResource"}}, "400": {"description": "Validation error"}}, "summary": "Create a new community resource", "tags": ["datasets"]}}, "/datasets/community_resources/{community}/": {"delete": {"operationId": "delete_community_resource", "responses": {"200": {"description": "Success"}}, "summary": "Delete a given community resource", "tags": ["datasets"]}, "get": {"operationId": "retrieve_community_resource", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CommunityResource"}}}, "summary": "Retrieve a community resource given its identifier", "tags": ["datasets"]}, "parameters": [{"description": "The community resource unique identifier", "in": "path", "name": "community", "required": true, "type": "string"}, {"description": "The dataset ID or slug", "in": "query", "name": "dataset", "type": "string"}], "put": {"operationId": "update_community_resource", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/CommunityResource"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CommunityResource"}}, "400": {"description": "Validation error"}}, "summary": "Update a given community resource", "tags": ["datasets"]}}, "/datasets/community_resources/{community}/upload/": {"parameters": [{"description": "The community resource unique identifier", "in": "path", "name": "community", "required": true, "type": "string"}, {"description": "The dataset ID or slug", "in": "query", "name": "dataset", "type": "string"}], "post": {"consumes": ["multipart/form-data"], "operationId": "upload_community_resource", "parameters": [{"description": "The file to upload, or the part to upload when the file is sent in chunks. Only the request assembling a chunked upload omits it.", "in": "formData", "name": "file", "type": "file"}, {"description": "Chunked uploads only: an identifier chosen by the client, shared by every request of the same upload", "in": "formData", "name": "uuid", "type": "string"}, {"description": "Chunked uploads only: the name of the assembled file. A single-request upload takes it from the uploaded file itself.", "in": "formData", "name": "filename", "type": "string"}, {"description": "Chunked uploads only: the zero-based index of the part being sent", "in": "formData", "name": "partindex", "type": "integer"}, {"description": "The number of parts the file is split into. Above 1, the upload is chunked: send each part, then a last request without `file` to assemble them.", "in": "formData", "name": "totalparts", "type": "integer"}, {"description": "Chunked uploads only: the size in bytes of the part being sent, checked against the received one", "in": "formData", "name": "chunksize", "type": "integer"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UploadedCommunityResource"}}, "400": {"description": "Upload error"}, "415": {"description": "Incorrect file content type"}}, "summary": "Update the file related to a given community resource", "tags": ["datasets"]}}, "/datasets/extensions/": {"get": {"operationId": "allowed_extensions", "responses": {"200": {"description": "Success", "schema": {"items": {"type": "string"}, "type": "array"}}}, "summary": "List all allowed resources extensions", "tags": ["datasets"]}}, "/datasets/frequencies/": {"get": {"operationId": "list_frequencies", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Frequency"}, "type": "array"}}}, "summary": "List all available frequencies", "tags": ["datasets"]}}, "/datasets/licenses/": {"get": {"operationId": "list_licenses", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/License"}, "type": "array"}}}, "summary": "List all available licenses", "tags": ["datasets"]}}, "/datasets/r/{id}": {"get": {"operationId": "redirect_resource", "parameters": [{"description": "The dataset ID or slug", "in": "query", "name": "dataset", "type": "string"}], "responses": {"200": {"description": "Success"}}, "summary": "Redirect to the latest version of a resource given its identifier", "tags": ["datasets"]}, "parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}]}, "/datasets/recent.atom": {"get": {"operationId": "recent_datasets_atom_feed", "parameters": [{"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"description": "The field (and direction) on which sorting apply", "enum": ["title", "created", "last_update", "reuses", "followers", "views", "-title", "-created", "-last_update", "-reuses", "-followers", "-views"], "in": "query", "name": "sort", "type": "string"}, {"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"collectionFormat": "multi", "in": "query", "items": {"type": "string"}, "name": "tag", "type": "array"}, {"in": "query", "name": "license", "type": "string"}, {"description": "If set to true, it will filter on featured datasets only. If set to false, it will exclude featured datasets.", "in": "query", "name": "featured", "type": "boolean"}, {"in": "query", "name": "geozone", "type": "string"}, {"in": "query", "name": "granularity", "type": "string"}, {"in": "query", "name": "temporal_coverage", "type": "string"}, {"enum": ["open", "open_with_account", "restricted"], "in": "query", "name": "access_type", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"enum": ["pivotal-data", "spd", "inspire", "hvd", "sl", "sr"], "in": "query", "name": "badge", "type": "string"}, {"enum": ["public-service", "certified", "association", "company", "local-authority"], "in": "query", "name": "organization_badge", "type": "string"}, {"in": "query", "name": "owner", "type": "string"}, {"description": "(beta, subject to change/be removed)", "in": "query", "name": "followed_by", "type": "string"}, {"in": "query", "name": "format", "type": "string"}, {"in": "query", "name": "schema", "type": "string"}, {"in": "query", "name": "schema_version", "type": "string"}, {"in": "query", "name": "topic", "type": "string"}, {"in": "query", "name": "credit", "type": "string"}, {"in": "query", "name": "dataservice", "type": "string"}, {"in": "query", "name": "reuse", "type": "string"}, {"description": "If set to true, it will filter on archived datasets only. If set to false, it will exclude archived datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "archived", "type": "boolean"}, {"description": "If set to true, it will filter on deleted datasets only. If set to false, it will exclude deleted datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "deleted", "type": "boolean"}, {"description": "If set to true, it will filter on private datasets only. If set to false, it will exclude private datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "private", "type": "boolean"}], "responses": {"200": {"description": "Success"}}, "tags": ["datasets"]}}, "/datasets/resource_types/": {"get": {"operationId": "resource_types", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/ResourceType"}, "type": "array"}}}, "summary": "List all resource types", "tags": ["datasets"]}}, "/datasets/schemas/": {"get": {"operationId": "schemas", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/CatalogSchema"}, "type": "array"}}}, "summary": "List all available schemas", "tags": ["datasets"]}}, "/datasets/suggest/": {"get": {"operationId": "suggest_datasets", "parameters": [{"description": "The string to autocomplete/suggest", "in": "query", "name": "q", "required": true, "type": "string"}, {"default": 10, "description": "The amount of suggestion to fetch", "in": "query", "name": "size", "type": "integer"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DatasetSuggestion"}}}, "summary": "Datasets suggest endpoint using mongoDB contains", "tags": ["datasets"]}}, "/datasets/suggest/formats/": {"get": {"operationId": "suggest_formats", "parameters": [{"description": "The string to autocomplete/suggest", "in": "query", "name": "q", "required": true, "type": "string"}, {"default": 10, "description": "The amount of suggestion to fetch", "in": "query", "name": "size", "type": "integer"}], "responses": {"200": {"description": "Success"}}, "summary": "Suggest file formats", "tags": ["datasets"]}}, "/datasets/suggest/mime/": {"get": {"operationId": "suggest_mime", "parameters": [{"description": "The string to autocomplete/suggest", "in": "query", "name": "q", "required": true, "type": "string"}, {"default": 10, "description": "The amount of suggestion to fetch", "in": "query", "name": "size", "type": "integer"}], "responses": {"200": {"description": "Success"}}, "summary": "Suggest mime types", "tags": ["datasets"]}}, "/datasets/{dataset}/": {"delete": {"operationId": "delete_dataset", "parameters": [{"default": false, "description": "Send formal legal notice with appeal information to owner (admin only)", "in": "query", "name": "send_legal_notice", "type": "boolean"}], "responses": {"204": {"description": "Dataset deleted"}, "404": {"description": "Dataset not found"}, "410": {"description": "Dataset has been deleted"}}, "summary": "Delete a dataset given its identifier", "tags": ["datasets"]}, "get": {"operationId": "get_dataset", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Dataset"}}, "404": {"description": "Dataset not found"}, "410": {"description": "Dataset has been deleted"}}, "summary": "Get a dataset given its identifier", "tags": ["datasets"]}, "parameters": [{"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}], "put": {"operationId": "update_dataset", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Dataset"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Dataset"}}, "400": {"description": "Validation error: your data cannot be updated for now, we have been notified of the error and we will fix it as soon as possible."}, "404": {"description": "Dataset not found"}, "410": {"description": "Dataset has been deleted"}}, "summary": "Update a dataset given its identifier", "tags": ["datasets"]}}, "/datasets/{dataset}/badges/": {"post": {"operationId": "add_dataset_badge", "parameters": [{"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}, {"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Badge%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Badge%20%28read%29"}}}, "summary": "Create a new badge for a given dataset", "tags": ["datasets"]}}, "/datasets/{dataset}/badges/{badge_kind}/": {"delete": {"operationId": "delete_dataset_badge", "parameters": [{"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}], "responses": {"200": {"description": "Success"}}, "summary": "Delete a badge for a given dataset", "tags": ["datasets"]}, "parameters": [{"in": "path", "name": "badge_kind", "required": true, "type": "string"}]}, "/datasets/{dataset}/doi/": {"parameters": [{"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}], "post": {"operationId": "mint_dataset_doi", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Dataset"}}, "409": {"description": "Dataset already has a DOI"}}, "summary": "Mint a DOI for the dataset and attach it", "tags": ["datasets"]}}, "/datasets/{dataset}/featured/": {"delete": {"operationId": "unfeature_dataset", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Dataset"}}}, "summary": "Unmark the dataset as featured", "tags": ["datasets"]}, "parameters": [{"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}], "post": {"operationId": "feature_dataset", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Dataset"}}}, "summary": "Mark the dataset as featured", "tags": ["datasets"]}}, "/datasets/{dataset}/rdf": {"get": {"operationId": "rdf_dataset", "responses": {"404": {"description": "Dataset not found"}, "410": {"description": "Dataset has been deleted"}}, "tags": ["datasets"]}, "parameters": [{"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}]}, "/datasets/{dataset}/rdf.{_format}": {"get": {"operationId": "rdf_dataset_format", "responses": {"404": {"description": "Dataset not found"}, "410": {"description": "Dataset has been deleted"}}, "tags": ["datasets"]}, "parameters": [{"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}, {"in": "path", "name": "_format", "required": true, "type": "string"}]}, "/datasets/{dataset}/resources/": {"post": {"operationId": "create_resource", "parameters": [{"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}, {"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Resource"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/Resource"}}, "400": {"description": "Validation error"}}, "summary": "Create a new resource for a given dataset", "tags": ["datasets"]}, "put": {"operationId": "update_resources", "parameters": [{"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}, {"in": "body", "name": "payload", "required": true, "schema": {"items": {"$ref": "#/definitions/Resource"}, "type": "array"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Resource"}, "type": "array"}}, "400": {"description": "Validation error"}}, "summary": "Reorder resources", "tags": ["datasets"]}}, "/datasets/{dataset}/resources/{rid}/": {"delete": {"operationId": "delete_resource", "responses": {"200": {"description": "Success"}}, "summary": "Delete a given resource on a given dataset", "tags": ["datasets"]}, "get": {"operationId": "get_resource", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Resource"}}}, "summary": "Get a resource given its identifier", "tags": ["datasets"]}, "parameters": [{"description": "The resource unique identifier", "in": "path", "name": "rid", "required": true, "type": "string"}, {"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}], "put": {"operationId": "update_resource", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Resource"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Resource"}}, "400": {"description": "Validation error"}}, "summary": "Update a given resource on a given dataset", "tags": ["datasets"]}}, "/datasets/{dataset}/resources/{rid}/upload/": {"parameters": [{"description": "The resource unique identifier", "in": "path", "name": "rid", "required": true, "type": "string"}, {"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}], "post": {"consumes": ["multipart/form-data"], "operationId": "upload_dataset_resource", "parameters": [{"description": "The file to upload, or the part to upload when the file is sent in chunks. Only the request assembling a chunked upload omits it.", "in": "formData", "name": "file", "type": "file"}, {"description": "Chunked uploads only: an identifier chosen by the client, shared by every request of the same upload", "in": "formData", "name": "uuid", "type": "string"}, {"description": "Chunked uploads only: the name of the assembled file. A single-request upload takes it from the uploaded file itself.", "in": "formData", "name": "filename", "type": "string"}, {"description": "Chunked uploads only: the zero-based index of the part being sent", "in": "formData", "name": "partindex", "type": "integer"}, {"description": "The number of parts the file is split into. Above 1, the upload is chunked: send each part, then a last request without `file` to assemble them.", "in": "formData", "name": "totalparts", "type": "integer"}, {"description": "Chunked uploads only: the size in bytes of the part being sent, checked against the received one", "in": "formData", "name": "chunksize", "type": "integer"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UploadedResource"}}, "400": {"description": "Upload error"}, "415": {"description": "Incorrect file content type"}}, "summary": "Upload a file related to a given resource on a given dataset", "tags": ["datasets"]}}, "/datasets/{dataset}/upload/": {"parameters": [{"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}], "post": {"consumes": ["multipart/form-data"], "operationId": "upload_new_dataset_resource", "parameters": [{"description": "The file to upload, or the part to upload when the file is sent in chunks. Only the request assembling a chunked upload omits it.", "in": "formData", "name": "file", "type": "file"}, {"description": "Chunked uploads only: an identifier chosen by the client, shared by every request of the same upload", "in": "formData", "name": "uuid", "type": "string"}, {"description": "Chunked uploads only: the name of the assembled file. A single-request upload takes it from the uploaded file itself.", "in": "formData", "name": "filename", "type": "string"}, {"description": "Chunked uploads only: the zero-based index of the part being sent", "in": "formData", "name": "partindex", "type": "integer"}, {"description": "The number of parts the file is split into. Above 1, the upload is chunked: send each part, then a last request without `file` to assemble them.", "in": "formData", "name": "totalparts", "type": "integer"}, {"description": "Chunked uploads only: the size in bytes of the part being sent, checked against the received one", "in": "formData", "name": "chunksize", "type": "integer"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/UploadedResource"}}, "400": {"description": "Upload error"}, "415": {"description": "Incorrect file content type"}}, "summary": "Upload a file for a new dataset resource", "tags": ["datasets"]}}, "/datasets/{dataset}/upload/community/": {"parameters": [{"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}], "post": {"consumes": ["multipart/form-data"], "operationId": "upload_new_community_resource", "parameters": [{"description": "The file to upload, or the part to upload when the file is sent in chunks. Only the request assembling a chunked upload omits it.", "in": "formData", "name": "file", "type": "file"}, {"description": "Chunked uploads only: an identifier chosen by the client, shared by every request of the same upload", "in": "formData", "name": "uuid", "type": "string"}, {"description": "Chunked uploads only: the name of the assembled file. A single-request upload takes it from the uploaded file itself.", "in": "formData", "name": "filename", "type": "string"}, {"description": "Chunked uploads only: the zero-based index of the part being sent", "in": "formData", "name": "partindex", "type": "integer"}, {"description": "The number of parts the file is split into. Above 1, the upload is chunked: send each part, then a last request without `file` to assemble them.", "in": "formData", "name": "totalparts", "type": "integer"}, {"description": "Chunked uploads only: the size in bytes of the part being sent, checked against the received one", "in": "formData", "name": "chunksize", "type": "integer"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/UploadedCommunityResource"}}, "400": {"description": "Upload error"}, "415": {"description": "Incorrect file content type"}}, "summary": "Upload a new community resource", "tags": ["datasets"]}}, "/datasets/{id}/followers/": {"delete": {"description": "Returns the number of followers left after the operation", "operationId": "unfollow_dataset", "responses": {"200": {"description": "Success"}}, "summary": "Unfollow an object given its ID", "tags": ["datasets"]}, "get": {"operationId": "list_dataset_followers", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "Filter follower by user, it allows to check if a user is following the object", "in": "query", "name": "user", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/FollowPage"}}}, "summary": "List all followers for a given object", "tags": ["datasets"]}, "parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}], "post": {"description": "Returns the number of followers left after the operation", "operationId": "follow_dataset", "responses": {"200": {"description": "Success"}}, "summary": "Follow an object given its ID", "tags": ["datasets"]}}, "/discussions/": {"get": {"operationId": "list_discussions", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"default": "-created", "description": "The field (and direction) on which sorting apply", "enum": ["discussion.posted_on", "title", "created", "closed", "-discussion.posted_on", "-title", "-created", "-closed"], "in": "query", "name": "sort", "type": "string"}, {"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"description": "Filters discussions on their closed status if specified", "in": "query", "name": "closed", "type": "boolean"}, {"collectionFormat": "multi", "description": "Filter discussions for a given subject", "in": "query", "items": {"type": "string"}, "name": "for", "type": "array"}, {"description": "Filter discussions for a given organization", "in": "query", "name": "org", "type": "string"}, {"description": "Filter discussions created by a user", "in": "query", "name": "user", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DiscussionPage"}}}, "summary": "List all Discussions", "tags": ["discussions"]}, "post": {"operationId": "create_discussion", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/DiscussionStart"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/Discussion%20%28read%29"}}}, "summary": "Create a new Discussion", "tags": ["discussions"]}}, "/discussions/{id}/": {"delete": {"operationId": "delete_discussion", "parameters": [{"default": false, "description": "Send formal legal notice with appeal information to owner (admin only)", "in": "query", "name": "send_legal_notice", "type": "boolean"}], "responses": {"403": {"description": "Not allowed to delete this discussion"}}, "summary": "Delete a discussion given its ID", "tags": ["discussions"]}, "get": {"operationId": "get_discussion", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Discussion%20%28read%29"}}}, "summary": "Get a discussion given its ID", "tags": ["discussions"]}, "parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}], "post": {"operationId": "comment_discussion", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/DiscussionResponse"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Discussion%20%28read%29"}}, "403": {"description": "Not allowed to close this discussion OR can't add comments on a closed discussion"}}, "summary": "Add comment and optionally close a discussion given its ID", "tags": ["discussions"]}, "put": {"operationId": "update_discussion", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/DiscussionEdit"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Discussion%20%28read%29"}}, "403": {"description": "Not allowed to update this discussion"}}, "summary": "Update a discussion given its ID", "tags": ["discussions"]}}, "/discussions/{id}/comments/{cidx}/": {"delete": {"operationId": "delete_discussion_comment", "parameters": [{"default": false, "description": "Send formal legal notice with appeal information to owner (admin only)", "in": "query", "name": "send_legal_notice", "type": "boolean"}], "responses": {"403": {"description": "Not allowed to delete this comment"}}, "summary": "Delete a comment given its index or UUID", "tags": ["discussions"]}, "parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}, {"in": "path", "name": "cidx", "required": true, "type": "string"}], "put": {"operationId": "edit_discussion_comment", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/DiscussionEditComment"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Discussion%20%28read%29"}}, "403": {"description": "Not allowed to edit this comment"}}, "summary": "Edit a comment given its index or UUID", "tags": ["discussions"]}}, "/geopf/auth": {"get": {"operationId": "geopf_auth", "responses": {"200": {"description": "Success"}}, "summary": "OAuth callback: exchange the code, persist the token, bounce back to cdata", "tags": ["geopf"]}}, "/geopf/datastores/": {"get": {"operationId": "geopf_datastores", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/GeopfDatastore"}, "type": "array"}}, "424": {"description": "Not connected to G\u00e9oplateforme"}, "502": {"description": "G\u00e9oplateforme API error"}}, "summary": "List the entrep\u00f4ts (datastores) available to the current user's geopf account", "tags": ["geopf"]}}, "/geopf/login/": {"get": {"operationId": "geopf_login", "responses": {"200": {"description": "Success"}}, "summary": "Start the OAuth link between the current user and their geopf identity", "tags": ["geopf"]}}, "/geopf/pull-offerings/{dataset}/": {"parameters": [{"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}], "post": {"operationId": "geopf_pull_offerings", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"202": {"description": "Success", "schema": {"$ref": "#/definitions/GeopfTask"}}, "424": {"description": "Not connected to G\u00e9oplateforme"}}, "summary": "Pull G\u00e9oplateforme offerings into resources for this dataset, as the current user", "tags": ["geopf"]}}, "/geopf/push/{dataset}/{rid}/": {"parameters": [{"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}, {"description": "The resource ID", "in": "path", "name": "rid", "required": true, "type": "string"}], "post": {"operationId": "geopf_push", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/GeopfPushRequest"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"202": {"description": "Success", "schema": {"$ref": "#/definitions/GeopfTask"}}, "400": {"description": "Private dataset, unsupported resource format or missing datastore_id"}, "404": {"description": "Resource not found"}, "409": {"description": "A push is in progress or the resource was already pushed"}, "424": {"description": "Not connected to G\u00e9oplateforme"}}, "summary": "Push a resource to G\u00e9oplateforme, as the current user", "tags": ["geopf"]}}, "/geopf/status/": {"get": {"description": "A stored token whose access token is merely expired still counts as\nconnected (it gets refreshed here as a side effect); only a token\nthat can no longer be refreshed reports as disconnected.", "operationId": "geopf_status", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/GeopfStatus"}}}, "summary": "Whether the current user has an active, usable geopf link", "tags": ["geopf"]}}, "/geopf/status/{dataset}/": {"get": {"description": "A pure read of the dataset's and its resources' `geopf` metadata: no\ncall to the geopf API and no token refresh, so it answers the same\nwhether or not the current user is connected.\n\nResources are split into those eligible for a push (format in\n`GEOPF_PUSHABLE_FORMATS`) and those that came back from a pull as\nofferings; the two are disjoint.\n\nA `status` of `null` means \"never run\"; otherwise it is one of\n`pending`, `done`, `error` or `timeout`.", "operationId": "geopf_dataset_status", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/GeopfDatasetStatus"}}}, "summary": "A dataset's G\u00e9oplateforme sync state, as stored locally", "tags": ["geopf"]}, "parameters": [{"description": "The dataset ID or slug", "in": "path", "name": "dataset", "required": true, "type": "string"}]}, "/geopf/token/": {"delete": {"operationId": "geopf_disconnect", "responses": {"204": {"description": "Disconnected"}}, "summary": "Disconnect the current user from G\u00e9oplateforme", "tags": ["geopf"]}}, "/harvest/backends/": {"get": {"operationId": "harvest_backends", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestBackend"}}}, "summary": "List all available harvest backends", "tags": ["harvest"]}}, "/harvest/job/{job}/": {"get": {"operationId": "get_harvest_job", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestJob%20%28read%29"}}}, "summary": "Get a single job given an ID", "tags": ["harvest"]}, "parameters": [{"in": "path", "name": "job", "required": true, "type": "string"}]}, "/harvest/job/{job}/items/": {"get": {"operationId": "list_harvest_job_items", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"enum": ["pending", "started", "done", "failed", "skipped", "archived"], "in": "query", "name": "status", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestItemPage"}}}, "summary": "List the items of a given harvest job (paginated)", "tags": ["harvest"]}, "parameters": [{"in": "path", "name": "job", "required": true, "type": "string"}]}, "/harvest/source/preview/": {"post": {"operationId": "preview_harvest_source_config", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/HarvestSource%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestJobPreview"}}}, "summary": "Preview an harvesting from a source created with the given payload", "tags": ["harvest"]}}, "/harvest/source/{source}/": {"delete": {"operationId": "delete_harvest_source", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestSource%20%28read%29"}}}, "tags": ["harvest"]}, "get": {"operationId": "get_harvest_source", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestSource%20%28read%29"}}}, "summary": "Get a single source given an ID or a slug", "tags": ["harvest"]}, "parameters": [{"in": "path", "name": "source", "required": true, "type": "string"}], "put": {"operationId": "update_harvest_source", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/HarvestSource%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestSource%20%28read%29"}}}, "summary": "Update a harvest source", "tags": ["harvest"]}}, "/harvest/source/{source}/jobs/": {"get": {"operationId": "list_harvest_jobs", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestJobPage"}}}, "summary": "List all jobs for a given source", "tags": ["harvest"]}, "parameters": [{"in": "path", "name": "source", "required": true, "type": "string"}]}, "/harvest/source/{source}/preview/": {"get": {"operationId": "preview_harvest_source", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestJobPreview"}}}, "summary": "Preview a single harvest source given an ID or a slug", "tags": ["harvest"]}, "parameters": [{"in": "path", "name": "source", "required": true, "type": "string"}]}, "/harvest/source/{source}/run/": {"parameters": [{"in": "path", "name": "source", "required": true, "type": "string"}], "post": {"operationId": "run_harvest_source", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestSource%20%28read%29"}}}, "tags": ["harvest"]}}, "/harvest/source/{source}/schedule/": {"delete": {"operationId": "unschedule_harvest_source", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestSource%20%28read%29"}}}, "summary": "Unschedule an harvest source", "tags": ["harvest"]}, "parameters": [{"in": "path", "name": "source", "required": true, "type": "string"}], "post": {"operationId": "schedule_harvest_source", "parameters": [{"description": "A cron expression", "in": "body", "name": "payload", "required": true, "schema": {"type": "string"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestSource%20%28read%29"}}}, "summary": "Schedule an harvest source", "tags": ["harvest"]}}, "/harvest/source/{source}/validate/": {"parameters": [{"in": "path", "name": "source", "required": true, "type": "string"}], "post": {"operationId": "validate_harvest_source", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/HarvestSourceValidation%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestSource%20%28read%29"}}}, "summary": "Validate or reject an harvest source", "tags": ["harvest"]}}, "/harvest/sources/": {"get": {"operationId": "list_harvest_sources", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"in": "query", "name": "owner", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"default": false, "description": "Include sources flagged as deleted", "in": "query", "name": "deleted", "type": "boolean"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/HarvestSourcePage"}, "type": "array"}}}, "summary": "List all harvest sources", "tags": ["harvest"]}, "post": {"operationId": "create_harvest_source", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/HarvestSource%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestSource%20%28read%29"}}}, "summary": "Create a new harvest source", "tags": ["harvest"]}}, "/me/": {"delete": {"operationId": "delete_me", "responses": {"204": {"description": "Object deleted"}}, "summary": "Delete my profile", "tags": ["me"]}, "get": {"operationId": "get_me", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/User%20%28read%29"}}}, "summary": "Fetch the current user (me) identity", "tags": ["me"]}, "put": {"operationId": "update_me", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/User%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/User%20%28read%29"}}, "400": {"description": "Validation error"}}, "summary": "Update my profile", "tags": ["me"]}}, "/me/api_tokens/": {"get": {"operationId": "list_api_tokens", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/ApiToken%20%28read%29"}, "type": "array"}}}, "summary": "List all my active API tokens", "tags": ["me"]}, "post": {"description": "The plaintext token is returned only once.", "operationId": "create_api_token", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/ApiToken%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/ApiTokenCreated"}}}, "summary": "Create a new API token", "tags": ["me"]}}, "/me/api_tokens/{api_token}/": {"delete": {"operationId": "revoke_api_token", "responses": {"204": {"description": "Token revoked"}, "404": {"description": "Token not found"}, "410": {"description": "Token already revoked"}}, "summary": "Revoke an API token", "tags": ["me"]}, "parameters": [{"in": "path", "name": "api_token", "required": true, "type": "string"}]}, "/me/avatar/": {"post": {"consumes": ["multipart/form-data"], "operationId": "my_avatar", "parameters": [{"description": "The image to upload", "in": "formData", "name": "file", "required": true, "type": "file"}, {"description": "An optional crop box, as `left,upper,right,lower` pixel coordinates", "in": "formData", "name": "bbox", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UploadedImage"}}}, "summary": "Upload a new avatar", "tags": ["me"]}}, "/me/datasets/": {"get": {"operationId": "my_datasets", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Dataset"}, "type": "array"}}}, "summary": "List all my datasets (including private ones)", "tags": ["me"]}}, "/me/metrics/": {"get": {"operationId": "my_metrics", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/MyMetrics"}, "type": "array"}}}, "summary": "Fetch the current user (me) metrics", "tags": ["me"]}}, "/me/org_community_resources/": {"get": {"operationId": "my_org_community_resources", "parameters": [{"description": "The string to filter items", "in": "query", "name": "q", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/CommunityResource"}, "type": "array"}}}, "summary": "List all community resources related to me and my organizations", "tags": ["me"]}}, "/me/org_datasets/": {"get": {"operationId": "my_org_datasets", "parameters": [{"description": "The string to filter items", "in": "query", "name": "q", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Dataset"}, "type": "array"}}}, "summary": "List all datasets related to me and my organizations", "tags": ["me"]}}, "/me/org_discussions/": {"get": {"operationId": "my_org_discussions", "parameters": [{"description": "The string to filter items", "in": "query", "name": "q", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Discussion%20%28read%29"}, "type": "array"}}}, "summary": "List all discussions related to my organizations", "tags": ["me"]}}, "/me/org_invitations/": {"get": {"operationId": "list_org_invitations", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/PendingInvitation"}, "type": "array"}}}, "summary": "List pending organization invitations for current user", "tags": ["me"]}}, "/me/org_invitations/{id}/accept/": {"parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}], "post": {"operationId": "accept_org_invitation", "responses": {"200": {"description": "Invitation accepted"}, "400": {"description": "Invitation is not pending"}, "404": {"description": "Invitation not found"}}, "summary": "Accept an organization invitation", "tags": ["me"]}}, "/me/org_invitations/{id}/refuse/": {"parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}], "post": {"operationId": "refuse_org_invitation", "responses": {"200": {"description": "Invitation refused"}, "400": {"description": "Invitation is not pending"}, "404": {"description": "Invitation not found"}}, "summary": "Refuse an organization invitation", "tags": ["me"]}}, "/me/org_reuses/": {"get": {"operationId": "my_org_reuses", "parameters": [{"description": "The string to filter items", "in": "query", "name": "q", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Reuse%20%28read%29"}, "type": "array"}}}, "summary": "List all reuses related to me and my organizations", "tags": ["me"]}}, "/me/reuses/": {"get": {"operationId": "my_reuses", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Reuse%20%28read%29"}, "type": "array"}}}, "summary": "List all my reuses (including private ones)", "tags": ["me"]}}, "/notifications/": {"get": {"operationId": "list_notifications", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "The field (and direction) on which sorting apply", "enum": ["created", "last_modified", "handled_at", "-created", "-last_modified", "-handled_at"], "in": "query", "name": "sort", "type": "string"}, {"enum": ["discussion.new", "discussion.comment", "discussion.closed", "organization.membership.requested", "organization.membership.invited", "organization.membership.accepted", "organization.membership.refused", "organization.badge.certified", "organization.badge.public-service", "organization.badge.company", "organization.badge.association", "organization.badge.local-authority", "reuse.created", "dataservice.created", "transfer.requested", "harvest.source.pending", "harvest.source.accepted", "harvest.source.refused"], "in": "query", "name": "type", "type": "string"}, {"in": "query", "name": "handled", "type": "boolean"}, {"in": "query", "name": "user", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/NotificationPage"}}}, "summary": "List all current user pending notifications", "tags": ["notifications"]}}, "/notifications/follow/": {"put": {"description": "hears about once done.\n\nWhich rules to write or withdraw depends on how they rank, which is the server's\nto know: stopping withdraws one's own follow, and only says no when a role or a\nbroader follow still brings the notifications in.", "operationId": "follow_notifications", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/NotificationFollow"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/NotificationResolved"}}, "400": {"description": "Unknown subject or event"}}, "summary": "Follow some notifications on a subject, or stop, and get what the current user", "tags": ["notifications"]}}, "/notifications/resolved/": {"get": {"description": "subjects, once their rules and the defaults are applied.\n\nOne answer per subject, so that a page asks once for all of its subjects. Without\nan event, it is about every notification on them.", "operationId": "resolve_notifications", "parameters": [{"collectionFormat": "multi", "description": "A subject, as `Class:id`, repeated for up to 100 subjects", "in": "query", "items": {"type": "string"}, "name": "scope", "required": true, "type": "array"}, {"description": "A notification type or a prefix of some, every notification without one", "in": "query", "name": "event", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/NotificationResolved"}, "type": "array"}}, "400": {"description": "Unknown subject or event, or too many subjects"}}, "summary": "Whether and why the current user hears about notifications on some", "tags": ["notifications"]}}, "/notifications/settings/": {"get": {"description": "Only rules are listed: whatever no rule covers follows the default rules. What\nthey add up to is given by `/notifications/resolved/`.\n\nPaginated: editing or answering follows a subject, so the rules of a busy account\nkeep growing, and each one reads its subject back.", "operationId": "list_notification_settings", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "Only the follows (a subject, yes), or only the other rules", "in": "query", "name": "followed", "type": "boolean"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/NotificationSettingPage"}}}, "summary": "List the rules the current user set about their notifications, latest first", "tags": ["notifications"]}, "put": {"description": "A rule is identified by its subject and event, either of them possibly null:\nsetting it again replaces the previous answer. Removing a follow udata made by\nitself (for editing a subject or answering about it) turns it into a \"no\":\nremoved, the next edit or answer would make it again.", "operationId": "set_notification_setting", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/NotificationSetting%20%28write%29"}}], "responses": {"204": {"description": "Rule set or removed: the list says what applies now"}, "400": {"description": "Validation error"}}, "summary": "Set a rule about some notifications, or remove it with `enabled: null`", "tags": ["notifications"]}}, "/notifications/{notification}/read/": {"parameters": [{"in": "path", "name": "notification", "required": true, "type": "string"}], "post": {"operationId": "read_notification", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Notification%20%28read%29"}}, "400": {"description": "Validation error"}}, "summary": "Read a notification", "tags": ["notifications"]}}, "/organizations/": {"get": {"operationId": "list_organizations", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "The field (and direction) on which sorting apply", "enum": ["reuses", "datasets", "followers", "views", "created", "last_modified", "name", "-reuses", "-datasets", "-followers", "-views", "-created", "-last_modified", "-name"], "in": "query", "name": "sort", "type": "string"}, {"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"format": "my-custom-format", "in": "query", "name": "badge", "type": "string"}, {"in": "query", "name": "name", "type": "string"}, {"in": "query", "name": "business_number_id", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/OrganizationPage"}}}, "summary": "List or search all organizations", "tags": ["organizations"]}, "post": {"operationId": "create_organization", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Organization%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/Organization%20%28read%29"}}, "400": {"description": "Validation error"}}, "summary": "Create a new organization", "tags": ["organizations"]}}, "/organizations/badges/": {"get": {"operationId": "available_organization_badges", "responses": {"200": {"description": "Success"}}, "summary": "List all available organization badges and their labels", "tags": ["organizations"]}}, "/organizations/roles/": {"get": {"operationId": "org_roles", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/OrganizationRole"}, "type": "array"}}}, "summary": "List all possible organization roles", "tags": ["organizations"]}}, "/organizations/suggest/": {"get": {"operationId": "suggest_organizations", "parameters": [{"description": "The string to autocomplete/suggest", "in": "query", "name": "q", "required": true, "type": "string"}, {"default": 10, "description": "The amount of suggestion to fetch", "in": "query", "name": "size", "type": "integer"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/OrganizationSuggestion"}, "type": "array"}}}, "summary": "Organizations suggest endpoint using mongoDB contains", "tags": ["organizations"]}}, "/organizations/{id}/followers/": {"delete": {"description": "Returns the number of followers left after the operation", "operationId": "unfollow_organization", "responses": {"200": {"description": "Success"}}, "summary": "Unfollow an object given its ID", "tags": ["organizations"]}, "get": {"operationId": "list_organization_followers", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "Filter follower by user, it allows to check if a user is following the object", "in": "query", "name": "user", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/FollowPage"}}}, "summary": "List all followers for a given object", "tags": ["organizations"]}, "parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}], "post": {"description": "Returns the number of followers left after the operation", "operationId": "follow_organization", "responses": {"200": {"description": "Success"}}, "summary": "Follow an object given its ID", "tags": ["organizations"]}}, "/organizations/{org}/": {"delete": {"operationId": "delete_organization", "parameters": [{"default": false, "description": "Send formal legal notice with appeal information to owner (admin only)", "in": "query", "name": "send_legal_notice", "type": "boolean"}], "responses": {"204": {"description": "Organization deleted"}, "404": {"description": "Organization not found"}, "410": {"description": "Organization has been deleted"}}, "summary": "Delete a organization given its identifier", "tags": ["organizations"]}, "get": {"operationId": "get_organization", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Organization%20%28read%29"}}, "404": {"description": "Organization not found"}, "410": {"description": "Organization has been deleted"}}, "summary": "Get a organization given its identifier", "tags": ["organizations"]}, "parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}], "put": {"operationId": "update_organization", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Organization%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Organization%20%28read%29"}}, "400": {"description": "Validation error: your data cannot be updated for now, we have been notified of the error and we will fix it as soon as possible."}, "403": {"$ref": "#/responses/PermissionDenied"}, "404": {"description": "Organization not found"}, "410": {"description": "Organization has been deleted"}}, "summary": "Update a organization given its identifier", "tags": ["organizations"]}}, "/organizations/{org}/assignments/": {"get": {"operationId": "list_organization_assignments", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Assignment%20%28read%29"}, "type": "array"}}}, "summary": "List assignments for this organization", "tags": ["organizations"]}, "parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}]}, "/organizations/{org}/badges/": {"post": {"operationId": "add_organization_badge", "parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}, {"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Badge%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Badge%20%28read%29"}}}, "summary": "Create a new badge for a given organization", "tags": ["organizations"]}}, "/organizations/{org}/badges/{badge_kind}/": {"delete": {"operationId": "delete_organization_badge", "parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}], "responses": {"200": {"description": "Success"}}, "summary": "Delete a badge for a given organization", "tags": ["organizations"]}, "parameters": [{"in": "path", "name": "badge_kind", "required": true, "type": "string"}]}, "/organizations/{org}/banner/": {"delete": {"operationId": "organization_banner_delete", "responses": {"204": {"description": "Banner image deleted"}}, "summary": "Delete the custom banner image", "tags": ["organizations"]}, "parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}], "post": {"consumes": ["multipart/form-data"], "operationId": "organization_banner_upload", "parameters": [{"description": "The image to upload", "in": "formData", "name": "file", "required": true, "type": "file"}, {"description": "An optional crop box, as `left,upper,right,lower` pixel coordinates", "in": "formData", "name": "bbox", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UploadedImage"}}}, "summary": "Upload a new banner image", "tags": ["organizations"]}}, "/organizations/{org}/catalog": {"get": {"operationId": "rdf_organization", "parameters": [{"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"description": "The field (and direction) on which sorting apply", "enum": ["title", "created", "last_update", "reuses", "followers", "views", "-title", "-created", "-last_update", "-reuses", "-followers", "-views"], "in": "query", "name": "sort", "type": "string"}, {"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"collectionFormat": "multi", "in": "query", "items": {"type": "string"}, "name": "tag", "type": "array"}, {"in": "query", "name": "license", "type": "string"}, {"description": "If set to true, it will filter on featured datasets only. If set to false, it will exclude featured datasets.", "in": "query", "name": "featured", "type": "boolean"}, {"in": "query", "name": "geozone", "type": "string"}, {"in": "query", "name": "granularity", "type": "string"}, {"in": "query", "name": "temporal_coverage", "type": "string"}, {"enum": ["open", "open_with_account", "restricted"], "in": "query", "name": "access_type", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"enum": ["pivotal-data", "spd", "inspire", "hvd", "sl", "sr"], "in": "query", "name": "badge", "type": "string"}, {"enum": ["public-service", "certified", "association", "company", "local-authority"], "in": "query", "name": "organization_badge", "type": "string"}, {"in": "query", "name": "owner", "type": "string"}, {"description": "(beta, subject to change/be removed)", "in": "query", "name": "followed_by", "type": "string"}, {"in": "query", "name": "format", "type": "string"}, {"in": "query", "name": "schema", "type": "string"}, {"in": "query", "name": "schema_version", "type": "string"}, {"in": "query", "name": "topic", "type": "string"}, {"in": "query", "name": "credit", "type": "string"}, {"in": "query", "name": "dataservice", "type": "string"}, {"in": "query", "name": "reuse", "type": "string"}, {"description": "If set to true, it will filter on archived datasets only. If set to false, it will exclude archived datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "archived", "type": "boolean"}, {"description": "If set to true, it will filter on deleted datasets only. If set to false, it will exclude deleted datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "deleted", "type": "boolean"}, {"description": "If set to true, it will filter on private datasets only. If set to false, it will exclude private datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "private", "type": "boolean"}, {"default": 100, "description": "The page size", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}], "responses": {"404": {"description": "Organization not found"}, "410": {"description": "Organization has been deleted"}}, "tags": ["organizations"]}, "parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}]}, "/organizations/{org}/catalog.{_format}": {"get": {"operationId": "rdf_organization_format", "parameters": [{"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"description": "The field (and direction) on which sorting apply", "enum": ["title", "created", "last_update", "reuses", "followers", "views", "-title", "-created", "-last_update", "-reuses", "-followers", "-views"], "in": "query", "name": "sort", "type": "string"}, {"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"collectionFormat": "multi", "in": "query", "items": {"type": "string"}, "name": "tag", "type": "array"}, {"in": "query", "name": "license", "type": "string"}, {"description": "If set to true, it will filter on featured datasets only. If set to false, it will exclude featured datasets.", "in": "query", "name": "featured", "type": "boolean"}, {"in": "query", "name": "geozone", "type": "string"}, {"in": "query", "name": "granularity", "type": "string"}, {"in": "query", "name": "temporal_coverage", "type": "string"}, {"enum": ["open", "open_with_account", "restricted"], "in": "query", "name": "access_type", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"enum": ["pivotal-data", "spd", "inspire", "hvd", "sl", "sr"], "in": "query", "name": "badge", "type": "string"}, {"enum": ["public-service", "certified", "association", "company", "local-authority"], "in": "query", "name": "organization_badge", "type": "string"}, {"in": "query", "name": "owner", "type": "string"}, {"description": "(beta, subject to change/be removed)", "in": "query", "name": "followed_by", "type": "string"}, {"in": "query", "name": "format", "type": "string"}, {"in": "query", "name": "schema", "type": "string"}, {"in": "query", "name": "schema_version", "type": "string"}, {"in": "query", "name": "topic", "type": "string"}, {"in": "query", "name": "credit", "type": "string"}, {"in": "query", "name": "dataservice", "type": "string"}, {"in": "query", "name": "reuse", "type": "string"}, {"description": "If set to true, it will filter on archived datasets only. If set to false, it will exclude archived datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "archived", "type": "boolean"}, {"description": "If set to true, it will filter on deleted datasets only. If set to false, it will exclude deleted datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "deleted", "type": "boolean"}, {"description": "If set to true, it will filter on private datasets only. If set to false, it will exclude private datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "private", "type": "boolean"}, {"default": 100, "description": "The page size", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}], "responses": {"404": {"description": "Organization not found"}, "410": {"description": "Organization has been deleted"}}, "tags": ["organizations"]}, "parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}, {"in": "path", "name": "_format", "required": true, "type": "string"}]}, "/organizations/{org}/contacts/": {"get": {"operationId": "get_organization_contact_point", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"in": "query", "name": "owner", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ContactPointPage"}}}, "summary": "List all organization contact points", "tags": ["organizations"]}, "parameters": [{"in": "path", "name": "org", "required": true, "type": "string"}]}, "/organizations/{org}/contacts/suggest/": {"get": {"operationId": "suggest_org_contact_points", "parameters": [{"description": "The string to autocomplete/suggest", "in": "query", "name": "q", "required": true, "type": "string"}, {"default": 10, "description": "The amount of suggestion to fetch", "in": "query", "name": "size", "type": "integer"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/ContactPoint%20%28read%29"}, "type": "array"}}}, "summary": "Contact points suggest endpoint using mongoDB contains", "tags": ["organizations"]}, "parameters": [{"in": "path", "name": "org", "required": true, "type": "string"}]}, "/organizations/{org}/dataservices.csv": {"get": {"operationId": "get_dataservices_csv", "responses": {"404": {"description": "Organization not found"}, "410": {"description": "Organization has been deleted"}}, "tags": ["organizations"]}, "parameters": [{"in": "path", "name": "org", "required": true, "type": "string"}]}, "/organizations/{org}/datasets-resources.csv": {"get": {"operationId": "get_datasets_resources_csv_api_/organizations/<org:org>/datasets-resources.csv", "responses": {"404": {"description": "Organization not found"}, "410": {"description": "Organization has been deleted"}}, "tags": ["organizations"]}, "parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}]}, "/organizations/{org}/datasets.csv": {"get": {"operationId": "get_datasets_csv_api_/organizations/<org:org>/datasets.csv", "responses": {"404": {"description": "Organization not found"}, "410": {"description": "Organization has been deleted"}}, "tags": ["organizations"]}, "parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}]}, "/organizations/{org}/datasets/": {"get": {"operationId": "list_organization_datasets", "parameters": [{"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"description": "The field (and direction) on which sorting apply", "enum": ["title", "created", "last_update", "reuses", "followers", "views", "-title", "-created", "-last_update", "-reuses", "-followers", "-views"], "in": "query", "name": "sort", "type": "string"}, {"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"collectionFormat": "multi", "in": "query", "items": {"type": "string"}, "name": "tag", "type": "array"}, {"in": "query", "name": "license", "type": "string"}, {"description": "If set to true, it will filter on featured datasets only. If set to false, it will exclude featured datasets.", "in": "query", "name": "featured", "type": "boolean"}, {"in": "query", "name": "geozone", "type": "string"}, {"in": "query", "name": "granularity", "type": "string"}, {"in": "query", "name": "temporal_coverage", "type": "string"}, {"enum": ["open", "open_with_account", "restricted"], "in": "query", "name": "access_type", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"enum": ["pivotal-data", "spd", "inspire", "hvd", "sl", "sr"], "in": "query", "name": "badge", "type": "string"}, {"enum": ["public-service", "certified", "association", "company", "local-authority"], "in": "query", "name": "organization_badge", "type": "string"}, {"in": "query", "name": "owner", "type": "string"}, {"description": "(beta, subject to change/be removed)", "in": "query", "name": "followed_by", "type": "string"}, {"in": "query", "name": "format", "type": "string"}, {"in": "query", "name": "schema", "type": "string"}, {"in": "query", "name": "schema_version", "type": "string"}, {"in": "query", "name": "topic", "type": "string"}, {"in": "query", "name": "credit", "type": "string"}, {"in": "query", "name": "dataservice", "type": "string"}, {"in": "query", "name": "reuse", "type": "string"}, {"description": "If set to true, it will filter on archived datasets only. If set to false, it will exclude archived datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "archived", "type": "boolean"}, {"description": "If set to true, it will filter on deleted datasets only. If set to false, it will exclude deleted datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "deleted", "type": "boolean"}, {"description": "If set to true, it will filter on private datasets only. If set to false, it will exclude private datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "private", "type": "boolean"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DatasetPage"}}}, "summary": "List organization datasets (including private ones when member)", "tags": ["organizations"]}, "parameters": [{"in": "path", "name": "org", "required": true, "type": "string"}]}, "/organizations/{org}/discussions.csv": {"get": {"operationId": "get_discussions_csv_api_/organizations/<org:org>/discussions.csv", "responses": {"404": {"description": "Organization not found"}, "410": {"description": "Organization has been deleted"}}, "tags": ["organizations"]}, "parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}]}, "/organizations/{org}/discussions/": {"get": {"operationId": "list_organization_discussions", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Discussion%20%28read%29"}, "type": "array"}}}, "summary": "List organization discussions", "tags": ["organizations"]}, "parameters": [{"in": "path", "name": "org", "required": true, "type": "string"}]}, "/organizations/{org}/logo/": {"parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}], "post": {"consumes": ["multipart/form-data"], "operationId": "organization_logo", "parameters": [{"description": "The image to upload", "in": "formData", "name": "file", "required": true, "type": "file"}, {"description": "An optional crop box, as `left,upper,right,lower` pixel coordinates", "in": "formData", "name": "bbox", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UploadedImage"}}}, "summary": "Upload a new logo", "tags": ["organizations"]}, "put": {"consumes": ["multipart/form-data"], "operationId": "resize_organization_logo", "parameters": [{"description": "The image to upload", "in": "formData", "name": "file", "required": true, "type": "file"}, {"description": "An optional crop box, as `left,upper,right,lower` pixel coordinates", "in": "formData", "name": "bbox", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UploadedImage"}}}, "summary": "Set the logo BBox", "tags": ["organizations"]}}, "/organizations/{org}/member/": {"parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}], "post": {"operationId": "invite_organization_member", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/MembershipInvite"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/MembershipRequest"}}, "400": {"description": "Bad Request"}, "403": {"description": "Not Authorized"}}, "summary": "Invite a user or email to join the organization", "tags": ["organizations"]}}, "/organizations/{org}/member/{user}/": {"delete": {"operationId": "delete_organization_member", "responses": {"403": {"description": "Not Authorized"}}, "summary": "Delete member from an organization", "tags": ["organizations"]}, "parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}, {"in": "path", "name": "user", "required": true, "type": "string"}], "put": {"operationId": "update_organization_member", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Member%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Member%20%28read%29"}}, "403": {"description": "Not Authorized"}}, "summary": "Update member status into a given organization", "tags": ["organizations"]}}, "/organizations/{org}/member/{user}/assignments/": {"parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}, {"in": "path", "name": "user", "required": true, "type": "string"}], "put": {"description": "Replaces all current assignments with the provided list.", "operationId": "sync_member_assignments", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Assignment%20%28read%29"}, "type": "array"}}, "403": {"description": "Not Authorized"}}, "summary": "Sync assignments for a partial_editor member", "tags": ["organizations"]}}, "/organizations/{org}/membership/": {"get": {"operationId": "list_membership_requests", "parameters": [{"description": "If provided, only return requests in a given status", "in": "query", "name": "status", "type": "string"}, {"description": "If provided, only return requests for this user", "in": "query", "name": "user", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/MembershipRequest"}, "type": "array"}}, "403": {"description": "Not Authorized"}}, "summary": "List membership requests for a given organization", "tags": ["organizations"]}, "parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}], "post": {"operationId": "post_membership_request_api_/organizations/<org:org>/membership/", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/MembershipRequest%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/MembershipRequest"}}, "400": {"description": "Already a member of or invited to this organization"}}, "summary": "Apply for membership to a given organization", "tags": ["organizations"]}}, "/organizations/{org}/membership/{id}/accept/": {"parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}], "post": {"operationId": "accept_membership", "parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Member%20%28read%29"}}}, "summary": "Accept user membership to a given organization", "tags": ["organizations"]}}, "/organizations/{org}/membership/{id}/cancel/": {"parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}], "post": {"operationId": "cancel_membership", "parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}], "responses": {"400": {"description": "Membership request is not pending"}}, "summary": "Cancel a pending invitation for a given organization", "tags": ["organizations"]}}, "/organizations/{org}/membership/{id}/refuse/": {"parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}], "post": {"operationId": "refuse_membership", "parameters": [{"description": "The organization ID or slug", "in": "path", "name": "org", "required": true, "type": "string"}, {"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/RefuseMembership"}}], "responses": {"200": {"description": "Success"}}, "summary": "Refuse user membership to a given organization", "tags": ["organizations"]}}, "/organizations/{org}/reuses/": {"get": {"operationId": "list_organization_reuses", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Reuse%20%28read%29"}, "type": "array"}}}, "summary": "List organization reuses (including private ones when member)", "tags": ["organizations"]}, "parameters": [{"in": "path", "name": "org", "required": true, "type": "string"}]}, "/posts/": {"get": {"operationId": "list_posts", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"default": "-published", "description": "The field (and direction) on which sorting apply", "enum": ["created_at", "modified", "created", "last_modified", "name", "headline", "published", "-created_at", "-modified", "-created", "-last_modified", "-name", "-headline", "-published"], "in": "query", "name": "sort", "type": "string"}, {"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"enum": ["news", "page"], "in": "query", "name": "kind", "type": "string"}, {"default": false, "description": "`True` also returns the unpublished posts (only for super-admins)", "in": "query", "name": "with_drafts", "type": "boolean"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/PostPage"}}}, "summary": "List all posts", "tags": ["posts"]}, "post": {"operationId": "create_post", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Post%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Post%20%28read%29"}}, "400": {"description": "Validation error"}}, "summary": "Create a post", "tags": ["posts"]}}, "/posts/recent.atom": {"get": {"operationId": "recent_posts_atom_feed", "responses": {"200": {"description": "Success"}}, "tags": ["posts"]}}, "/posts/{post}/": {"delete": {"operationId": "delete_post", "responses": {"204": {"description": "Object deleted"}, "404": {"description": "Object not found"}}, "summary": "Delete a given post", "tags": ["posts"]}, "get": {"operationId": "get_post", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Post%20%28read%29"}}, "404": {"description": "Object not found"}}, "summary": "Get a given post", "tags": ["posts"]}, "parameters": [{"description": "The post ID or slug", "in": "path", "name": "post", "required": true, "type": "string"}], "put": {"operationId": "update_post", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Post%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Post%20%28read%29"}}, "400": {"description": "Validation error"}, "404": {"description": "Object not found"}}, "summary": "Update a given post", "tags": ["posts"]}}, "/posts/{post}/image/": {"parameters": [{"in": "path", "name": "post", "required": true, "type": "string"}], "post": {"consumes": ["multipart/form-data"], "operationId": "post_image", "parameters": [{"description": "The image to upload", "in": "formData", "name": "file", "required": true, "type": "file"}, {"description": "An optional crop box, as `left,upper,right,lower` pixel coordinates", "in": "formData", "name": "bbox", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UploadedImage"}}}, "summary": "Upload a new image", "tags": ["posts"]}, "put": {"consumes": ["multipart/form-data"], "operationId": "resize_post_image", "parameters": [{"description": "The image to upload", "in": "formData", "name": "file", "required": true, "type": "file"}, {"description": "An optional crop box, as `left,upper,right,lower` pixel coordinates", "in": "formData", "name": "bbox", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UploadedImage"}}}, "summary": "Set the image BBox", "tags": ["posts"]}}, "/posts/{post}/publish/": {"delete": {"operationId": "unpublish_post", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Post%20%28read%29"}}}, "summary": "Unpublish an existing post", "tags": ["posts"]}, "parameters": [{"in": "path", "name": "post", "required": true, "type": "string"}], "post": {"operationId": "publish_post", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Post%20%28read%29"}}}, "summary": "Publish an existing post", "tags": ["posts"]}}, "/proconnect/auth": {"get": {"operationId": "get_proconnect_auth_api", "responses": {"200": {"description": "Success"}}, "tags": ["proconnect"]}}, "/proconnect/login/": {"get": {"operationId": "get_proconnect_login_api", "responses": {"200": {"description": "Success"}}, "tags": ["proconnect"]}}, "/proconnect/logout": {"get": {"operationId": "get_proconnect_logout_api", "responses": {"200": {"description": "Success"}}, "tags": ["proconnect"]}}, "/proconnect/logout_oauth": {"get": {"operationId": "get_proconnect_logout_o_auth_api", "responses": {"200": {"description": "Success"}}, "tags": ["proconnect"]}}, "/reports/": {"get": {"operationId": "list_reports", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "The field (and direction) on which sorting apply", "enum": ["reported_at", "-reported_at"], "in": "query", "name": "sort", "type": "string"}, {"in": "query", "name": "handled", "type": "boolean"}, {"enum": ["Dataset", "Reuse", "Discussion", "Organization", "Dataservice", "User"], "in": "query", "name": "subject_type", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ReportPage"}}}, "tags": ["reports"]}, "post": {"operationId": "create_report", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Report%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/Report%20%28read%29"}}, "400": {"description": "Validation error"}}, "tags": ["reports"]}}, "/reports/reasons/": {"get": {"operationId": "list_reports_reasons", "responses": {"200": {"description": "list of available reasons associated with their labels", "schema": {"type": "object"}}}, "tags": ["reports"]}}, "/reports/{report}/": {"get": {"operationId": "get_report", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Report%20%28read%29"}}}, "tags": ["reports"]}, "parameters": [{"in": "path", "name": "report", "required": true, "type": "string"}], "patch": {"operationId": "update_report", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Report%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Report%20%28read%29"}}, "400": {"description": "Validation error"}}, "tags": ["reports"]}}, "/reuses/": {"get": {"operationId": "list_reuses", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "The field (and direction) on which sorting apply", "enum": ["datasets", "followers", "views", "created", "last_modified", "title", "-datasets", "-followers", "-views", "-created", "-last_modified", "-title"], "in": "query", "name": "sort", "type": "string"}, {"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"in": "query", "name": "owner", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"format": "my-custom-format", "in": "query", "name": "organization_badge", "type": "string"}, {"enum": ["api", "application", "idea", "news_article", "paper", "post", "visualization", "hardware"], "in": "query", "name": "type", "type": "string"}, {"in": "query", "name": "dataset", "type": "string"}, {"in": "query", "name": "dataservice", "type": "string"}, {"collectionFormat": "multi", "in": "query", "items": {"type": "string"}, "name": "tag", "type": "array"}, {"enum": ["health", "transport_and_mobility", "housing_and_development", "food_and_agriculture", "culture_and_recreation", "economy_and_business", "environment_and_energy", "work_and_training", "politics_and_public_life", "safety_and_security", "education_and_research", "society_and_demography", "law_and_justice", "open_data_tools", "others"], "in": "query", "name": "topic", "type": "string"}, {"in": "query", "name": "private", "type": "boolean"}, {"in": "query", "name": "featured", "type": "boolean"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ReusePage"}}}, "tags": ["reuses"]}, "post": {"operationId": "create_reuse", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Reuse%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/Reuse%20%28read%29"}}, "400": {"description": "Validation error"}}, "tags": ["reuses"]}}, "/reuses/badges/": {"get": {"operationId": "available_reuse_badges", "responses": {"200": {"description": "Success"}}, "summary": "List all available reuse badges and their labels", "tags": ["reuses"]}}, "/reuses/recent.atom": {"get": {"operationId": "recent_reuses_atom_feed", "responses": {"200": {"description": "Success"}}, "tags": ["reuses"]}}, "/reuses/suggest/": {"get": {"operationId": "suggest_reuses", "parameters": [{"description": "The string to autocomplete/suggest", "in": "query", "name": "q", "required": true, "type": "string"}, {"default": 10, "description": "The amount of suggestion to fetch", "in": "query", "name": "size", "type": "integer"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/ReuseSuggestion"}, "type": "array"}}}, "summary": "Reuses suggest endpoint using mongoDB contains", "tags": ["reuses"]}}, "/reuses/topics/": {"get": {"operationId": "reuse_topics", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/ReuseTopic"}, "type": "array"}}}, "summary": "List all reuse topics", "tags": ["reuses"]}}, "/reuses/types/": {"get": {"operationId": "reuse_types", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/ReuseType"}, "type": "array"}}}, "summary": "List all reuse types", "tags": ["reuses"]}}, "/reuses/{id}/followers/": {"delete": {"description": "Returns the number of followers left after the operation", "operationId": "unfollow_reuse", "responses": {"200": {"description": "Success"}}, "summary": "Unfollow an object given its ID", "tags": ["reuses"]}, "get": {"operationId": "list_reuse_followers", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "Filter follower by user, it allows to check if a user is following the object", "in": "query", "name": "user", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/FollowPage"}}}, "summary": "List all followers for a given object", "tags": ["reuses"]}, "parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}], "post": {"description": "Returns the number of followers left after the operation", "operationId": "follow_reuse", "responses": {"200": {"description": "Success"}}, "summary": "Follow an object given its ID", "tags": ["reuses"]}}, "/reuses/{reuse}/": {"delete": {"operationId": "delete_reuse", "parameters": [{"default": false, "description": "Send formal legal notice with appeal information to owner (admin only)", "in": "query", "name": "send_legal_notice", "type": "boolean"}], "responses": {"204": {"description": "Reuse deleted"}, "404": {"description": "Reuse not found"}, "410": {"description": "Reuse has been deleted"}}, "summary": "Delete a given reuse", "tags": ["reuses"]}, "get": {"operationId": "get_reuse", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Reuse%20%28read%29"}}, "404": {"description": "Reuse not found"}, "410": {"description": "Reuse has been deleted"}}, "summary": "Fetch a given reuse", "tags": ["reuses"]}, "parameters": [{"description": "The reuse ID or slug", "in": "path", "name": "reuse", "required": true, "type": "string"}], "put": {"operationId": "update_reuse", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Reuse%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Reuse%20%28read%29"}}, "400": {"description": "Validation error: your data cannot be updated for now, we have been notified of the error and we will fix it as soon as possible."}, "404": {"description": "Reuse not found"}, "410": {"description": "Reuse has been deleted"}}, "summary": "Update a given reuse", "tags": ["reuses"]}}, "/reuses/{reuse}/badges/": {"post": {"operationId": "add_reuse_badge", "parameters": [{"description": "The reuse ID or slug", "in": "path", "name": "reuse", "required": true, "type": "string"}, {"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Badge%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Badge%20%28read%29"}}}, "summary": "Create a new badge for a given reuse", "tags": ["reuses"]}}, "/reuses/{reuse}/badges/{badge_kind}/": {"delete": {"operationId": "delete_reuse_badge", "parameters": [{"description": "The reuse ID or slug", "in": "path", "name": "reuse", "required": true, "type": "string"}], "responses": {"200": {"description": "Success"}}, "summary": "Delete a badge for a given reuse", "tags": ["reuses"]}, "parameters": [{"in": "path", "name": "badge_kind", "required": true, "type": "string"}]}, "/reuses/{reuse}/dataservices/": {"post": {"operationId": "reuse_add_dataservice", "parameters": [{"description": "The reuse ID or slug", "in": "path", "name": "reuse", "required": true, "type": "string"}, {"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/DataserviceReference"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "The dataservice is already present", "schema": {"$ref": "#/definitions/Reuse%20%28read%29"}}, "201": {"description": "Success", "schema": {"$ref": "#/definitions/Reuse%20%28read%29"}}, "403": {"description": "Not allowed to modify this reuse"}}, "summary": "Add a dataservice to a given reuse", "tags": ["reuses"]}}, "/reuses/{reuse}/datasets/": {"post": {"operationId": "reuse_add_dataset", "parameters": [{"description": "The reuse ID or slug", "in": "path", "name": "reuse", "required": true, "type": "string"}, {"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/DatasetReference"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "The dataset is already present", "schema": {"$ref": "#/definitions/Reuse%20%28read%29"}}, "201": {"description": "Success", "schema": {"$ref": "#/definitions/Reuse%20%28read%29"}}, "403": {"description": "Not allowed to modify this reuse"}}, "summary": "Add a dataset to a given reuse", "tags": ["reuses"]}}, "/reuses/{reuse}/featured/": {"delete": {"operationId": "unfeature_reuse", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Reuse%20%28read%29"}}}, "summary": "Unmark a reuse as featured", "tags": ["reuses"]}, "parameters": [{"description": "The reuse ID or slug", "in": "path", "name": "reuse", "required": true, "type": "string"}], "post": {"operationId": "feature_reuse", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Reuse%20%28read%29"}}}, "summary": "Mark a reuse as featured", "tags": ["reuses"]}}, "/reuses/{reuse}/image/": {"parameters": [{"description": "The reuse ID or slug", "in": "path", "name": "reuse", "required": true, "type": "string"}], "post": {"consumes": ["multipart/form-data"], "operationId": "reuse_image", "parameters": [{"description": "The image to upload", "in": "formData", "name": "file", "required": true, "type": "file"}, {"description": "An optional crop box, as `left,upper,right,lower` pixel coordinates", "in": "formData", "name": "bbox", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UploadedImage"}}}, "summary": "Upload a new reuse image", "tags": ["reuses"]}}, "/site/": {"get": {"operationId": "get_site", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Site%20%28read%29"}}}, "summary": "Site-wide variables", "tags": ["site"]}, "patch": {"operationId": "set_site", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Site%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Site%20%28read%29"}}}, "tags": ["site"]}}, "/site/catalog": {"get": {"operationId": "get_site_rdf_catalog", "parameters": [{"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"description": "The field (and direction) on which sorting apply", "enum": ["title", "created", "last_update", "reuses", "followers", "views", "-title", "-created", "-last_update", "-reuses", "-followers", "-views"], "in": "query", "name": "sort", "type": "string"}, {"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"collectionFormat": "multi", "in": "query", "items": {"type": "string"}, "name": "tag", "type": "array"}, {"in": "query", "name": "license", "type": "string"}, {"description": "If set to true, it will filter on featured datasets only. If set to false, it will exclude featured datasets.", "in": "query", "name": "featured", "type": "boolean"}, {"in": "query", "name": "geozone", "type": "string"}, {"in": "query", "name": "granularity", "type": "string"}, {"in": "query", "name": "temporal_coverage", "type": "string"}, {"enum": ["open", "open_with_account", "restricted"], "in": "query", "name": "access_type", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"enum": ["pivotal-data", "spd", "inspire", "hvd", "sl", "sr"], "in": "query", "name": "badge", "type": "string"}, {"enum": ["public-service", "certified", "association", "company", "local-authority"], "in": "query", "name": "organization_badge", "type": "string"}, {"in": "query", "name": "owner", "type": "string"}, {"description": "(beta, subject to change/be removed)", "in": "query", "name": "followed_by", "type": "string"}, {"in": "query", "name": "format", "type": "string"}, {"in": "query", "name": "schema", "type": "string"}, {"in": "query", "name": "schema_version", "type": "string"}, {"in": "query", "name": "topic", "type": "string"}, {"in": "query", "name": "credit", "type": "string"}, {"in": "query", "name": "dataservice", "type": "string"}, {"in": "query", "name": "reuse", "type": "string"}, {"description": "If set to true, it will filter on archived datasets only. If set to false, it will exclude archived datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "archived", "type": "boolean"}, {"description": "If set to true, it will filter on deleted datasets only. If set to false, it will exclude deleted datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "deleted", "type": "boolean"}, {"description": "If set to true, it will filter on private datasets only. If set to false, it will exclude private datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "private", "type": "boolean"}, {"default": 100, "description": "The page size", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}], "responses": {"200": {"description": "Success"}}, "summary": "Root RDF endpoint with content negociation handling", "tags": ["site"]}}, "/site/catalog.{_format}": {"get": {"description": "Filtering, sorting and paginating abilities apply to the datasets elements.", "operationId": "get_site_rdf_catalog_format", "parameters": [{"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"description": "The field (and direction) on which sorting apply", "enum": ["title", "created", "last_update", "reuses", "followers", "views", "-title", "-created", "-last_update", "-reuses", "-followers", "-views"], "in": "query", "name": "sort", "type": "string"}, {"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"collectionFormat": "multi", "in": "query", "items": {"type": "string"}, "name": "tag", "type": "array"}, {"in": "query", "name": "license", "type": "string"}, {"description": "If set to true, it will filter on featured datasets only. If set to false, it will exclude featured datasets.", "in": "query", "name": "featured", "type": "boolean"}, {"in": "query", "name": "geozone", "type": "string"}, {"in": "query", "name": "granularity", "type": "string"}, {"in": "query", "name": "temporal_coverage", "type": "string"}, {"enum": ["open", "open_with_account", "restricted"], "in": "query", "name": "access_type", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"enum": ["pivotal-data", "spd", "inspire", "hvd", "sl", "sr"], "in": "query", "name": "badge", "type": "string"}, {"enum": ["public-service", "certified", "association", "company", "local-authority"], "in": "query", "name": "organization_badge", "type": "string"}, {"in": "query", "name": "owner", "type": "string"}, {"description": "(beta, subject to change/be removed)", "in": "query", "name": "followed_by", "type": "string"}, {"in": "query", "name": "format", "type": "string"}, {"in": "query", "name": "schema", "type": "string"}, {"in": "query", "name": "schema_version", "type": "string"}, {"in": "query", "name": "topic", "type": "string"}, {"in": "query", "name": "credit", "type": "string"}, {"in": "query", "name": "dataservice", "type": "string"}, {"in": "query", "name": "reuse", "type": "string"}, {"description": "If set to true, it will filter on archived datasets only. If set to false, it will exclude archived datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "archived", "type": "boolean"}, {"description": "If set to true, it will filter on deleted datasets only. If set to false, it will exclude deleted datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "deleted", "type": "boolean"}, {"description": "If set to true, it will filter on private datasets only. If set to false, it will exclude private datasets. User must be authenticated and results are limited to user visibility", "in": "query", "name": "private", "type": "boolean"}, {"default": 100, "description": "The page size", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}], "responses": {"200": {"description": "Success"}}, "summary": "Return the RDF catalog in the requested format", "tags": ["site"]}, "parameters": [{"in": "path", "name": "_format", "required": true, "type": "string"}]}, "/site/context.jsonld": {"get": {"operationId": "get_site_json_ld_context", "responses": {"200": {"description": "Success"}}, "tags": ["site"]}}, "/site/data.{_format}": {"get": {"operationId": "get_site_data_portal", "responses": {"200": {"description": "Success"}}, "summary": "Root RDF endpoint with content negociation handling", "tags": ["site"]}, "parameters": [{"in": "path", "name": "_format", "required": true, "type": "string"}]}, "/site/dataservices.csv": {"get": {"operationId": "get_site_dataservices_csv", "responses": {"200": {"description": "Success"}}, "tags": ["site"]}}, "/site/datasets.csv": {"get": {"operationId": "get_site_datasets_csv", "responses": {"200": {"description": "Success"}}, "tags": ["site"]}}, "/site/harvests.csv": {"get": {"operationId": "get_site_harvests_csv", "responses": {"200": {"description": "Success"}}, "tags": ["site"]}}, "/site/organizations.csv": {"get": {"operationId": "get_site_organizations_csv", "responses": {"200": {"description": "Success"}}, "tags": ["site"]}}, "/site/resources.csv": {"get": {"operationId": "get_site_resources_csv", "responses": {"200": {"description": "Success"}}, "tags": ["site"]}}, "/site/reuses.csv": {"get": {"operationId": "get_site_reuses_csv", "responses": {"200": {"description": "Success"}}, "tags": ["site"]}}, "/site/tags.csv": {"get": {"operationId": "get_site_tags_csv", "responses": {"200": {"description": "Success"}}, "tags": ["site"]}}, "/spatial/coverage/{level}/": {"get": {"operationId": "spatial_coverage", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/GeoJSONFeatureCollection"}, "type": "array"}}}, "summary": "List each zone for a given level with their datasets count", "tags": ["spatial"]}, "parameters": [{"in": "path", "name": "level", "required": true, "type": "string"}]}, "/spatial/granularities/": {"get": {"operationId": "spatial_granularities", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/GeoGranularity"}, "type": "array"}}}, "summary": "List all known spatial granularities", "tags": ["spatial"]}}, "/spatial/levels/": {"get": {"operationId": "spatial_levels", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/GeoLevel"}, "type": "array"}}}, "summary": "List all known levels", "tags": ["spatial"]}}, "/spatial/zone/{id}/": {"get": {"operationId": "spatial_zone", "parameters": [{"description": "A zone identifier", "in": "path", "name": "id", "required": true, "type": "string"}], "responses": {"200": {"description": "Success"}}, "summary": "Fetch a zone", "tags": ["spatial"]}}, "/spatial/zone/{id}/datasets/": {"get": {"operationId": "spatial_zone_datasets", "parameters": [{"description": "A zone identifier", "in": "path", "name": "id", "required": true, "type": "string"}, {"description": "Append dynamic datasets", "in": "query", "name": "dynamic", "type": "boolean"}, {"default": 25, "description": "The amount of datasets to fetch", "in": "query", "name": "size", "type": "integer"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DatasetReference"}}}, "summary": "Fetch datasets for a given zone", "tags": ["spatial"]}}, "/spatial/zones/suggest/": {"get": {"operationId": "suggest_zones", "parameters": [{"description": "The string to autocomplete/suggest", "in": "query", "name": "q", "required": true, "type": "string"}, {"default": 10, "description": "The amount of suggestion to fetch", "in": "query", "name": "size", "type": "integer"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/TerritorySuggestion"}, "type": "array"}}}, "summary": "Geospatial zones suggest endpoint using mongoDB contains", "tags": ["spatial"]}}, "/spatial/zones/{ids}/": {"get": {"operationId": "spatial_zones", "parameters": [{"description": "A zone identifiers list (comma separated)", "in": "path", "name": "ids", "required": true, "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/GeoJSONFeatureCollection"}}}, "summary": "Fetch a zone list as GeoJSON", "tags": ["spatial"]}}, "/tags/suggest/": {"get": {"operationId": "suggest_tags", "parameters": [{"description": "The string to autocomplete/suggest", "in": "query", "name": "q", "required": true, "type": "string"}, {"default": 8, "description": "The amount of suggestion to fetch", "in": "query", "name": "size", "type": "integer"}], "responses": {"200": {"description": "Success"}}, "summary": "Suggest tags", "tags": ["tags"]}}, "/transfer/": {"get": {"operationId": "list_transfers", "parameters": [{"description": "ID of dataset, dataservice, reuse\u2026", "in": "query", "name": "subject", "type": "string"}, {"description": "Type of the transferred object", "enum": ["Dataset", "Reuse", "Dataservice", "Topic"], "in": "query", "name": "subject_type", "type": "string"}, {"description": "ID of user or organization", "in": "query", "name": "recipient", "type": "string"}, {"description": "Status of the transfer request", "enum": ["pending", "accepted", "refused"], "in": "query", "name": "status", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Transfer"}, "type": "array"}}}, "tags": ["transfer"]}, "post": {"operationId": "request_transfer", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/TransferRequest"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Transfer"}}}, "summary": "Initiate transfer request", "tags": ["transfer"]}}, "/transfer/{id}/": {"get": {"operationId": "get_transfer", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Transfer"}}}, "summary": "Fetch a transfer request given its identifier", "tags": ["transfer"]}, "parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}], "post": {"operationId": "respond_to_transfer", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/TransferResponse"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Transfer"}}}, "summary": "Respond to a transfer request", "tags": ["transfer"]}}, "/users/": {"get": {"operationId": "list_users", "parameters": [{"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"description": "The field (and direction) on which sorting apply", "enum": ["last_name", "first_name", "datasets", "reuses", "followers", "views", "created", "-last_name", "-first_name", "-datasets", "-reuses", "-followers", "-views", "-created"], "in": "query", "name": "sort", "type": "string"}, {"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UserPage"}}}, "summary": "List all users", "tags": ["users"]}, "post": {"operationId": "create_user", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/User%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/User%20%28read%29"}}, "400": {"description": "Validation error"}}, "summary": "Create a new user", "tags": ["users"]}}, "/users/roles/": {"get": {"operationId": "user_roles", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/UserRole"}, "type": "array"}}}, "summary": "List all possible user roles", "tags": ["users"]}}, "/users/suggest/": {"get": {"operationId": "suggest_users", "parameters": [{"description": "The string to autocomplete/suggest", "in": "query", "name": "q", "required": true, "type": "string"}, {"default": 10, "description": "The amount of suggestion to fetch (between 1 and 20)", "in": "query", "name": "size", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/UserSuggestion"}, "type": "array"}}}, "summary": "Suggest users", "tags": ["users"]}}, "/users/{id}/followers/": {"delete": {"description": "Returns the number of followers left after the operation", "operationId": "unfollow_user", "responses": {"200": {"description": "Success"}}, "summary": "Unfollow an object given its ID", "tags": ["users"]}, "get": {"operationId": "list_user_followers", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "Filter follower by user, it allows to check if a user is following the object", "in": "query", "name": "user", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/FollowPage"}}}, "summary": "List all followers for a given object", "tags": ["users"]}, "parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}], "post": {"operationId": "follow_user", "responses": {"403": {"description": "When trying to follow yourself"}}, "summary": "Follow a user given its ID", "tags": ["users"]}}, "/users/{user}/": {"delete": {"operationId": "delete_user", "parameters": [{"default": false, "description": "Send formal legal notice with appeal information to owner (admin only)", "in": "query", "name": "send_legal_notice", "type": "boolean"}, {"default": false, "description": "Do not send the simple deletion notification email. Note: automatically set to True when send_legal_notice=True to avoid sending duplicate emails.", "in": "query", "name": "no_mail", "type": "boolean"}, {"default": false, "description": "Delete comments posted by the user upon user deletion", "in": "query", "name": "delete_comments", "type": "boolean"}], "responses": {"204": {"description": "Object deleted"}, "403": {"description": "When trying to delete yourself"}, "404": {"description": "User not found"}, "410": {"description": "User is not active or has been deleted"}}, "summary": "Delete a user given its identifier", "tags": ["users"]}, "get": {"operationId": "get_user", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/User%20%28read%29"}}, "404": {"description": "User not found"}, "410": {"description": "User is not active or has been deleted"}}, "summary": "Get a user given its identifier", "tags": ["users"]}, "parameters": [{"in": "path", "name": "user", "required": true, "type": "string"}], "put": {"operationId": "update_user", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/User%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/User%20%28read%29"}}, "400": {"description": "Validation error"}, "404": {"description": "User not found"}, "410": {"description": "User is not active or has been deleted"}}, "summary": "Update a user given its identifier", "tags": ["users"]}}, "/users/{user}/avatar/": {"parameters": [{"in": "path", "name": "user", "required": true, "type": "string"}], "post": {"consumes": ["multipart/form-data"], "operationId": "user_avatar", "parameters": [{"description": "The image to upload", "in": "formData", "name": "file", "required": true, "type": "file"}, {"description": "An optional crop box, as `left,upper,right,lower` pixel coordinates", "in": "formData", "name": "bbox", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UploadedImage"}}}, "summary": "Upload a new avatar for a given user", "tags": ["users"]}}, "/users/{user}/contacts/": {"get": {"operationId": "get_user_contact_point", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"in": "query", "name": "owner", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ContactPointPage"}}}, "summary": "List all user contact points", "tags": ["users"]}, "parameters": [{"in": "path", "name": "user", "required": true, "type": "string"}]}, "/users/{user}/rotate_password/": {"parameters": [{"in": "path", "name": "user", "required": true, "type": "string"}], "post": {"operationId": "rotate_user_password", "responses": {"204": {"description": "Password rotation requested"}, "404": {"description": "User not found"}}, "summary": "Force a password rotation on the user's next login and reset their current sessions", "tags": ["users"]}}, "/visualizations/": {"get": {"operationId": "list_visualizations", "parameters": [{"default": 1, "description": "The page to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "exclusiveMinimum": true, "in": "query", "minimum": 0, "name": "page_size", "type": "integer"}, {"description": "The field (and direction) on which sorting apply", "enum": ["created", "last_modified", "title", "-created", "-last_modified", "-title"], "in": "query", "name": "sort", "type": "string"}, {"in": "query", "name": "owner", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"in": "query", "name": "private", "type": "boolean"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ChartPage"}}}, "summary": "List or search all visualizations", "tags": ["visualizations"]}, "post": {"operationId": "create_visualization", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Chart%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/Chart%20%28read%29"}}, "400": {"description": "Validation error"}}, "summary": "Create a new visualization", "tags": ["visualizations"]}}, "/visualizations/{visualization}/": {"delete": {"operationId": "delete_visualization", "responses": {"204": {"description": "Visualization deleted"}}, "summary": "Delete a visualization given its identifier", "tags": ["visualizations"]}, "get": {"operationId": "get_visualization", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Chart%20%28read%29"}}}, "summary": "Get a visualization given its identifier", "tags": ["visualizations"]}, "parameters": [{"description": "The visualization ID or slug", "in": "path", "name": "visualization", "required": true, "type": "string"}], "patch": {"operationId": "update_visualization", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Chart%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Chart%20%28read%29"}}, "400": {"description": "Validation error"}}, "summary": "Update a visualization given its identifier", "tags": ["visualizations"]}}, "/visualizations/{visualization}/image/": {"parameters": [{"description": "The visualization ID or slug", "in": "path", "name": "visualization", "required": true, "type": "string"}], "post": {"consumes": ["multipart/form-data"], "operationId": "visualization_image", "parameters": [{"description": "The image to upload", "in": "formData", "name": "file", "required": true, "type": "file"}, {"description": "An optional crop box, as `left,upper,right,lower` pixel coordinates", "in": "formData", "name": "bbox", "type": "string"}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UploadedImage"}}}, "summary": "Upload a new visualization image", "tags": ["visualizations"]}}, "/workers/jobs/": {"get": {"operationId": "list_jobs", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/PeriodicTask%20%28read%29"}, "type": "array"}}}, "summary": "List all scheduled jobs", "tags": ["workers"]}, "post": {"operationId": "post_jobs_api", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/PeriodicTask%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/PeriodicTask%20%28read%29"}}}, "summary": "Create a new scheduled job", "tags": ["workers"]}}, "/workers/jobs/schedulables/": {"get": {"operationId": "get_jobs_reference_api", "responses": {"200": {"description": "Success", "schema": {"items": {"type": "string"}, "type": "array"}}}, "summary": "List all schedulable jobs", "tags": ["workers"]}}, "/workers/jobs/{id}/": {"delete": {"operationId": "delete_job_api", "responses": {"204": {"description": "Successfuly deleted"}}, "summary": "Delete a single scheduled job", "tags": ["workers"]}, "get": {"operationId": "get_job_api", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/PeriodicTask%20%28read%29"}}}, "summary": "Fetch a single scheduled job", "tags": ["workers"]}, "parameters": [{"description": "A job ID", "in": "path", "name": "id", "required": true, "type": "string"}], "put": {"operationId": "put_job_api", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/PeriodicTask%20%28write%29"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/PeriodicTask%20%28read%29"}}}, "summary": "Update a single scheduled job", "tags": ["workers"]}}, "/workers/tasks/{id}/": {"get": {"operationId": "get_task_api", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Task"}}}, "summary": "Get a tasks status given its ID", "tags": ["workers"]}, "parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}]}}, "produces": ["application/json"], "responses": {"MaskError": {"description": "When any error occurs on mask"}, "ParseError": {"description": "When a mask can't be parsed"}, "PermissionDenied": {"description": "Error occuring when the user does not have the required permissions", "schema": {"$ref": "#/definitions/Error"}}, "UnauthorizedFileType": {"description": "Error occuring when the user try to upload a non-allowed file type", "schema": {"$ref": "#/definitions/Error"}}, "UploadError": {"description": "API Upload response handler", "schema": {"$ref": "#/definitions/UploadStatus"}}, "UploadProgress": {"description": "API Upload response handler", "schema": {"$ref": "#/definitions/UploadStatus"}}, "UploadStatus": {"description": "API Upload response handler", "schema": {"$ref": "#/definitions/UploadStatus"}}, "ValidationError": {"description": "Error returned when validation failed", "schema": {"$ref": "#/definitions/ValidationError"}}, "ValueError": {"description": "A generic value error", "schema": {"$ref": "#/definitions/Error"}}}, "schemes": ["https"], "securityDefinitions": {"apikey": {"in": "header", "name": "X-API-KEY", "type": "apiKey"}}, "swagger": "2.0", "tags": [{"description": "Site global namespace", "name": "site"}, {"description": "Proconnect related operations", "name": "proconnect"}, {"description": "Dataset related operations", "name": "datasets"}, {"description": "Reuse related operations", "name": "reuses"}, {"description": "Access type related operations", "name": "access_type"}, {"description": "Spatial references", "name": "spatial"}, {"description": "User related operations", "name": "users"}, {"description": "Connected user related operations", "name": "me"}, {"description": "Dataservices related operations (beta)", "name": "dataservices"}, {"description": "Visualizations related operations", "name": "visualizations"}, {"description": "Discussion related operations", "name": "discussions"}, {"description": "Organization related operations", "name": "organizations"}, {"description": "Asynchronous workers related operations", "name": "workers"}, {"description": "User reported objects related operations (beta)", "name": "reports"}, {"description": "Tags related operations", "name": "tags"}, {"description": "Posts related operations", "name": "posts"}, {"description": "Contact points related operations", "name": "contacts"}, {"name": "transfer"}, {"description": "Notifications API", "name": "notifications"}, {"description": "Avatars", "name": "avatars"}, {"description": "G\u00e9oplateforme related operations", "name": "geopf"}, {"description": "Harvest related operations", "name": "harvest"}]}