{"basePath": "/api/1", "consumes": ["application/json"], "definitions": {"Activity": {"properties": {"actor": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The user who performed the action", "readOnly": true}, "created_at": {"description": "When the action has been performed", "format": "date-time", "readOnly": true, "type": "string"}, "extras": {"description": "Extras attributes as key-value pairs", "type": "object"}, "icon": {"description": "The icon of the activity", "type": "string"}, "key": {"description": "The key of the activity", "type": "string"}, "label": {"description": "The label of the activity", "type": "string"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "The organization who performed the action", "readOnly": true}, "related_to": {"description": "The activity target name", "type": "string"}, "related_to_id": {"description": "The activity target object identifier", "type": "string"}, "related_to_kind": {"description": "The activity target object class name", "type": "string"}, "related_to_url": {"description": "The activity target model", "type": "string"}}, "required": ["icon", "key", "label", "related_to", "related_to_id", "related_to_kind", "related_to_url"], "type": "object"}, "ActivityPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Activity"}, "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"}, "ApiKey": {"properties": {"apikey": {"description": "The user API Key", "readOnly": true, "type": "string"}}, "type": "object"}, "Badge": {"properties": {"kind": {"description": "Kind of badge (certified, etc), specific to each model", "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"}, "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"}}, "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": {"properties": {"email": {"description": "The contact point's email", "type": "string"}, "id": {"description": "The contact point's identifier", "readOnly": true, "type": "string"}, "name": {"description": "The contact point's name", "type": "string"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "The producer organization"}, "owner": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The user information"}}, "required": ["email", "name"], "type": "object", "x-mask": "{id,name,email}"}, "ContactPointPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/ContactPoint"}, "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,name,email},*}"}, "Crontab": {"properties": {"day_of_month": {"default": "*", "description": "Cron expression for day of month", "type": "string"}, "day_of_week": {"default": "*", "description": "Cron expression for day of week", "type": "string"}, "hour": {"default": "*", "description": "Cron expression for hour", "type": "string"}, "minute": {"default": "*", "description": "Cron expression for minute", "type": "string"}, "month_of_year": {"default": "*", "description": "Cron expression for month of year", "type": "string"}}, "required": ["day_of_month", "day_of_week", "hour", "minute", "month_of_year"], "type": "object"}, "Dataservice (read)": {"properties": {"acronym": {"maxLength": 128, "type": "string"}, "archived_at": {"format": "date-time", "readOnly": true, "type": "string"}, "authorization_request_url": {"type": "string"}, "availability": {"example": "99.99", "maximum": 100, "minimum": 0, "type": "number"}, "base_api_url": {"type": "string"}, "contact_point": {"$ref": "#/definitions/ContactPoint"}, "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": {"description": "In markdown", "type": "string"}, "endpoint_description_url": {"type": "string"}, "extras": {"type": "object"}, "format": {"enum": ["REST", "WMS", "WSL"], "example": "REST", "type": "string"}, "harvest": {"allOf": [{"$ref": "#/definitions/HarvestMetadata (read)"}], "readOnly": true}, "has_token": {"type": "boolean"}, "id": {"readOnly": true, "type": "string"}, "is_restricted": {"type": "boolean"}, "license": {"description": "The ID of the license", "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."}, "private": {"description": "Is the dataservice private to the owner or the organization", "type": "boolean"}, "rate_limiting": {"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"}, "title": {"example": "My awesome API", "type": "string"}}, "required": ["created_at", "id", "metadata_modified_at", "slug", "title"], "type": "object"}, "Dataservice (write)": {"properties": {"acronym": {"maxLength": 128, "type": "string"}, "authorization_request_url": {"type": "string"}, "availability": {"example": "99.99", "maximum": 100, "minimum": 0, "type": "number"}, "base_api_url": {"type": "string"}, "contact_point": {"description": "ID of the reference", "type": "string"}, "datasets": {"items": {"description": "ID of the reference", "type": "string"}, "type": "array"}, "deleted_at": {"format": "date-time", "type": "string"}, "description": {"description": "In markdown", "type": "string"}, "endpoint_description_url": {"type": "string"}, "extras": {"type": "object"}, "format": {"enum": ["REST", "WMS", "WSL"], "example": "REST", "type": "string"}, "has_token": {"type": "boolean"}, "is_restricted": {"type": "boolean"}, "license": {"description": "The ID of the license", "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"}, "tags": {"items": {"type": "string"}, "type": "array"}, "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"}, "Dataset": {"properties": {"acronym": {"description": "An optional dataset acronym", "type": "string"}, "archived": {"description": "The archival date if archived", "format": "date-time", "type": "string"}, "badges": {"description": "The dataset badges", "items": {"$ref": "#/definitions/Badge"}, "readOnly": true, "type": "array"}, "community_resources": {"items": {"allOf": [{"$ref": "#/definitions/CommunityResource"}], "description": "The dataset community submitted resources"}, "type": "array"}, "contact_point": {"allOf": [{"$ref": "#/definitions/ContactPoint"}], "description": "The dataset's contact points"}, "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"}, "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": ["unknown", "punctual", "continuous", "hourly", "fourTimesADay", "threeTimesADay", "semidaily", "daily", "fourTimesAWeek", "threeTimesAWeek", "semiweekly", "weekly", "biweekly", "threeTimesAMonth", "semimonthly", "monthly", "bimonthly", "quarterly", "threeTimesAYear", "semiannual", "annual", "biennial", "triennial", "quadrennial", "quinquennial", "decennial", "irregular", "never", "notPlanned"], "example": "unknown", "type": "string"}, "frequency_date": {"description": "Next expected update date, you will be notified once that date is reached.", "format": "date-time", "type": "string"}, "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", "type": "string"}, "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", "type": "string"}, "spatial": {"allOf": [{"$ref": "#/definitions/SpatialCoverage"}], "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 URI", "type": "string"}}, "required": ["created_at", "description", "frequency", "last_modified", "last_update", "page", "slug", "title", "uri"], "type": "object", "x-mask": "{id,title,acronym,slug,description,created_at,last_modified,deleted,private,tags,badges,resources,frequency,frequency_date,extras,harvest,metrics,organization,owner,schema,temporal_coverage,spatial,license,uri,page,last_update,archived,quality,internal,contact_point}"}, "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"}, "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,title,acronym,slug,description,created_at,last_modified,deleted,private,tags,badges,resources,frequency,frequency_date,extras,harvest,metrics,organization,owner,schema,temporal_coverage,spatial,license,uri,page,last_update,archived,quality,internal,contact_point},*}"}, "DatasetPreview": {"properties": {"acronym": {"description": "An optional dataset acronym", "type": "string"}, "archived": {"description": "The archival date if archived", "format": "date-time", "type": "string"}, "badges": {"description": "The dataset badges", "items": {"$ref": "#/definitions/Badge"}, "readOnly": true, "type": "array"}, "community_resources": {"items": {"allOf": [{"$ref": "#/definitions/CommunityResource"}], "description": "The dataset community submitted resources"}, "type": "array"}, "contact_point": {"allOf": [{"$ref": "#/definitions/ContactPoint"}], "description": "The dataset's contact points"}, "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"}, "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": ["unknown", "punctual", "continuous", "hourly", "fourTimesADay", "threeTimesADay", "semidaily", "daily", "fourTimesAWeek", "threeTimesAWeek", "semiweekly", "weekly", "biweekly", "threeTimesAMonth", "semimonthly", "monthly", "bimonthly", "quarterly", "threeTimesAYear", "semiannual", "annual", "biennial", "triennial", "quadrennial", "quinquennial", "decennial", "irregular", "never", "notPlanned"], "example": "unknown", "type": "string"}, "frequency_date": {"description": "Next expected update date, you will be notified once that date is reached.", "format": "date-time", "type": "string"}, "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": "string"}, "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", "type": "string"}, "spatial": {"allOf": [{"$ref": "#/definitions/SpatialCoverage"}], "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 URI (fake)", "type": "string"}}, "required": ["created_at", "description", "frequency", "last_modified", "last_update", "slug", "title"], "type": "object"}, "DatasetReference": {"allOf": [{"$ref": "#/definitions/BaseReference"}, {"properties": {"acronym": {"description": "An optional dataset acronym", "readOnly": true, "type": "string"}, "page": {"description": "The web page URL for this dataset", "readOnly": true, "type": "string"}, "title": {"description": "The dataset title", "readOnly": true, "type": "string"}, "uri": {"description": "The API URI for this dataset", "readOnly": true, "type": "string"}}, "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 web page URL for this dataset", "type": "string"}, "slug": {"description": "The dataset permalink string", "type": "string"}, "title": {"description": "The dataset title", "type": "string"}}, "type": "object"}, "Discussion": {"discriminator": "class", "properties": {"class": {"description": "The object class", "type": "string"}, "closed": {"description": "The discussion closing date", "format": "date-time", "type": "string"}, "closed_by": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The user who closed the discussion"}, "created": {"description": "The discussion creation date", "format": "date-time", "type": "string"}, "discussion": {"$ref": "#/definitions/DiscussionMessage"}, "extras": {"description": "Extra attributes as key-value pairs", "type": "object"}, "id": {"description": "The discussion identifier", "type": "string"}, "spam": {"$ref": "#/definitions/Spam"}, "subject": {"allOf": [{"$ref": "#/definitions/ModelReference"}], "description": "The discussion target object"}, "title": {"description": "The discussion title", "type": "string"}, "url": {"description": "The discussion API URI", "type": "string"}, "user": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The discussion author"}}, "required": ["class"], "type": "object"}, "DiscussionMessage": {"properties": {"content": {"description": "The message body", "type": "string"}, "posted_by": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The message author"}, "posted_on": {"description": "The message posting date", "format": "date-time", "type": "string"}, "spam": {"$ref": "#/definitions/Spam"}}, "type": "object"}, "DiscussionPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Discussion"}, "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"}, "DiscussionResponse": {"properties": {"close": {"description": "Is this a closing response. Only subject owner can close", "type": "boolean"}, "comment": {"description": "The comment to submit", "type": "string"}}, "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"}, "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": {"properties": {"follower": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The follower", "readOnly": true}, "id": {"description": "The follow object technical ID", "readOnly": true, "type": "string"}, "since": {"description": "The date from which the user started following", "format": "date-time", "readOnly": true, "type": "string"}}, "type": "object"}, "FollowPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Follow"}, "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"}, "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"}, "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"}, "HarvestDatasetMetadata": {"properties": {"archived": {"description": "The reason the dataset has been archived", "type": "string"}, "archived_at": {"description": "The archive date", "format": "date-time", "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"}, "domain": {"description": "The harvested domain", "type": "string"}, "last_update": {"description": "The 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"}, "uri": {"description": "The dataset harveted uri", "type": "string"}}, "type": "object"}, "HarvestError": {"properties": {"level": {"type": "string"}, "message": {"type": "string"}}, "required": ["level", "message"], "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": "string"}, "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": {"properties": {"args": {"default": [], "description": "The item positional arguments", "items": {"type": "string"}, "type": "array"}, "created": {"description": "The item creation date", "format": "date-time", "type": "string"}, "dataservice": {"allOf": [{"$ref": "#/definitions/Dataservice (read)"}], "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": {"$ref": "#/definitions/HarvestError"}, "type": "array"}, "kwargs": {"default": {}, "description": "The item keyword arguments", "type": "object"}, "logs": {"description": "The item logs", "items": {"$ref": "#/definitions/HarvestError"}, "type": "array"}, "remote_id": {"description": "The item remote ID to process", "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", "remote_id", "status"], "type": "object"}, "HarvestItemPreview": {"properties": {"args": {"default": [], "description": "The item positional arguments", "items": {"type": "string"}, "type": "array"}, "created": {"description": "The item creation date", "format": "date-time", "type": "string"}, "dataservice": {"allOf": [{"$ref": "#/definitions/Dataservice (read)"}], "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": {"$ref": "#/definitions/HarvestError"}, "type": "array"}, "kwargs": {"default": {}, "description": "The item keyword arguments", "type": "object"}, "logs": {"description": "The item logs", "items": {"$ref": "#/definitions/HarvestError"}, "type": "array"}, "remote_id": {"description": "The item remote ID to process", "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", "remote_id", "status"], "type": "object"}, "HarvestJob": {"properties": {"created": {"description": "The job creation date", "format": "date-time", "type": "string"}, "ended": {"description": "The job end date", "format": "date-time", "type": "string"}, "errors": {"description": "The job initialization errors", "items": {"$ref": "#/definitions/HarvestError"}, "type": "array"}, "id": {"description": "The job execution ID", "type": "string"}, "items": {"description": "The job collected items", "items": {"$ref": "#/definitions/HarvestItem"}, "type": "array"}, "source": {"description": "The source owning the job", "type": "string"}, "started": {"description": "The job start date", "format": "date-time", "type": "string"}, "status": {"description": "The job status", "enum": ["pending", "initializing", "initialized", "processing", "done", "done-errors", "failed"], "example": "pending", "type": "string"}}, "required": ["created", "id", "source", "status"], "type": "object"}, "HarvestJobPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/HarvestJob"}, "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", "type": "string"}, "ended": {"description": "The job end date", "format": "date-time", "type": "string"}, "errors": {"description": "The job initialization errors", "items": {"$ref": "#/definitions/HarvestError"}, "type": "array"}, "id": {"description": "The job execution ID", "type": "string"}, "items": {"description": "The job collected items", "items": {"$ref": "#/definitions/HarvestItemPreview"}, "type": "array"}, "source": {"description": "The source owning the job", "type": "string"}, "started": {"description": "The job start date", "format": "date-time", "type": "string"}, "status": {"description": "The job status", "enum": ["pending", "initializing", "initialized", "processing", "done", "done-errors", "failed"], "example": "pending", "type": "string"}}, "required": ["created", "id", "source", "status"], "type": "object"}, "HarvestMetadata (read)": {"properties": {"archived_at": {"format": "date-time", "type": "string"}, "backend": {"type": "string"}, "created_at": {"description": "Date of the creation as provided by the harvested catalog", "format": "date-time", "type": "string"}, "domain": {"type": "string"}, "id": {"readOnly": true, "type": "string"}, "last_update": {"description": "Date of the last harvesting", "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"}}, "required": ["id"], "type": "object"}, "HarvestResourceMetadata": {"properties": {"created_at": {"description": "The resource harvested creation 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": {"properties": {"active": {"default": false, "description": "Is this source active", "type": "boolean"}, "autoarchive": {"default": true, "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": {"description": "The source unique identifier", "readOnly": true, "type": "string"}, "last_job": {"allOf": [{"$ref": "#/definitions/HarvestJob"}], "description": "The last job for this source", "readOnly": true}, "name": {"description": "The source display name", "type": "string"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "The producer organization"}, "owner": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The owner information"}, "schedule": {"description": "The source schedule (interval or cron expression)", "readOnly": true, "type": "string"}, "url": {"description": "The source base URL", "type": "string"}, "validation": {"allOf": [{"$ref": "#/definitions/HarvestSourceValidation"}], "description": "Has the source been validated", "readOnly": true}}, "required": ["active", "autoarchive", "backend", "created_at", "name", "url"], "type": "object"}, "HarvestSourcePage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/HarvestSource"}, "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"}, "HarvestSourceValidation": {"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 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"}, "Interval": {"properties": {"every": {"description": "The interval without unit", "type": "integer"}, "period": {"description": "The period/interval type", "enum": ["days", "hours", "minutes", "seconds", "microseconds"], "example": "days", "type": "string"}}, "required": ["every", "period"], "type": "object"}, "Job": {"properties": {"args": {"default": [], "description": "The job execution arguments", "items": {"type": "object"}, "type": "array"}, "crontab": {"$ref": "#/definitions/Crontab"}, "description": {"description": "The job description", "type": "string"}, "enabled": {"default": false, "description": "Is this job enabled", "type": "boolean"}, "id": {"description": "The job unique identifier", "readOnly": true, "type": "string"}, "interval": {"$ref": "#/definitions/Interval"}, "kwargs": {"default": {}, "description": "The job execution keyword arguments", "type": "object"}, "last_run_at": {"description": "The last job execution date", "format": "date-time", "readOnly": true, "type": "string"}, "last_run_id": {"description": "The last execution task id", "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", "purge-reuses", "test-error", "check-resources", "antivirus-scan-file", "purge-harvesters", "test-log", "purge-harvest-jobs", "test-low-queue", "export-csv", "purge-datasets", "harvest", "bind-tabular-dataservice", "compute-site-metrics", "send-frequency-reminder", "check-integrity", "purge-chunks", "piwik-bulk-track-api", "count-tags", "compute-geozones-metrics", "purge-organizations", "apigouvfr-load-apis", "update-datasets-reuses-metrics"], "example": "test-high-queue", "type": "string"}}, "required": ["name", "task"], "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"}, "McaptchaForm": {"properties": {"mcaptcha_token": {"description": "MCaptcha token", "type": "string"}}, "required": ["mcaptcha_token"], "type": "object"}, "Me": {"allOf": [{"$ref": "#/definitions/User"}, {"properties": {"apikey": {"description": "The user API Key", "readOnly": true, "type": "string"}}, "type": "object"}]}, "Member": {"properties": {"role": {"default": "editor", "description": "The member role in the organization", "enum": ["admin", "editor"], "example": "admin", "type": "string"}, "since": {"description": "The date the user joined the organization", "format": "date-time", "readOnly": true, "type": "string"}, "user": {"$ref": "#/definitions/MemberUserWithEmail"}}, "required": ["role"], "type": "object"}, "MemberUserWithEmail": {"allOf": [{"$ref": "#/definitions/UserReference"}, {"properties": {"email": {"description": "The user email (only present on show organization endpoint if the current user is member of the organization: admin or editor)", "readOnly": true, "type": "object"}, "last_login_at": {"description": "The user last connection date (only present on show organization endpoint if the current user is member of the organization: admin or editor)", "readOnly": true, "type": "object"}}, "type": "object"}]}, "MembershipRequest": {"properties": {"comment": {"description": "A request comment from the user", "type": "string"}, "created": {"description": "The request creation date", "format": "date-time", "readOnly": true, "type": "string"}, "id": {"readOnly": true, "type": "string"}, "status": {"description": "The current request status", "enum": ["pending", "accepted", "refused"], "example": "pending", "type": "string"}, "user": {"$ref": "#/definitions/MemberUserWithEmail"}}, "required": ["comment", "status"], "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": {"properties": {"created_on": {"description": "The notification creation datetime", "format": "date-time", "readOnly": true, "type": "string"}, "details": {"description": "Key-Value details depending on notification type", "readOnly": true, "type": "object"}, "type": {"description": "The notification type", "readOnly": true, "type": "string"}}, "type": "object"}, "Organization": {"properties": {"acronym": {"description": "The organization acronym", "type": "string"}, "badges": {"description": "The organization badges", "items": {"$ref": "#/definitions/Badge"}, "readOnly": true, "type": "array"}, "business_number_id": {"description": "The organization's business identification number.", "type": "string"}, "created_at": {"description": "The organization creation date", "format": "date-time", "readOnly": true, "type": "string"}, "deleted": {"description": "The organization deletion date if deleted", "format": "date-time", "readOnly": true, "type": "string"}, "description": {"description": "The organization description in Markdown", "format": "markdown", "type": "string"}, "extras": {"description": "Extras attributes as key-value pairs", "type": "object"}, "id": {"description": "The organization identifier", "type": "string"}, "last_modified": {"description": "The organization last modification date", "format": "date-time", "readOnly": true, "type": "string"}, "logo": {"description": "The organization logo URL", "type": "string"}, "logo_thumbnail": {"description": "The organization logo thumbnail URL. This is the square (100x100) and cropped version.", "type": "string"}, "members": {"items": {"allOf": [{"$ref": "#/definitions/Member"}], "description": "The organization members"}, "type": "array"}, "metrics": {"description": "The organization metrics", "readOnly": true, "type": "object"}, "name": {"description": "The organization name", "type": "string"}, "page": {"description": "The organization page URL", "readOnly": true, "type": "string"}, "slug": {"description": "The organization string used as permalink", "type": "string"}, "uri": {"description": "The organization API URI", "readOnly": true, "type": "string"}, "url": {"description": "The organization website URL", "type": "string"}}, "required": ["description", "id", "name", "slug"], "type": "object"}, "OrganizationPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Organization"}, "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"}, "OrganizationReference": {"allOf": [{"$ref": "#/definitions/BaseReference"}, {"properties": {"acronym": {"description": "The organization acronym", "type": "string"}, "badges": {"description": "The organization badges", "items": {"$ref": "#/definitions/Badge"}, "readOnly": true, "type": "array"}, "logo": {"description": "The organization logo URL", "type": "string"}, "logo_thumbnail": {"description": "The organization logo thumbnail URL. This is the square (100x100) and cropped version.", "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 string used as permalink", "type": "string"}, "uri": {"description": "The organization API URI", "readOnly": true, "type": "string"}}, "required": ["slug"], "type": "object"}]}, "OrganizationRole": {"properties": {"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"}, "Post": {"properties": {"body_type": {"default": "markdown", "description": "HTML or markdown body type", "type": "string"}, "content": {"description": "The post content in Markdown", "format": "markdown", "type": "string"}, "created_at": {"description": "The post creation date", "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": {"$ref": "#/definitions/Dataset"}, "type": "array"}, "headline": {"description": "The post headline", "type": "string"}, "id": {"description": "The post identifier", "type": "string"}, "image": {"description": "The post image", "readOnly": true, "type": "string"}, "last_modified": {"description": "The post last modification date", "format": "date-time", "readOnly": true, "type": "string"}, "name": {"description": "The post name", "type": "string"}, "owner": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The owner user", "readOnly": true}, "page": {"description": "The post page URL", "readOnly": true, "type": "string"}, "published": {"description": "The post publication date", "format": "date-time", "readOnly": true, "type": "string"}, "reuses": {"description": "The post reuses", "items": {"$ref": "#/definitions/Reuse (read)"}, "type": "array"}, "slug": {"description": "The post permalink string", "readOnly": true, "type": "string"}, "tags": {"description": "Some keywords to help in search", "items": {"type": "string"}, "type": "array"}, "uri": {"description": "The post API URI", "readOnly": true, "type": "string"}}, "required": ["content", "headline", "name"], "type": "object", "x-mask": "{*,datasets{id,title,acronym,uri,page},reuses{id,title,image,image_thumbnail,uri,page}}"}, "PostPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Post"}, "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"}, "PotentialSpam": {"properties": {"message": {"readOnly": true, "type": "string"}}, "type": "object"}, "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}, "id": {"readOnly": true, "type": "string"}, "message": {"type": "string"}, "reason": {"enum": ["explicit_content", "illegal_content", "others", "personal_data", "security", "spam"], "example": "explicit_content", "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"}}, "required": ["id", "reason", "reported_at"], "type": "object"}, "Report (write)": {"properties": {"message": {"type": "string"}, "reason": {"enum": ["explicit_content", "illegal_content", "others", "personal_data", "security", "spam"], "example": "explicit_content", "type": "string"}, "subject": {"$ref": "#/definitions/LazyReference"}}, "required": ["reason"], "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"}, "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"}, "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"}], "readOnly": true}, "readOnly": true, "type": "array"}, "created_at": {"format": "date-time", "readOnly": true, "type": "string"}, "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"}, "private": {"type": "boolean"}, "slug": {"maxLength": 255, "readOnly": true, "type": "string"}, "tags": {"items": {"type": "string"}, "type": "array"}, "title": {"type": "string"}, "topic": {"enum": ["affaires-internationales", "agriculture", "droit", "economie", "energie", "entreprises", "environnement", "gouvernement-et-secteur-public", "population-et-societe", "regions-et-developement-local", "sante", "science-et-technologie", "transports-charging-points", "transports-idacs", "transports", "vie-quotidienne", "donnees-geospatiales", "observation-de-la-terre-et-environnement", "meteo", "statistiques", "mobilite", "others"], "example": "affaires-internationales", "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"}, "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": ["affaires-internationales", "agriculture", "droit", "economie", "energie", "entreprises", "environnement", "gouvernement-et-secteur-public", "population-et-societe", "regions-et-developement-local", "sante", "science-et-technologie", "transports-charging-points", "transports-idacs", "transports", "vie-quotidienne", "donnees-geospatiales", "observation-de-la-terre-et-environnement", "meteo", "statistiques", "mobilite", "others"], "example": "affaires-internationales", "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"}, "ReuseReference": {"allOf": [{"$ref": "#/definitions/BaseReference"}, {"properties": {"archived": {"description": "Link to the API endpoint for this reuse", "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"}, "title": {"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 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"}, "Site": {"properties": {"id": {"description": "The Site unique identifier", "type": "string"}, "metrics": {"default": {}, "description": "The associated metrics", "type": "object"}, "title": {"description": "The site display title", "type": "string"}}, "required": ["id", "title"], "type": "object"}, "Spam": {"properties": {"status": {"description": "Status", "enum": ["not_checked", "potential_spam", "no_spam"], "example": "not_checked", "readOnly": true, "type": "string"}}, "type": "object"}, "SpatialCoverage": {"properties": {"geom": {"allOf": [{"$ref": "#/definitions/GeoJSON"}], "description": "A multipolygon for the whole coverage"}, "granularity": {"default": "other", "description": "The spatial/territorial granularity", "type": "string"}, "zones": {"description": "The covered zones identifiers", "items": {"type": "string"}, "type": "array"}}, "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": ["REVOKED", "PENDING", "RETRY", "STARTED", "RECEIVED", "FAILURE", "SUCCESS"], "example": "REVOKED", "readOnly": true, "type": "string"}, "traceback": {"description": "The execution traceback", "type": "string"}}, "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": ["end", "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"}, "Topic": {"properties": {"created_at": {"description": "The topic creation date", "format": "date-time", "readOnly": true, "type": "string"}, "datasets": {"description": "The topic datasets", "items": {"$ref": "#/definitions/Dataset"}, "type": "array"}, "description": {"description": "The topic description in Markdown", "format": "markdown", "type": "string"}, "extras": {"description": "Extras attributes as key-value pairs", "type": "object"}, "featured": {"description": "Is the topic featured", "type": "boolean"}, "id": {"description": "The topic identifier", "type": "string"}, "last_modified": {"description": "The topic last modification date", "format": "date-time", "readOnly": true, "type": "string"}, "name": {"description": "The topic name", "type": "string"}, "organization": {"allOf": [{"$ref": "#/definitions/OrganizationReference"}], "description": "The publishing organization", "readOnly": true}, "owner": {"allOf": [{"$ref": "#/definitions/UserReference"}], "description": "The owner user", "readOnly": true}, "page": {"description": "The topic page URL", "readOnly": true, "type": "string"}, "private": {"description": "Is the topic private", "type": "boolean"}, "reuses": {"description": "The topic reuses", "items": {"$ref": "#/definitions/Reuse (read)"}, "type": "array"}, "slug": {"description": "The topic permalink string", "readOnly": true, "type": "string"}, "spatial": {"allOf": [{"$ref": "#/definitions/SpatialCoverage"}], "description": "The spatial coverage"}, "tags": {"description": "Some keywords to help in search", "items": {"type": "string"}, "type": "array"}, "uri": {"description": "The topic API URI", "readOnly": true, "type": "string"}}, "required": ["description", "name", "tags"], "type": "object", "x-mask": "{*,datasets{id,title,uri,page},reuses{id,title,image,image_thumbnail,uri,page}}"}, "TopicPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/Topic"}, "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"}, "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}}, "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"}, "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": {"properties": {"about": {"description": "The user self description", "format": "markdown", "type": "string"}, "active": {"type": "boolean"}, "avatar": {"description": "The user avatar URL", "type": "string"}, "avatar_thumbnail": {"description": "The user avatar thumbnail URL. This is the square (500x500) and cropped version.", "type": "string"}, "email": {"description": "The user email", "readOnly": true, "type": "object"}, "first_name": {"description": "The user first name", "type": "string"}, "id": {"description": "The user identifier", "type": "string"}, "last_name": {"description": "The user last name", "type": "string"}, "metrics": {"description": "The user metrics", "readOnly": true, "type": "object"}, "organizations": {"description": "The organization the user belongs to", "items": {"$ref": "#/definitions/OrganizationReference"}, "type": "array"}, "page": {"description": "The user profile page URL", "readOnly": true, "type": "string"}, "roles": {"description": "Site wide user roles", "items": {"type": "string"}, "type": "array"}, "since": {"description": "The registeration date", "format": "date-time", "type": "string"}, "slug": {"description": "The user permalink string", "type": "string"}, "uri": {"description": "The user API URI", "type": "string"}, "website": {"description": "The user website", "type": "string"}}, "required": ["first_name", "id", "last_name", "since", "slug", "uri"], "type": "object"}, "UserPage": {"properties": {"data": {"description": "The page data", "items": {"$ref": "#/definitions/User"}, "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": "The user avatar URL", "type": "string"}, "avatar_thumbnail": {"description": "The user avatar thumbnail URL. This is the square (500x500) and cropped version.", "type": "string"}, "first_name": {"description": "The user first name", "readOnly": true, "type": "string"}, "last_name": {"description": "The user larst name", "readOnly": true, "type": "string"}, "page": {"description": "The user profile page URL", "readOnly": true, "type": "string"}, "slug": {"description": "The user permalink string", "type": "string"}, "uri": {"description": "The user API URI", "type": "string"}}, "required": ["slug", "uri"], "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"}, "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"}}, "type": "object"}}, "host": "data.public.lu", "info": {"description": "uData API", "title": "uData API", "version": "1.0"}, "paths": {"/activity": {"get": {"operationId": "activity", "parameters": [{"default": 1, "description": "The page to fetch", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "in": "query", "name": "page_size", "type": "integer"}, {"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"}, {"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 of 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"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ContactPoint"}}, "400": {"description": "Validation error"}}, "summary": "Creates a contact point", "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"}}, "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"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ContactPoint"}}, "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 display", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size", "in": "query", "name": "page_size", "type": "integer"}, {"description": "The field (and direction) on which sorting apply", "enum": ["title", "base_api_url", "-title", "-base_api_url"], "in": "query", "name": "sort", "type": "string"}, {"in": "query", "name": "q", "type": "string"}, {"in": "query", "name": "owner", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"in": "query", "name": "is_restricted", "type": "boolean"}, {"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/{dataservice}/": {"delete": {"operationId": "delete_dataservice", "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}/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", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "in": "query", "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 display", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size", "in": "query", "name": "page_size", "type": "integer"}, {"in": "query", "name": "tag", "type": "string"}, {"in": "query", "name": "license", "type": "string"}, {"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"}, {"in": "query", "name": "organization", "type": "string"}, {"in": "query", "name": "owner", "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": "dataservice", "type": "string"}], "responses": {"200": {"description": "Success"}}, "summary": "List or search all datasets using optimized manual serialization", "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": "-last_modified_internal", "description": "The sorting attribute", "in": "query", "name": "sort", "type": "string"}, {"default": 1, "description": "The page to fetch", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "in": "query", "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": {"operationId": "upload_community_resource", "parameters": [{"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": "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/original/": {"get": {"operationId": "list_datasets_original", "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 display", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size", "in": "query", "name": "page_size", "type": "integer"}, {"in": "query", "name": "tag", "type": "string"}, {"in": "query", "name": "license", "type": "string"}, {"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"}, {"in": "query", "name": "organization", "type": "string"}, {"in": "query", "name": "owner", "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": "dataservice", "type": "string"}, {"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"]}}, "/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/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", "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"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Badge"}}}, "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}/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}/check/": {"get": {"operationId": "check_dataset_resource", "responses": {"200": {"description": "Success"}}, "summary": "Checks that a resource's URL exists and returns metadata", "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"}]}, "/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": {"operationId": "upload_dataset_resource", "parameters": [{"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": [{"in": "formData", "name": "file", "type": "file"}, {"in": "formData", "name": "uuid", "type": "string"}, {"in": "formData", "name": "filename", "type": "string"}, {"in": "formData", "name": "partindex", "type": "integer"}, {"in": "formData", "name": "partbyteoffset", "type": "integer"}, {"in": "formData", "name": "totalparts", "type": "integer"}, {"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 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": [{"in": "formData", "name": "file", "type": "file"}, {"in": "formData", "name": "uuid", "type": "string"}, {"in": "formData", "name": "filename", "type": "string"}, {"in": "formData", "name": "partindex", "type": "integer"}, {"in": "formData", "name": "partbyteoffset", "type": "integer"}, {"in": "formData", "name": "totalparts", "type": "integer"}, {"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 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", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "in": "query", "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": "-created", "description": "The field (and direction) on which sorting apply", "enum": ["created", "title", "closed", "discussion.posted_on", "-created", "-title", "-closed", "-discussion.posted_on"], "in": "query", "name": "sort", "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"}, {"default": 1, "description": "The page to fetch", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "in": "query", "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/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": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Discussion"}}}, "summary": "Create a new Discussion", "tags": ["discussions"]}}, "/discussions/{id}/": {"delete": {"operationId": "delete_discussion", "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"}}}, "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"}}, "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"]}}, "/discussions/{id}/comments/{cidx}": {"delete": {"operationId": "delete_discussion_comment", "responses": {"403": {"description": "Not allowed to delete this comment"}}, "summary": "Delete a comment given its index", "tags": ["discussions"]}, "parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}, {"in": "path", "name": "cidx", "required": true, "type": "integer"}]}, "/discussions/{id}/comments/{cidx}/spam": {"delete": {"operationId": "unspam", "responses": {"200": {"description": "Success"}}, "summary": "Mark a potential spam as no spam", "tags": ["discussions"]}, "parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}, {"in": "path", "name": "cidx", "required": true, "type": "integer"}]}, "/discussions/{id}/spam/": {"delete": {"operationId": "unspam", "responses": {"200": {"description": "Success"}}, "summary": "Mark a potential spam as no spam", "tags": ["discussions"]}, "parameters": [{"in": "path", "name": "id", "required": true, "type": "string"}]}, "/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/{ident}/": {"get": {"operationId": "get_harvest_job", "parameters": [{"default": 1, "description": "The page to fetch", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "in": "query", "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/HarvestJob"}}}, "summary": "List all jobs for a given source", "tags": ["harvest"]}, "parameters": [{"in": "path", "name": "ident", "required": true, "type": "string"}]}, "/harvest/job_status": {"get": {"operationId": "get_list_harvester_api", "responses": {"200": {"description": "Success", "schema": {"items": {"type": "string"}, "type": "array"}}}, "summary": "List all available harvesters", "tags": ["harvest"]}}, "/harvest/source/preview": {"post": {"operationId": "preview_harvest_source_config", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/HarvestSource"}}, {"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/{ident}": {"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"}}}, "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"}}}, "summary": "Get a single source given an ID or a slug", "tags": ["harvest"]}, "parameters": [{"description": "A source ID or slug", "in": "path", "name": "ident", "required": true, "type": "string"}], "put": {"operationId": "update_harvest_source", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/HarvestSource"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestSource"}}}, "summary": "Update a harvest source", "tags": ["harvest"]}}, "/harvest/source/{ident}/jobs/": {"get": {"operationId": "list_harvest_jobs", "parameters": [{"default": 1, "description": "The page to fetch", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "in": "query", "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": "ident", "required": true, "type": "string"}]}, "/harvest/source/{ident}/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": [{"description": "A source ID or slug", "in": "path", "name": "ident", "required": true, "type": "string"}]}, "/harvest/source/{ident}/run": {"parameters": [{"description": "A source ID or slug", "in": "path", "name": "ident", "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"}}}, "tags": ["harvest"]}}, "/harvest/source/{ident}/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"}}}, "summary": "Unschedule an harvest source", "tags": ["harvest"]}, "parameters": [{"description": "A source ID or slug", "in": "path", "name": "ident", "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"}}}, "summary": "Schedule an harvest source", "tags": ["harvest"]}}, "/harvest/source/{ident}/validate": {"parameters": [{"description": "A source ID or slug", "in": "path", "name": "ident", "required": true, "type": "string"}], "post": {"operationId": "validate_harvest_source", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/HarvestSourceValidation"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestSource"}}}, "summary": "Validate or reject an harvest source", "tags": ["harvest"]}}, "/harvest/sources/": {"get": {"operationId": "list_harvest_sources", "parameters": [{"default": 1, "description": "The page to fetch", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "in": "query", "name": "page_size", "type": "integer"}, {"description": "The organization or user ID to filter on", "in": "query", "name": "owner", "type": "string"}, {"default": false, "description": "Include sources flaggued 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"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/HarvestSource"}}}, "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/Me"}}}, "summary": "Fetch the current user (me) identity", "tags": ["me"]}, "put": {"operationId": "update_me", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Me"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Me"}}, "400": {"description": "Validation error"}}, "summary": "Update my profile", "tags": ["me"]}}, "/me/apikey": {"delete": {"operationId": "clear_apikey", "responses": {"204": {"description": "API Key deleted/cleared"}}, "summary": "Clear/destroy an apikey", "tags": ["me"]}, "post": {"operationId": "generate_apikey", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ApiKey"}}, "201": {"description": "API Key generated"}}, "summary": "(Re)Generate my API Key", "tags": ["me"]}}, "/me/avatar": {"post": {"consumes": ["multipart/form-data"], "operationId": "my_avatar", "parameters": [{"in": "formData", "name": "file", "type": "file"}, {"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"}, "type": "array"}}}, "summary": "List all discussions related to my organizations", "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": "get_notifications", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Notification"}, "type": "array"}}}, "summary": "List all current user pending notifications", "tags": ["notifications"]}}, "/oembed": {"get": {"description": "See: http://oembed.com/\n\nSupport datasets and reuses URLs", "operationId": "oembed", "parameters": [{"description": "The URL to retrieve embedding information for", "format": "url", "in": "query", "name": "url", "required": true, "type": "string"}, {"description": "The maximum width of the embedded resource", "in": "query", "name": "maxwidth", "type": "string"}, {"description": "The maximum height of the embedded resource", "in": "query", "name": "maxheight", "type": "string"}, {"default": "json", "description": "The required response format.", "in": "query", "name": "format", "type": "string"}], "responses": {"200": {"description": "Success"}}, "summary": "An OEmbed compliant API endpoint", "tags": ["site"]}}, "/oembeds/": {"get": {"description": "See: http://oembed.com/\n\nThe `references` are composed by a keyword (`kind`) followed by\nthe `id` each of those separated by commas.\nE.g:\ndataset-5369992aa3a729239d205183,\nterritory-fr:departement:33@1860-07-01:emploi_dep\n\nOnly datasets and territories are supported for now.", "operationId": "oembeds", "parameters": [{"description": "References of the resources to embed.", "in": "query", "name": "references", "required": true, "type": "string"}], "responses": {"200": {"description": "Success"}}, "summary": "The returned payload is a list of OEmbed formatted responses", "tags": ["site"]}}, "/organizations/": {"get": {"operationId": "list_organizations", "parameters": [{"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"description": "The field (and direction) on which sorting apply", "enum": ["name", "reuses", "datasets", "followers", "views", "created", "last_modified", "-name", "-reuses", "-datasets", "-followers", "-views", "-created", "-last_modified"], "in": "query", "name": "sort", "type": "string"}, {"default": 1, "description": "The page to display", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size", "in": "query", "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/OrganizationPage"}}}, "summary": "List or search all organizations", "tags": ["organizations"]}, "post": {"operationId": "create_organization", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Organization"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/Organization"}}, "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", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "in": "query", "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", "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"}}, "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"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Organization"}}, "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}/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"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Badge"}}}, "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}/catalog": {"get": {"operationId": "rdf_organization", "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", "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": [{"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}/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 display", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size", "in": "query", "name": "page_size", "type": "integer"}, {"in": "query", "name": "tag", "type": "string"}, {"in": "query", "name": "license", "type": "string"}, {"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"}, {"in": "query", "name": "organization", "type": "string"}, {"in": "query", "name": "owner", "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": "dataservice", "type": "string"}, {"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/": {"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"}, "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": [{"in": "formData", "name": "file", "type": "file"}, {"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": [{"in": "formData", "name": "file", "type": "file"}, {"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/{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"}], "post": {"operationId": "create_organization_member", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Member"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/Member"}}, "403": {"description": "Not Authorized"}, "409": {"description": "User is already member", "schema": {"$ref": "#/definitions/Member"}}}, "summary": "Add a member into a given organization", "tags": ["organizations"]}, "put": {"operationId": "update_organization_member", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Member"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Member"}}, "403": {"description": "Not Authorized"}}, "summary": "Update member status into a given organization", "tags": ["organizations"]}}, "/organizations/{org}/membership/": {"get": {"operationId": "list_membership_requests", "parameters": [{"description": "If provided, only return requests ith a given status", "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/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": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/MembershipRequest"}}}, "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"}}}, "summary": "Accept user membership to 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", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "in": "query", "name": "page_size", "type": "integer"}, {"default": "-created_at", "description": "The sorting attribute", "in": "query", "name": "sort", "type": "string"}, {"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"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Post"}}, "400": {"description": "Validation error"}}, "summary": "Create a post", "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"}}, "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"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Post"}}, "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": [{"in": "formData", "name": "file", "type": "file"}, {"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": [{"in": "formData", "name": "file", "type": "file"}, {"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"}}}, "summary": "Publish 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"}}}, "summary": "Publish an existing post", "tags": ["posts"]}}, "/reports/": {"get": {"operationId": "list_reports", "parameters": [{"default": 1, "description": "The page to display", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size", "in": "query", "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/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"}]}, "/reuses/": {"get": {"operationId": "list_reuses", "parameters": [{"default": 1, "description": "The page to display", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size", "in": "query", "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"}, {"in": "query", "name": "q", "type": "string"}, {"in": "query", "name": "owner", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"in": "query", "name": "type", "type": "string"}, {"in": "query", "name": "dataset", "type": "string"}, {"in": "query", "name": "tag", "type": "string"}, {"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/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", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "in": "query", "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", "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"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Badge"}}}, "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}/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"}}}, "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": [{"in": "formData", "name": "file", "type": "file"}, {"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"}}}, "summary": "Site-wide variables", "tags": ["site"]}}, "/site/catalog": {"get": {"operationId": "get_site_rdf_catalog", "responses": {"200": {"description": "Success"}}, "summary": "Root RDF endpoint with content negociation handling", "tags": ["site"]}}, "/site/catalog.{format}": {"get": {"operationId": "get_site_rdf_catalog_format", "responses": {"200": {"description": "Success"}}, "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/home/datasets/": {"get": {"operationId": "get_home_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 homepage datasets", "tags": ["site"]}, "put": {"operationId": "set_home_datasets", "parameters": [{"description": "Dataset IDs to put in homepage", "in": "body", "name": "payload", "required": true, "schema": {"items": {"type": "string"}, "type": "array"}}, {"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": "Set the homepage datasets editorial selection", "tags": ["site"]}}, "/site/home/reuses/": {"get": {"operationId": "get_home_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 homepage featured reuses", "tags": ["site"]}, "put": {"operationId": "set_home_reuses", "parameters": [{"description": "Reuse IDs to put in homepage", "in": "body", "name": "payload", "required": true, "schema": {"items": {"type": "string"}, "type": "array"}}, {"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": "Set the homepage reuses editorial selection", "tags": ["site"]}}, "/spam/": {"get": {"operationId": "get_potential_spams", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/PotentialSpam"}}}, "summary": "Get all potential spam objects", "tags": ["spam"]}}, "/spam/check": {"post": {"operationId": "check_mcaptcha", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/McaptchaForm"}}], "responses": {"200": {"description": "Success"}}, "summary": "Check the MCaptcha token from an app component", "tags": ["spam"]}}, "/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"]}}, "/territory/suggest/": {"get": {"operationId": "suggest_territory", "parameters": [{"description": "The string to autocomplete/suggest", "in": "query", "name": "q", "required": true, "type": "string"}, {"description": "The maximum result size", "in": "query", "name": "size", "type": "integer"}], "responses": {"200": {"description": "Success"}}, "tags": ["site"]}}, "/topics/": {"get": {"operationId": "list_topics", "parameters": [{"description": "The search query", "in": "query", "name": "q", "type": "string"}, {"description": "The field (and direction) on which sorting apply", "enum": ["name", "created", "last_modified", "-name", "-created", "-last_modified"], "in": "query", "name": "sort", "type": "string"}, {"default": 1, "description": "The page to display", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size", "in": "query", "name": "page_size", "type": "integer"}, {"in": "query", "name": "include_private", "type": "boolean"}, {"in": "query", "name": "tag", "type": "string"}, {"in": "query", "name": "geozone", "type": "string"}, {"in": "query", "name": "granularity", "type": "string"}, {"in": "query", "name": "organization", "type": "string"}, {"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/TopicPage"}}}, "summary": "List all topics", "tags": ["topics"]}, "post": {"operationId": "create_topic", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Topic"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Topic"}}, "400": {"description": "Validation error"}}, "summary": "Create a topic", "tags": ["topics"]}}, "/topics/{topic}/": {"delete": {"operationId": "delete_topic", "responses": {"204": {"description": "Object deleted"}, "403": {"description": "Forbidden"}, "404": {"description": "Object not found"}}, "summary": "Delete a given topic", "tags": ["topics"]}, "get": {"operationId": "get_topic", "parameters": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Topic"}}, "404": {"description": "Object not found"}}, "summary": "Get a given topic", "tags": ["topics"]}, "parameters": [{"description": "The topic ID or slug", "in": "path", "name": "topic", "required": true, "type": "string"}], "put": {"operationId": "update_topic", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Topic"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Topic"}}, "400": {"description": "Validation error"}, "403": {"description": "Forbidden"}, "404": {"description": "Object not found"}}, "summary": "Update a given topic", "tags": ["topics"]}}, "/transfer/": {"get": {"operationId": "list_transfers", "parameters": [{"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"}}}, "summary": "List all transfer requests", "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 display", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size", "in": "query", "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"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/User"}}, "400": {"description": "Validation error"}}, "summary": "Create a new object", "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", "in": "query", "name": "page", "type": "integer"}, {"default": 20, "description": "The page size to fetch", "in": "query", "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": "Do not send a mail to notify the user of the deletion", "in": "query", "name": "no_mail", "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"}}, "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"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/User"}}, "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": [{"in": "formData", "name": "file", "type": "file"}, {"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": [{"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"}]}, "/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/Job"}, "type": "array"}}}, "summary": "List all scheduled jobs", "tags": ["workers"]}, "post": {"operationId": "post_jobs_api", "parameters": [{"in": "body", "name": "payload", "required": true, "schema": {"$ref": "#/definitions/Job"}}, {"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Job"}}}, "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/Job"}}}, "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": [{"description": "An optional fields mask", "format": "mask", "in": "header", "name": "X-Fields", "type": "string"}], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Job"}}}, "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": {"FieldValidationError": {"description": "A validation error", "schema": {"$ref": "#/definitions/ValidationError"}}, "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"}}, "ValueError": {"description": "A generic value error", "schema": {"$ref": "#/definitions/Error"}}}, "securityDefinitions": {"apikey": {"in": "header", "name": "X-API-KEY", "type": "apiKey"}}, "swagger": "2.0", "tags": [{"description": "Site global namespace", "name": "site"}, {"description": "Dataset related operations", "name": "datasets"}, {"description": "Reuse related operations", "name": "reuses"}, {"description": "Contact points related operations", "name": "contacts"}, {"description": "Spam related operations", "name": "spam"}, {"description": "Discussion related operations", "name": "discussions"}, {"description": "Organization related operations", "name": "organizations"}, {"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": "Asynchronous workers related operations", "name": "workers"}, {"description": "User reported objects related operations (beta)", "name": "reports"}, {"description": "Tags related operations", "name": "tags"}, {"description": "Topics related operations", "name": "topics"}, {"description": "Posts related operations", "name": "posts"}, {"name": "transfer"}, {"description": "Notifications API", "name": "notifications"}, {"description": "Avatars", "name": "avatars"}, {"description": "Harvest related operations", "name": "harvest"}]}