{"swagger": "2.0", "basePath": "/api/2", "paths": {"/captchetat/": {"get": {"responses": {"200": {"description": "Success"}}, "summary": "CaptchEtat endpoint for captcha generation and validation", "operationId": "captchetat", "parameters": [{"name": "get", "in": "query", "type": "string", "description": "type of data wanted from captchetat"}, {"name": "c", "in": "query", "type": "string", "description": "captcha name"}, {"name": "t", "in": "query", "type": "string", "description": "this is a technical argument auto-generated for audio content"}], "tags": ["captchetat"]}}, "/dataservices/search/": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DataserviceSearchPage"}}}, "summary": "Search all dataservices", "operationId": "search_dataservices", "parameters": [{"name": "q", "in": "query", "type": "string", "description": "The search query"}, {"name": "tag", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "topic", "in": "query", "type": "string"}, {"name": "organization", "in": "query", "type": "string"}, {"name": "archived", "in": "query", "type": "boolean"}, {"name": "featured", "in": "query", "type": "boolean"}, {"name": "access_type", "in": "query", "type": "string"}, {"name": "producer_type", "in": "query", "type": "string", "enum": ["user", "association", "not-specified", "local-authority", "company", "public-service"]}, {"name": "last_update_range", "in": "query", "type": "string", "enum": ["last_30_days", "last_12_months", "last_3_years"]}, {"name": "is_restricted", "in": "query", "type": "boolean"}, {"name": "sort", "in": "query", "type": "string", "description": "The field (and direction) on which sorting apply", "enum": ["created", "views", "followers", "-created", "-views", "-followers"]}, {"name": "page", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page to fetch", "default": 1}, {"name": "page_size", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page size to fetch", "default": 20}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["dataservices"]}}, "/datasets/": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DatasetPage"}}}, "summary": "List or search all datasets", "operationId": "list_datasets", "parameters": [{"name": "q", "in": "query", "type": "string", "description": "The search query"}, {"name": "sort", "in": "query", "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"]}, {"name": "page", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page to fetch", "default": 1}, {"name": "page_size", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page size to fetch", "default": 20}, {"name": "tag", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "license", "in": "query", "type": "string"}, {"name": "featured", "in": "query", "type": "boolean", "description": "If set to true, it will filter on featured datasets only. If set to false, it will exclude featured datasets."}, {"name": "geozone", "in": "query", "type": "string"}, {"name": "granularity", "in": "query", "type": "string"}, {"name": "temporal_coverage", "in": "query", "type": "string"}, {"name": "access_type", "in": "query", "type": "string", "enum": ["open", "open_with_account", "restricted"]}, {"name": "organization", "in": "query", "type": "string"}, {"name": "badge", "in": "query", "type": "string", "enum": ["pivotal-data", "spd", "inspire", "hvd", "sl", "sr"]}, {"name": "organization_badge", "in": "query", "type": "string", "enum": ["public-service", "certified", "association", "company", "local-authority"]}, {"name": "owner", "in": "query", "type": "string"}, {"name": "followed_by", "in": "query", "type": "string", "description": "(beta, subject to change/be removed)"}, {"name": "format", "in": "query", "type": "string"}, {"name": "schema", "in": "query", "type": "string"}, {"name": "schema_version", "in": "query", "type": "string"}, {"name": "topic", "in": "query", "type": "string"}, {"name": "credit", "in": "query", "type": "string"}, {"name": "dataservice", "in": "query", "type": "string"}, {"name": "reuse", "in": "query", "type": "string"}, {"name": "archived", "in": "query", "type": "boolean", "description": "If set to true, it will filter on archived datasets only. If set to false, it will exclude archived datasets. User must be authenticated and results are limited to user visibility"}, {"name": "deleted", "in": "query", "type": "boolean", "description": "If set to true, it will filter on deleted datasets only. If set to false, it will exclude deleted datasets. User must be authenticated and results are limited to user visibility"}, {"name": "private", "in": "query", "type": "boolean", "description": "If set to true, it will filter on private datasets only. If set to false, it will exclude private datasets. User must be authenticated and results are limited to user visibility"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["datasets"]}}, "/datasets/resources/{rid}/": {"parameters": [{"name": "rid", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success"}}, "operationId": "get_resource", "tags": ["datasets"]}}, "/datasets/search/": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DatasetSearchPage"}}}, "summary": "List or search all datasets", "operationId": "search_datasets", "parameters": [{"name": "q", "in": "query", "type": "string", "description": "The search query"}, {"name": "tag", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "badge", "in": "query", "type": "string", "enum": ["pivotal-data", "spd", "inspire", "hvd", "sl", "sr"]}, {"name": "organization", "in": "query", "type": "string"}, {"name": "organization_badge", "in": "query", "type": "string", "enum": ["public-service", "certified", "association", "company", "local-authority"]}, {"name": "organization_name", "in": "query", "type": "string"}, {"name": "owner", "in": "query", "type": "string"}, {"name": "license", "in": "query", "type": "string"}, {"name": "geozone", "in": "query", "type": "string"}, {"name": "include_geozone_ancestors", "in": "query", "type": "boolean"}, {"name": "granularity", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "format", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "schema", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "temporal_coverage", "in": "query", "type": "string", "description": "A date range expressed as start-end where both dates are in iso format (ie. YYYY-MM-DD-YYYY-MM-DD)"}, {"name": "featured", "in": "query", "type": "boolean"}, {"name": "topic", "in": "query", "type": "string"}, {"name": "access_type", "in": "query", "type": "string"}, {"name": "format_family", "in": "query", "type": "string", "enum": ["tabular", "machine_readable", "geographical", "documents", "other"]}, {"name": "producer_type", "in": "query", "type": "string", "enum": ["user", "association", "not-specified", "local-authority", "company", "public-service"]}, {"name": "last_update_range", "in": "query", "type": "string", "enum": ["last_30_days", "last_12_months", "last_3_years"]}, {"name": "sort", "in": "query", "type": "string", "description": "The field (and direction) on which sorting apply", "enum": ["created", "last_update", "reuses", "followers", "views", "-created", "-last_update", "-reuses", "-followers", "-views"]}, {"name": "page", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page to fetch", "default": 1}, {"name": "page_size", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page size to fetch", "default": 20}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["datasets"]}}, "/datasets/{dataset}/": {"parameters": [{"description": "The dataset ID or slug", "name": "dataset", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"410": {"description": "Dataset has been deleted"}, "404": {"description": "Dataset not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/Dataset"}}}, "summary": "Get a dataset given its identifier", "operationId": "get_dataset", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["datasets"]}}, "/datasets/{dataset}/extras/": {"parameters": [{"description": "The dataset ID or slug", "name": "dataset", "in": "path", "required": true, "type": "string"}], "delete": {"responses": {"410": {"description": "Dataset has been deleted"}, "404": {"description": "Dataset not found"}, "400": {"description": "Wrong payload format, dict expected"}}, "summary": "Delete a given dataset extras key on a given dataset", "operationId": "delete_dataset_extras", "tags": ["datasets"]}, "put": {"responses": {"410": {"description": "Dataset has been deleted"}, "404": {"description": "Dataset not found"}, "400": {"description": "Wrong payload format, dict expected"}}, "summary": "Update a given dataset extras", "operationId": "update_dataset_extras", "tags": ["datasets"]}, "get": {"responses": {"410": {"description": "Dataset has been deleted"}, "404": {"description": "Dataset not found"}, "400": {"description": "Wrong payload format, dict expected"}}, "summary": "Get a dataset extras given its identifier", "operationId": "get_dataset_extras", "tags": ["datasets"]}}, "/datasets/{dataset}/resources/": {"parameters": [{"name": "dataset", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ResourcePage"}}}, "summary": "Get the given dataset resources, paginated", "operationId": "list_resources", "parameters": [{"name": "page", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page to fetch", "default": 1}, {"name": "page_size", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page size to fetch", "default": 50}, {"name": "type", "in": "query", "type": "string", "description": "The type of resources to fetch"}, {"name": "q", "in": "query", "type": "string", "description": "query string to search through resources titles"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["datasets"]}}, "/datasets/{dataset}/resources/{rid}/extras/": {"parameters": [{"in": "path", "description": "The resource unique identifier", "name": "rid", "required": true, "type": "string"}, {"description": "The dataset ID or slug", "name": "dataset", "in": "path", "required": true, "type": "string"}], "delete": {"responses": {"410": {"description": "Dataset has been deleted"}, "404": {"description": "Key not found in existing extras"}, "400": {"description": "Wrong payload format, dict expected"}}, "summary": "Delete a given resource extras key on a given dataset", "operationId": "delete_resource_extras", "tags": ["datasets"]}, "put": {"responses": {"410": {"description": "Dataset has been deleted"}, "404": {"description": "Key not found in existing extras"}, "400": {"description": "Wrong payload format, dict expected"}}, "summary": "Update a given resource extras on a given dataset", "operationId": "update_resource_extras", "tags": ["datasets"]}, "get": {"responses": {"410": {"description": "Dataset has been deleted"}, "404": {"description": "Key not found in existing extras"}, "400": {"description": "Wrong payload format, dict expected"}}, "summary": "Get a resource extras given its identifier", "operationId": "get_resource_extras", "tags": ["datasets"]}}, "/datasets/{dataset}/schemas/": {"parameters": [{"description": "The dataset ID or slug", "name": "dataset", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"410": {"description": "Dataset has been deleted"}, "404": {"description": "Dataset not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/Schema"}}}, "summary": "Get a dataset schemas given its identifier", "operationId": "get_dataset_schemas", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["datasets"]}}, "/discussions/search/": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DiscussionPage"}}}, "summary": "List or search all discussions", "operationId": "search_discussions", "parameters": [{"name": "q", "in": "query", "type": "string", "description": "The search query"}, {"name": "closed", "in": "query", "type": "boolean"}, {"name": "last_update_range", "in": "query", "type": "string", "enum": ["last_30_days", "last_12_months", "last_3_years"]}, {"name": "sort", "in": "query", "type": "string", "description": "The field (and direction) on which sorting apply", "enum": ["created", "closed", "-created", "-closed"]}, {"name": "page", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page to fetch", "default": 1}, {"name": "page_size", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page size to fetch", "default": 20}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["discussions"]}}, "/me/org_topics/": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/TopicPage"}}}}, "summary": "List all topics related to me and my organizations", "operationId": "my_org_topics", "parameters": [{"name": "q", "in": "query", "type": "string", "description": "The search query"}, {"name": "sort", "in": "query", "type": "string", "description": "The field (and direction) on which sorting apply", "enum": ["name", "created", "last_modified", "-name", "-created", "-last_modified"]}, {"name": "page", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page to fetch", "default": 1}, {"name": "page_size", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page size to fetch", "default": 20}, {"name": "private", "in": "query", "type": "boolean", "description": "If set to true, it will filter on private topics only. If set to false, it will exclude private topics. User must be authenticated and results are limited to user visibility"}, {"name": "tag", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "geozone", "in": "query", "type": "string"}, {"name": "granularity", "in": "query", "type": "string"}, {"name": "organization", "in": "query", "type": "string"}, {"name": "owner", "in": "query", "type": "string"}, {"name": "featured", "in": "query", "type": "boolean"}, {"name": "dataset", "in": "query", "type": "string", "description": "A dataset id to filter topics containing it"}, {"name": "reuse", "in": "query", "type": "string", "description": "A reuse id to filter topics containing it"}, {"name": "dataservice", "in": "query", "type": "string", "description": "A dataservice id to filter topics containing it"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["me"]}}, "/organizations/search/": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/OrganizationSearchPage"}}}, "summary": "Search all organizations", "operationId": "search_organizations", "parameters": [{"name": "q", "in": "query", "type": "string", "description": "The search query"}, {"name": "badge", "in": "query", "type": "string", "enum": ["public-service", "certified", "association", "company", "local-authority"]}, {"name": "producer_type", "in": "query", "type": "string", "enum": ["association", "local-authority", "company", "not-specified", "public-service"]}, {"name": "sort", "in": "query", "type": "string", "description": "The field (and direction) on which sorting apply", "enum": ["reuses", "datasets", "followers", "views", "created", "-reuses", "-datasets", "-followers", "-views", "-created"]}, {"name": "page", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page to fetch", "default": 1}, {"name": "page_size", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page size to fetch", "default": 20}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["organizations"]}}, "/organizations/{org}/extras/": {"parameters": [{"name": "org", "in": "path", "required": true, "type": "string"}], "delete": {"responses": {"410": {"description": "Organization has been deleted"}, "404": {"description": "Organization not found"}, "400": {"description": "Wrong payload format, dict expected"}}, "summary": "Delete a given organization extras key on a given organization", "operationId": "delete_organization_extras", "tags": ["organizations"]}, "put": {"responses": {"410": {"description": "Organization has been deleted"}, "404": {"description": "Organization not found"}, "400": {"description": "Wrong payload format, dict expected"}}, "summary": "Update a given organization extras", "operationId": "update_organization_extras", "tags": ["organizations"]}, "get": {"responses": {"410": {"description": "Organization has been deleted"}, "404": {"description": "Organization not found"}, "400": {"description": "Wrong payload format, dict expected"}}, "summary": "Get an organization extras given its identifier", "operationId": "get_organization_extras", "tags": ["organizations"]}}, "/posts/search/": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/PostPage"}}}, "summary": "List or search all posts", "operationId": "search_posts", "parameters": [{"name": "q", "in": "query", "type": "string", "description": "The search query"}, {"name": "tag", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "last_update_range", "in": "query", "type": "string", "enum": ["last_30_days", "last_12_months", "last_3_years"]}, {"name": "sort", "in": "query", "type": "string", "description": "The field (and direction) on which sorting apply", "enum": ["created", "last_modified", "published", "-created", "-last_modified", "-published"]}, {"name": "page", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page to fetch", "default": 1}, {"name": "page_size", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page size to fetch", "default": 20}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["posts"]}}, "/reuses/": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ReusePage"}}}, "summary": "List all reuses", "operationId": "list_reuses", "parameters": [{"name": "page", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page to fetch", "default": 1}, {"name": "page_size", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page size to fetch", "default": 20}, {"name": "sort", "in": "query", "type": "string", "description": "The field (and direction) on which sorting apply", "enum": ["datasets", "followers", "views", "created", "last_modified", "title", "-datasets", "-followers", "-views", "-created", "-last_modified", "-title"]}, {"name": "q", "in": "query", "type": "string", "description": "The search query"}, {"name": "owner", "in": "query", "type": "string"}, {"name": "organization", "in": "query", "type": "string"}, {"name": "organization_badge", "in": "query", "type": "string", "format": "my-custom-format"}, {"name": "type", "in": "query", "type": "string", "enum": ["api", "application", "idea", "news_article", "paper", "post", "visualization", "hardware"]}, {"name": "dataset", "in": "query", "type": "string"}, {"name": "dataservice", "in": "query", "type": "string"}, {"name": "tag", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "topic", "in": "query", "type": "string", "enum": ["health", "transport_and_mobility", "housing_and_development", "food_and_agriculture", "culture_and_recreation", "economy_and_business", "environment_and_energy", "work_and_training", "politics_and_public_life", "safety_and_security", "education_and_research", "society_and_demography", "law_and_justice", "open_data_tools", "others"]}, {"name": "private", "in": "query", "type": "boolean"}, {"name": "featured", "in": "query", "type": "boolean"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["reuses"]}}, "/reuses/search/": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ReuseSearchPage"}}}, "summary": "Search all reuses", "operationId": "search_reuses", "parameters": [{"name": "q", "in": "query", "type": "string", "description": "The search query"}, {"name": "tag", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "organization", "in": "query", "type": "string"}, {"name": "organization_badge", "in": "query", "type": "string", "enum": ["public-service", "certified", "association", "company", "local-authority"]}, {"name": "owner", "in": "query", "type": "string"}, {"name": "type", "in": "query", "type": "string"}, {"name": "badge", "in": "query", "type": "string"}, {"name": "featured", "in": "query", "type": "boolean"}, {"name": "topic", "in": "query", "type": "string"}, {"name": "archived", "in": "query", "type": "boolean"}, {"name": "producer_type", "in": "query", "type": "string", "enum": ["user", "association", "not-specified", "local-authority", "company", "public-service"]}, {"name": "last_update_range", "in": "query", "type": "string", "enum": ["last_30_days", "last_12_months", "last_3_years"]}, {"name": "sort", "in": "query", "type": "string", "description": "The field (and direction) on which sorting apply", "enum": ["created", "datasets", "followers", "views", "-created", "-datasets", "-followers", "-views"]}, {"name": "page", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page to fetch", "default": 1}, {"name": "page_size", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page size to fetch", "default": 20}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["reuses"]}}, "/topics/": {"post": {"responses": {"400": {"description": "Validation error"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/Topic"}}}, "summary": "Create a topic", "operationId": "create_topic", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TopicInput"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["topics"]}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/TopicPage"}}}, "summary": "List all topics", "operationId": "get_topics_api", "parameters": [{"name": "q", "in": "query", "type": "string", "description": "The search query"}, {"name": "sort", "in": "query", "type": "string", "description": "The field (and direction) on which sorting apply", "enum": ["name", "created", "last_modified", "-name", "-created", "-last_modified"]}, {"name": "page", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page to fetch", "default": 1}, {"name": "page_size", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page size to fetch", "default": 20}, {"name": "private", "in": "query", "type": "boolean", "description": "If set to true, it will filter on private topics only. If set to false, it will exclude private topics. User must be authenticated and results are limited to user visibility"}, {"name": "tag", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "geozone", "in": "query", "type": "string"}, {"name": "granularity", "in": "query", "type": "string"}, {"name": "organization", "in": "query", "type": "string"}, {"name": "owner", "in": "query", "type": "string"}, {"name": "featured", "in": "query", "type": "boolean"}, {"name": "dataset", "in": "query", "type": "string", "description": "A dataset id to filter topics containing it"}, {"name": "reuse", "in": "query", "type": "string", "description": "A reuse id to filter topics containing it"}, {"name": "dataservice", "in": "query", "type": "string", "description": "A dataservice id to filter topics containing it"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["topics"]}}, "/topics/search/": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/TopicSearchPage"}}}, "summary": "List or search all topics", "operationId": "search_topics", "parameters": [{"name": "q", "in": "query", "type": "string", "description": "The search query"}, {"name": "tag", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "featured", "in": "query", "type": "boolean"}, {"name": "last_update_range", "in": "query", "type": "string", "enum": ["last_30_days", "last_12_months", "last_3_years"]}, {"name": "organization", "in": "query", "type": "string"}, {"name": "producer_type", "in": "query", "type": "string", "enum": ["user", "association", "not-specified", "local-authority", "company", "public-service"]}, {"name": "sort", "in": "query", "type": "string", "description": "The field (and direction) on which sorting apply", "enum": ["name", "created", "last_modified", "-name", "-created", "-last_modified"]}, {"name": "page", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page to fetch", "default": 1}, {"name": "page_size", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page size to fetch", "default": 20}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["topics"]}}, "/topics/{topic}/": {"parameters": [{"description": "The topic ID", "name": "topic", "in": "path", "required": true, "type": "string"}], "delete": {"responses": {"404": {"description": "Topic not found"}, "403": {"description": "Forbidden"}, "204": {"description": "Object deleted"}}, "summary": "Delete a given topic", "operationId": "delete_topic", "tags": ["topics"]}, "put": {"responses": {"404": {"description": "Topic not found"}, "403": {"description": "Forbidden"}, "400": {"description": "Validation error"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/Topic"}}}, "summary": "Update a given topic", "operationId": "update_topic", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TopicInput"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["topics"]}, "get": {"responses": {"404": {"description": "Topic not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/Topic"}}}, "summary": "Get a given topic", "operationId": "get_topic", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["topics"]}}, "/topics/{topic}/elements/": {"parameters": [{"description": "The topic ID", "name": "topic", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"403": {"description": "Forbidden"}, "404": {"description": "Topic not found"}, "400": {"description": "Expecting a list"}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/TopicElement%20%28read%29"}}}}, "operationId": "topic_elements_create", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"type": "array", "items": {"$ref": "#/definitions/ModelReference"}}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["topics"]}, "delete": {"responses": {"403": {"description": "Forbidden"}, "404": {"description": "Topic not found"}}, "summary": "Delete all elements from a Topic", "description": "This a workaround for https://github.com/kvesteri/wtforms-json/issues/43\n-> we can't use PUT /api/2/topics/{topic}/ with an empty list of elements", "operationId": "topic_elements_delete", "tags": ["topics"]}, "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/TopicElementPage"}}}, "summary": "Get a given topic's elements with pagination", "operationId": "topic_elements", "parameters": [{"name": "q", "in": "query", "type": "string", "description": "query string to search through elements"}, {"name": "sort", "in": "query", "type": "string", "description": "The field (and direction) on which sorting apply"}, {"name": "page", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page to fetch", "default": 1}, {"name": "page_size", "in": "query", "type": "integer", "minimum": 0, "exclusiveMinimum": true, "description": "The page size to fetch", "default": 20}, {"name": "class", "in": "query", "type": "string", "description": "The class of elements to fetch (eg. Dataset or Reuse)"}, {"name": "tag", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["topics"]}}, "/topics/{topic}/elements/{element_id}/": {"parameters": [{"description": "The topic ID", "name": "topic", "in": "path", "required": true, "type": "string"}, {"description": "The element ID", "name": "element", "type": "string", "in": "query"}, {"name": "element_id", "in": "path", "required": true, "type": "string"}], "delete": {"responses": {"204": {"description": "Success"}, "404": {"description": "Topic not found"}}, "summary": "Delete a given element from the given topic", "operationId": "delete_topic_element_api_/topics/<topic:topic>/elements/<element_id>/", "tags": ["topics"]}, "put": {"responses": {"204": {"description": "Success"}, "404": {"description": "Topic not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/TopicElement%20%28read%29"}}}, "summary": "Update a given element from the given topic", "operationId": "topic_element_update", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TopicElement%20%28write%29"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["topics"]}}, "/topics/{topic}/featured/": {"parameters": [{"description": "The topic ID", "name": "topic", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"404": {"description": "Topic not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/Topic"}}}, "summary": "Mark the topic as featured", "operationId": "feature_topic", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["topics"]}, "delete": {"responses": {"404": {"description": "Topic not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/Topic"}}}, "summary": "Unmark the topic as featured", "operationId": "unfeature_topic", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["topics"]}}}, "info": {"title": "uData API", "version": "2.0", "description": "udata API v2"}, "produces": ["application/json"], "consumes": ["application/json"], "securityDefinitions": {"apikey": {"type": "apiKey", "in": "header", "name": "X-API-KEY"}}, "tags": [{"name": "captchetat", "description": "CaptchEtat related operations"}, {"name": "topics", "description": "Topics related operations"}, {"name": "me", "description": "Connected user related operations (v2)"}, {"name": "datasets", "description": "Dataset related operations"}, {"name": "dataservices", "description": "Dataservice related operations"}, {"name": "discussions", "description": "Discussion related operations"}, {"name": "reuses", "description": "Reuse related operations"}, {"name": "organizations", "description": "Organization related operations"}, {"name": "posts", "description": "Post related operations"}], "definitions": {"Error": {"properties": {"message": {"type": "string"}}, "type": "object"}, "ValidationError": {"properties": {"errors": {"type": "object"}, "message": {"type": "string"}}, "type": "object"}, "TopicSearchPage": {"required": ["page", "page_size", "total"], "properties": {"data": {"type": "array", "description": "The page data", "items": {"$ref": "#/definitions/Topic"}}, "page": {"type": "integer", "description": "The current page", "minimum": 1}, "page_size": {"type": "integer", "description": "The page size used for pagination", "minimum": 0}, "total": {"type": "integer", "description": "The total paginated items", "minimum": 0}, "next_page": {"type": "string", "description": "The next page URL if exists"}, "previous_page": {"type": "string", "description": "The previous page URL if exists"}, "facets": {"type": "object", "description": "Facets/aggregations for filtering"}}, "type": "object"}, "Topic": {"required": ["created_at", "id", "last_modified", "name", "slug"], "properties": {"id": {"type": "string", "readOnly": true}, "owner": {"description": "Only present if organization is not set. Can only be set to the current authenticated user.", "allOf": [{"$ref": "#/definitions/UserReference"}]}, "organization": {"description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user.", "allOf": [{"$ref": "#/definitions/OrganizationReference"}]}, "created_at": {"type": "string", "format": "date-time", "readOnly": true}, "last_modified": {"type": "string", "format": "date-time", "readOnly": true}, "name": {"type": "string"}, "slug": {"type": "string", "readOnly": true, "maxLength": 255}, "description": {"type": "string", "format": "markdown"}, "tags": {"type": "array", "items": {"type": "string"}}, "color": {"type": "integer"}, "featured": {"type": "boolean", "readOnly": true}, "private": {"type": "boolean"}, "extras": {"type": "object"}, "spatial": {"$ref": "#/definitions/SpatialCoverage (read)"}, "page": {"type": "string", "description": "Link to the udata web page for this topic", "readOnly": true}, "uri": {"type": "string", "description": "Link to the API endpoint for this topic", "readOnly": true}, "elements": {"type": "object", "description": "Link to the topic elements"}}, "type": "object"}, "UserReference": {"required": ["first_name", "last_name", "slug"], "properties": {"slug": {"type": "string", "readOnly": true, "maxLength": 255}, "first_name": {"type": "string", "maxLength": 255}, "last_name": {"type": "string", "maxLength": 255}, "avatar": {"type": "string", "description": "URL of the image", "readOnly": true}, "avatar_thumbnail": {"type": "string", "description": "URL of the cropped and squared image (500x500)", "readOnly": true}, "deleted": {"type": "string", "format": "date-time", "description": "The date the account was deleted, null for a live account", "readOnly": true}, "page": {"type": "string", "description": "Link to the udata web page for this user", "readOnly": true}, "uri": {"type": "string", "description": "Link to the API endpoint for this user", "readOnly": true}}, "type": "object"}, "OrganizationReference": {"required": ["name", "slug"], "properties": {"badges": {"type": "array", "readOnly": true, "items": {"readOnly": true, "allOf": [{"$ref": "#/definitions/Badge (read)"}]}}, "name": {"type": "string"}, "acronym": {"type": "string", "maxLength": 128}, "slug": {"type": "string", "readOnly": true, "maxLength": 255}, "logo": {"type": "string", "description": "URL of the image", "readOnly": true}, "logo_thumbnail": {"type": "string", "description": "URL of the cropped and squared image (100x100)", "readOnly": true}, "page": {"type": "string", "description": "Link to the udata web page for this organization", "readOnly": true}, "permissions": {"readOnly": true, "allOf": [{"$ref": "#/definitions/OrganizationPermissions"}]}, "uri": {"type": "string", "description": "Link to the API endpoint for this organization", "readOnly": true}}, "type": "object"}, "Badge (read)": {"required": ["kind"], "properties": {"kind": {"type": "string"}}, "type": "object"}, "OrganizationPermissions": {"properties": {"edit": {"type": "boolean"}, "delete": {"type": "boolean"}, "members": {"type": "boolean"}, "harvest": {"type": "boolean"}, "private": {"type": "boolean"}}, "type": "object"}, "SpatialCoverage (read)": {"properties": {"geom": {"description": "A multipolygon for the whole coverage", "allOf": [{"$ref": "#/definitions/GeoJSON"}]}, "zones": {"type": "object", "description": "The covered zones identifiers (full GeoZone objects if `X-Get-Datasets-Full-Objects` is set, IDs of the zones otherwise)"}, "granularity": {"type": "object", "description": "The spatial/territorial granularity (full Granularity object if `X-Get-Datasets-Full-Objects` is set, ID of the granularity otherwise)", "default": "other"}}, "type": "object"}, "GeoJSON": {"required": ["coordinates", "type"], "properties": {"type": {"type": "string", "description": "The GeoJSON Type", "example": "Point", "enum": ["Point", "LineString", "Polygon", "MultiPoint", "MultiLineString", "MultiPolygon"]}, "coordinates": {"type": "array", "description": "The geometry as coordinates lists", "items": {"type": "object"}}}, "type": "object"}, "GeoZoneReference": {"required": ["code", "level", "name", "slug"], "properties": {"slug": {"type": "string", "description": "The zone slug"}, "name": {"type": "string", "description": "The zone name"}, "code": {"type": "string", "description": "The zone unique code in the level"}, "level": {"type": "string", "description": "The zone level"}, "uri": {"type": "string", "description": "The zone uri"}}, "type": "object"}, "GeoGranularity": {"required": ["id", "name"], "properties": {"id": {"type": "string", "description": "The granularity identifier"}, "name": {"type": "string", "description": "The granularity name"}}, "type": "object"}, "TopicInput": {"required": ["name"], "properties": {"owner": {"type": "string", "description": "Only present if organization is not set. Can only be set to the current authenticated user."}, "organization": {"type": "string", "description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user."}, "name": {"type": "string"}, "description": {"type": "string", "format": "markdown"}, "tags": {"type": "array", "items": {"type": "string"}}, "color": {"type": "integer"}, "private": {"type": "boolean"}, "extras": {"type": "object"}, "spatial": {"$ref": "#/definitions/SpatialCoverage (write)"}, "elements": {"type": "array", "description": "The topic elements", "items": {"$ref": "#/definitions/TopicElement (read)"}}}, "type": "object"}, "SpatialCoverage (write)": {"properties": {"geom": {"description": "A multipolygon for the whole coverage", "allOf": [{"$ref": "#/definitions/GeoJSON"}]}, "zones": {"type": "array", "description": "The covered zones identifiers (full GeoZone objects if `X-Get-Datasets-Full-Objects` is set, IDs of the zones otherwise)", "items": {"type": "string", "description": "The covered zones identifiers (full GeoZone objects if `X-Get-Datasets-Full-Objects` is set, IDs of the zones otherwise)"}}, "granularity": {"type": "string", "description": "The spatial/territorial granularity (full Granularity object if `X-Get-Datasets-Full-Objects` is set, ID of the granularity otherwise)", "default": "other"}}, "type": "object"}, "TopicElement (read)": {"required": ["id"], "properties": {"id": {"type": "string", "readOnly": true}, "title": {"type": "string"}, "description": {"type": "string", "format": "markdown"}, "tags": {"type": "array", "items": {"type": "string"}}, "extras": {"type": "object"}, "element": {"$ref": "#/definitions/ModelReference"}}, "type": "object"}, "ModelReference": {"required": ["class", "id"], "properties": {"class": {"type": "string", "description": "The model class"}, "id": {"type": "string", "description": "The object identifier"}}, "type": "object"}, "TopicPage": {"required": ["page", "page_size", "total"], "properties": {"data": {"type": "array", "description": "The page data", "items": {"$ref": "#/definitions/Topic"}}, "page": {"type": "integer", "description": "The current page", "minimum": 1}, "page_size": {"type": "integer", "description": "The page size used for pagination", "minimum": 0}, "total": {"type": "integer", "description": "The total paginated items", "minimum": 0}, "next_page": {"type": "string", "description": "The next page URL if exists"}, "previous_page": {"type": "string", "description": "The previous page URL if exists"}}, "type": "object"}, "TopicElementPage": {"required": ["page", "page_size", "total"], "properties": {"data": {"type": "array", "description": "The page data", "items": {"$ref": "#/definitions/TopicElement (read)"}}, "page": {"type": "integer", "description": "The current page", "minimum": 1}, "page_size": {"type": "integer", "description": "The page size used for pagination", "minimum": 0}, "total": {"type": "integer", "description": "The total paginated items", "minimum": 0}, "next_page": {"type": "string", "description": "The next page URL if exists"}, "previous_page": {"type": "string", "description": "The previous page URL if exists"}}, "type": "object"}, "TopicElement (write)": {"properties": {"title": {"type": "string"}, "description": {"type": "string", "format": "markdown"}, "tags": {"type": "array", "items": {"type": "string"}}, "extras": {"type": "object"}, "element": {"$ref": "#/definitions/LazyReference"}}, "type": "object"}, "LazyReference": {"properties": {"class": {"type": "object"}, "id": {"type": "object"}}, "type": "object"}, "DatasetSearchPage": {"required": ["page", "page_size", "total"], "properties": {"data": {"type": "array", "description": "The page data", "items": {"$ref": "#/definitions/Dataset"}}, "page": {"type": "integer", "description": "The current page", "minimum": 1}, "page_size": {"type": "integer", "description": "The page size used for pagination", "minimum": 0}, "total": {"type": "integer", "description": "The total paginated items", "minimum": 0}, "next_page": {"type": "string", "description": "The next page URL if exists"}, "previous_page": {"type": "string", "description": "The previous page URL if exists"}, "facets": {"type": "object", "description": "Facets/aggregations for filtering"}}, "x-mask": "{data{id,title,acronym,slug,description,description_short,created_at,last_modified,deleted,private,tags,badges,resources,community_resources,frequency,frequency_date,extras,metrics,organization,owner,temporal_coverage,spatial,license,access_type,access_audiences,access_type_reason_category,access_type_reason,authorization_request_url,uri,page,last_update,archived,doi,quality,harvest,geopf,internal,contact_points,featured,permissions},*}", "type": "object"}, "Dataset": {"required": ["created_at", "description", "frequency", "last_modified", "last_update", "title"], "properties": {"id": {"type": "string", "description": "The dataset identifier", "readOnly": true}, "title": {"type": "string", "description": "The dataset title"}, "acronym": {"type": "string", "description": "An optional dataset acronym"}, "slug": {"type": "string", "description": "The dataset permalink string", "readOnly": true}, "description": {"type": "string", "format": "markdown", "description": "The dataset description in markdown"}, "description_short": {"type": "string", "description": "The dataset short description"}, "created_at": {"type": "string", "format": "date-time", "description": "The dataset creation date", "readOnly": true}, "last_modified": {"type": "string", "format": "date-time", "description": "The dataset last modification date", "readOnly": true}, "deleted": {"type": "string", "format": "date-time", "description": "The deletion date if deleted", "readOnly": true}, "archived": {"type": "string", "format": "date-time", "description": "The archival date if archived"}, "doi": {"type": "string", "description": "The DOI minted for this dataset", "readOnly": true}, "featured": {"type": "boolean", "description": "Is the dataset featured"}, "private": {"type": "boolean", "description": "Is the dataset private to the owner or the organization"}, "tags": {"type": "array", "items": {"type": "string"}}, "badges": {"type": "array", "description": "The dataset badges", "readOnly": true, "items": {"$ref": "#/definitions/Badge (read)"}}, "resources": {"type": "object", "description": "Link to the dataset resources"}, "community_resources": {"type": "object", "description": "Link to the dataset community resources"}, "frequency": {"type": "object", "description": "The update frequency (full Frequency object if `X-Get-Datasets-Full-Objects` is set, ID of the frequency otherwise)", "default": "unknown"}, "frequency_date": {"type": "string", "format": "date-time", "description": "Next expected update date, you will be notified once that date is reached."}, "harvest": {"description": "Dataset harvest metadata attributes", "readOnly": true, "allOf": [{"$ref": "#/definitions/HarvestDatasetMetadata"}]}, "geopf": {"description": "G\u00e9oplateforme sync status metadata", "readOnly": true, "allOf": [{"$ref": "#/definitions/GeopfDatasetMetadata"}]}, "extras": {"type": "object", "description": "Extras attributes as key-value pairs"}, "metrics": {"type": "object", "description": "The dataset metrics"}, "organization": {"description": "The producer organization", "allOf": [{"$ref": "#/definitions/OrganizationReference"}]}, "owner": {"description": "The user information", "allOf": [{"$ref": "#/definitions/UserReference"}]}, "temporal_coverage": {"description": "The temporal coverage", "allOf": [{"$ref": "#/definitions/TemporalCoverage"}]}, "spatial": {"description": "The spatial coverage", "allOf": [{"$ref": "#/definitions/SpatialCoverage (read)"}]}, "license": {"type": "object", "description": "The dataset license (full License object if `X-Get-Datasets-Full-Objects` is set, ID of the license otherwise)", "default": "notspecified"}, "access_type": {"type": "string"}, "access_audiences": {"$ref": "#/definitions/AccessAudience (read)"}, "authorization_request_url": {"type": "string"}, "access_type_reason_category": {"type": "string"}, "access_type_reason": {"type": "string"}, "uri": {"type": "string", "description": "The API URI for this dataset", "readOnly": true}, "page": {"type": "string", "description": "The dataset web page URL", "readOnly": true}, "quality": {"type": "object", "description": "The dataset quality", "readOnly": true}, "last_update": {"type": "string", "format": "date-time", "description": "The resources last modification date"}, "internal": {"description": "Site internal and specific object's data", "readOnly": true, "allOf": [{"$ref": "#/definitions/DatasetInternals"}]}, "contact_points": {"type": "array", "description": "The dataset contact points", "items": {"$ref": "#/definitions/ContactPoint (read)"}}, "permissions": {"$ref": "#/definitions/DatasetPermissions"}}, "x-mask": "{id,title,acronym,slug,description,description_short,created_at,last_modified,deleted,private,tags,badges,resources,community_resources,frequency,frequency_date,extras,metrics,organization,owner,temporal_coverage,spatial,license,access_type,access_audiences,access_type_reason_category,access_type_reason,authorization_request_url,uri,page,last_update,archived,doi,quality,harvest,geopf,internal,contact_points,featured,permissions}", "type": "object"}, "HarvestDatasetMetadata": {"properties": {"backend": {"type": "string", "description": "Harvest backend used"}, "domain": {"type": "string", "description": "The harvested domain"}, "source_id": {"type": "string", "description": "The harvester id"}, "source_url": {"type": "string", "description": "The harvester source url"}, "remote_id": {"type": "string", "description": "The dataset remote id on the source portal"}, "remote_url": {"type": "string", "description": "The dataset remote url"}, "created_at": {"type": "string", "format": "date-time", "description": "The dataset harvested creation date", "readOnly": true}, "issued_at": {"type": "string", "format": "date-time", "description": "The dataset harvested release date", "readOnly": true}, "modified_at": {"type": "string", "format": "date-time", "description": "The dataset harvest last modification date", "readOnly": true}, "last_update": {"type": "string", "format": "date-time", "description": "The dataset last harvest date"}, "archived_at": {"type": "string", "format": "date-time", "description": "The archive date"}, "archived_reason": {"type": "string", "description": "The reason the dataset has been archived"}, "uri": {"type": "string", "description": "The dataset harveted uri"}, "dct_identifier": {"type": "string", "description": "The dct:identifier property from the harvested dataset"}, "doi": {"type": "string", "description": "The DOI the source declares for the dataset (dct:identifier, adms:identifier or owl:sameAs)", "readOnly": true}}, "type": "object"}, "GeopfDatasetMetadata": {"properties": {"datasheet_url": {"type": "string", "description": "Public G\u00e9oplateforme fiche (dashboard) url, once pushed", "readOnly": true}}, "type": "object"}, "TemporalCoverage": {"required": ["start"], "properties": {"start": {"type": "string", "format": "date-time", "description": "The temporal coverage start date"}, "end": {"type": "string", "format": "date-time", "description": "The temporal coverage end date"}}, "type": "object"}, "AccessAudience (read)": {"properties": {"role": {"type": "string", "example": "local_authority_and_administration", "enum": ["local_authority_and_administration", "company_and_association", "private"]}, "condition": {"type": "string", "example": "yes", "enum": ["yes", "no", "under_condition"]}}, "type": "object"}, "DatasetInternals": {"required": ["created_at_internal", "last_modified_internal"], "properties": {"created_at_internal": {"type": "string", "format": "date-time", "description": "The dataset's internal creation date on the site"}, "last_modified_internal": {"type": "string", "format": "date-time", "description": "The dataset's internal last modification date"}}, "type": "object"}, "ContactPoint (read)": {"required": ["id", "role"], "properties": {"id": {"type": "string", "readOnly": true}, "owner": {"description": "Only present if organization is not set. Can only be set to the current authenticated user.", "allOf": [{"$ref": "#/definitions/UserReference"}]}, "organization": {"description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user.", "allOf": [{"$ref": "#/definitions/OrganizationReference"}]}, "name": {"type": "string", "maxLength": 255}, "email": {"type": "string", "maxLength": 255}, "contact_form": {"type": "string"}, "role": {"type": "string", "example": "contact", "enum": ["contact", "creator", "publisher", "rightsHolder", "custodian", "distributor", "originator", "principalInvestigator", "processor", "resourceProvider", "user"]}}, "type": "object"}, "DatasetPermissions": {"properties": {"delete": {"type": "boolean"}, "edit": {"type": "boolean"}, "edit_resources": {"type": "boolean"}}, "type": "object"}, "DatasetPage": {"required": ["page", "page_size", "total"], "properties": {"data": {"type": "array", "description": "The page data", "items": {"$ref": "#/definitions/Dataset"}}, "page": {"type": "integer", "description": "The current page", "minimum": 1}, "page_size": {"type": "integer", "description": "The page size used for pagination", "minimum": 0}, "total": {"type": "integer", "description": "The total paginated items", "minimum": 0}, "next_page": {"type": "string", "description": "The next page URL if exists"}, "previous_page": {"type": "string", "description": "The previous page URL if exists"}}, "x-mask": "{data{id,title,acronym,slug,description,description_short,created_at,last_modified,deleted,private,tags,badges,resources,community_resources,frequency,frequency_date,extras,metrics,organization,owner,temporal_coverage,spatial,license,access_type,access_audiences,access_type_reason_category,access_type_reason,authorization_request_url,uri,page,last_update,archived,doi,quality,harvest,geopf,internal,contact_points,featured,permissions},*}", "type": "object"}, "ResourcePage": {"properties": {"data": {"type": "array", "items": {"description": "The dataset resources", "allOf": [{"$ref": "#/definitions/Resource"}]}}, "next_page": {"type": "string"}, "previous_page": {"type": "string"}, "page": {"type": "integer"}, "page_size": {"type": "integer"}, "total": {"type": "integer"}}, "type": "object"}, "Resource": {"required": ["filetype", "format", "title", "type", "url"], "properties": {"id": {"type": "string", "description": "The resource unique ID", "readOnly": true}, "title": {"type": "string", "description": "The resource title"}, "description": {"type": "string", "format": "markdown", "description": "The resource markdown description"}, "filetype": {"type": "string", "description": "Whether the resource is an uploaded file, a remote file or an API", "example": "file", "enum": ["file", "remote"]}, "type": {"type": "string", "description": "Resource type (documentation, API...)", "example": "main", "enum": ["main", "documentation", "update", "api", "code", "other"]}, "format": {"type": "string", "description": "The resource format"}, "url": {"type": "string", "description": "The resource URL"}, "latest": {"type": "string", "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}, "checksum": {"description": "A checksum to validate file validity", "allOf": [{"$ref": "#/definitions/Checksum"}]}, "filesize": {"type": "integer", "description": "The resource file size in bytes"}, "mime": {"type": "string", "description": "The resource mime type"}, "created_at": {"type": "string", "format": "date-time", "description": "The resource creation date", "readOnly": true}, "last_modified": {"type": "string", "format": "date-time", "description": "The resource last modification date", "readOnly": true}, "metrics": {"type": "object", "description": "The resource metrics", "readOnly": true}, "harvest": {"description": "Harvest attributes metadata information", "readOnly": true, "allOf": [{"$ref": "#/definitions/HarvestResourceMetadata"}]}, "geopf": {"description": "G\u00e9oplateforme sync status metadata", "readOnly": true, "allOf": [{"$ref": "#/definitions/GeopfResourceMetadata"}]}, "extras": {"type": "object", "description": "Extra attributes as key-value pairs"}, "preview_url": {"type": "string", "description": "An optional preview URL to be loaded as a standalone page (ie. iframe or new page)", "readOnly": true}, "schema": {"description": "Reference to the associated schema", "allOf": [{"$ref": "#/definitions/Schema"}]}, "internal": {"description": "Site internal and specific object's data", "readOnly": true, "allOf": [{"$ref": "#/definitions/ResourceInternals"}]}}, "type": "object"}, "Checksum": {"required": ["value"], "properties": {"type": {"type": "string", "description": "The hashing algorithm used to compute the checksum", "default": "sha1", "example": "sha1", "enum": ["sha1", "sha2", "sha256", "md5", "crc"]}, "value": {"type": "string", "description": "The resulting checksum/hash"}}, "type": "object"}, "HarvestResourceMetadata": {"properties": {"uri": {"type": "string", "description": "The resource harvest uri"}, "issued_at": {"type": "string", "format": "date-time", "description": "The resource harvested release date", "readOnly": true}, "modified_at": {"type": "string", "format": "date-time", "description": "The resource harvest last modification date", "readOnly": true}, "last_update": {"type": "string", "format": "date-time", "description": "The resource last harvest date", "readOnly": true}}, "type": "object"}, "GeopfResourceMetadata": {"properties": {"push_status": {"type": "string", "description": "Push status to G\u00e9oplateforme, if this resource has ever been pushed", "readOnly": true, "example": "pending", "enum": ["pending", "done", "error", "timeout"]}, "offering_id": {"type": "string", "description": "G\u00e9oplateforme offering id, if this resource was created from a geopf offering pull", "readOnly": true}}, "type": "object"}, "Schema": {"properties": {"name": {"type": "string"}, "version": {"type": "string"}, "url": {"type": "string"}}, "type": "object"}, "ResourceInternals": {"required": ["created_at_internal", "last_modified_internal"], "properties": {"created_at_internal": {"type": "string", "format": "date-time", "description": "The resource's internal creation date on the site"}, "last_modified_internal": {"type": "string", "format": "date-time", "description": "The resource's internal last modification date"}}, "type": "object"}, "DataserviceSearchPage": {"required": ["page", "page_size", "total"], "properties": {"data": {"type": "array", "description": "The page data", "items": {"$ref": "#/definitions/Dataservice (read)"}}, "page": {"type": "integer", "description": "The current page", "minimum": 1}, "page_size": {"type": "integer", "description": "The page size used for pagination", "minimum": 0}, "total": {"type": "integer", "description": "The total paginated items", "minimum": 0}, "next_page": {"type": "string", "description": "The next page URL if exists"}, "previous_page": {"type": "string", "description": "The previous page URL if exists"}, "facets": {"type": "object", "description": "Facets/aggregations for filtering"}}, "type": "object"}, "Dataservice (read)": {"required": ["created_at", "id", "metadata_modified_at", "slug", "title"], "properties": {"id": {"type": "string", "readOnly": true}, "owner": {"description": "Only present if organization is not set. Can only be set to the current authenticated user.", "allOf": [{"$ref": "#/definitions/UserReference"}]}, "organization": {"description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user.", "allOf": [{"$ref": "#/definitions/OrganizationReference"}]}, "badges": {"type": "array", "readOnly": true, "items": {"readOnly": true, "allOf": [{"$ref": "#/definitions/Badge (read)"}]}}, "access_type": {"type": "string", "example": "open", "enum": ["open", "open_with_account", "restricted"]}, "access_audiences": {"type": "array", "items": {"$ref": "#/definitions/AccessAudience (read)"}}, "authorization_request_url": {"type": "string"}, "access_type_reason_category": {"type": "string", "example": "confidentiality_of_proceedings_of_public_authorities", "enum": ["confidentiality_of_proceedings_of_public_authorities", "international_relations_public_security_or_national_defence", "course_of_justice_or_fair_trial", "confidentiality_of_commercial_or_industrial_information", "intellectual_property_rights", "confidentiality_of_personal_data", "protection_of_voluntary_information_suppliers", "protection_of_environment"]}, "access_type_reason": {"type": "string"}, "metrics": {"type": "object", "readOnly": true}, "title": {"type": "string", "example": "My awesome API"}, "acronym": {"type": "string", "maxLength": 128}, "slug": {"type": "string", "readOnly": true, "maxLength": 255}, "description": {"type": "string", "format": "markdown"}, "base_api_url": {"type": "string"}, "machine_documentation_url": {"type": "string", "description": "Swagger link, OpenAPI format, WMS XML\u2026"}, "technical_documentation_url": {"type": "string", "description": "HTML version of a Swagger\u2026"}, "business_documentation_url": {"type": "string"}, "rate_limiting": {"type": "string"}, "rate_limiting_url": {"type": "string"}, "availability": {"type": "number", "example": "99.99"}, "availability_url": {"type": "string"}, "format": {"type": "string", "example": "REST", "enum": ["REST", "WMS", "WSL"]}, "license": {"type": "string", "description": "The ID of the license"}, "tags": {"type": "array", "items": {"type": "string"}}, "private": {"type": "boolean", "description": "Is the dataservice private to the owner or the organization"}, "extras": {"type": "object"}, "featured": {"type": "boolean", "readOnly": true}, "contact_points": {"type": "array", "items": {"$ref": "#/definitions/ContactPoint (read)"}}, "created_at": {"type": "string", "format": "date-time", "readOnly": true}, "metadata_modified_at": {"type": "string", "format": "date-time", "readOnly": true}, "deleted_at": {"type": "string", "format": "date-time"}, "archived_at": {"type": "string", "format": "date-time"}, "datasets": {"type": "object", "description": "Visit this API link to see the list."}, "harvest": {"readOnly": true, "allOf": [{"$ref": "#/definitions/HarvestDataserviceMetadata (read)"}]}, "permissions": {"readOnly": true, "allOf": [{"$ref": "#/definitions/DataservicePermissions"}]}, "self_api_url": {"type": "string", "description": "Link to the API endpoint for this dataservice", "readOnly": true}, "self_web_url": {"type": "string", "description": "Link to the udata web page for this dataservice", "readOnly": true}}, "type": "object"}, "HarvestDataserviceMetadata (read)": {"properties": {"backend": {"type": "string"}, "domain": {"type": "string"}, "source_id": {"type": "string"}, "source_url": {"type": "string"}, "remote_id": {"type": "string"}, "remote_url": {"type": "string"}, "created_at": {"type": "string", "format": "date-time", "description": "Date of creation as provided by the harvested catalog"}, "issued_at": {"type": "string", "format": "date-time", "description": "Date of release as provided by the harvested catalog"}, "modified_at": {"type": "string", "format": "date-time", "description": "Date of last modification as provided by the harvested catalog"}, "last_update": {"type": "string", "format": "date-time", "description": "Date of last harvest"}, "archived_at": {"type": "string", "format": "date-time"}, "archived_reason": {"type": "string"}, "uri": {"type": "string", "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": "object"}, "DataservicePermissions": {"properties": {"delete": {"type": "boolean"}, "edit": {"type": "boolean"}}, "type": "object"}, "DiscussionPage": {"required": ["page", "page_size", "total"], "properties": {"data": {"type": "array", "description": "The page data", "items": {"$ref": "#/definitions/Discussion (read)"}}, "page": {"type": "integer", "description": "The current page", "minimum": 1}, "page_size": {"type": "integer", "description": "The page size used for pagination", "minimum": 0}, "total": {"type": "integer", "description": "The total paginated items", "minimum": 0}, "next_page": {"type": "string", "description": "The next page URL if exists"}, "previous_page": {"type": "string", "description": "The previous page URL if exists"}, "facets": {"type": "object", "description": "Facets/aggregations for filtering"}}, "type": "object"}, "Discussion (read)": {"required": ["created", "id", "subject", "title"], "properties": {"id": {"type": "string", "readOnly": true}, "user": {"description": "The discussion author", "readOnly": true, "allOf": [{"$ref": "#/definitions/UserReference"}]}, "organization": {"description": "The organization to publish on behalf of", "allOf": [{"$ref": "#/definitions/OrganizationReference"}]}, "subject": {"description": "The discussion target object", "allOf": [{"$ref": "#/definitions/ModelReference"}]}, "title": {"type": "string", "description": "The discussion title"}, "discussion": {"type": "array", "description": "The list of messages in the discussion", "readOnly": true, "items": {"description": "The list of messages in the discussion", "readOnly": true, "allOf": [{"$ref": "#/definitions/Message (read)"}]}}, "created": {"type": "string", "format": "date-time", "description": "The discussion creation date", "readOnly": true}, "closed": {"type": "string", "format": "date-time", "description": "The discussion closing date", "readOnly": true}, "closed_by": {"description": "The user who closed the discussion", "readOnly": true, "allOf": [{"$ref": "#/definitions/UserReference"}]}, "closed_by_organization": {"description": "The organization who closed the discussion", "readOnly": true, "allOf": [{"$ref": "#/definitions/OrganizationReference"}]}, "extras": {"type": "object", "description": "Extra attributes as key-value pairs"}, "permissions": {"readOnly": true, "allOf": [{"$ref": "#/definitions/DiscussionPermissions"}]}, "url": {"type": "string", "description": "The discussion API URI", "readOnly": true}, "self_web_url": {"type": "string", "description": "The discussion web URL", "readOnly": true}}, "type": "object"}, "Message (read)": {"required": ["content", "posted_on"], "properties": {"id": {"type": "string", "description": "The message identifier", "readOnly": true}, "content": {"type": "string", "description": "The message body", "maxLength": 50000}, "posted_on": {"type": "string", "format": "date-time", "description": "The message posting date", "readOnly": true}, "posted_by": {"description": "The message author", "readOnly": true, "allOf": [{"$ref": "#/definitions/UserReference"}]}, "posted_by_organization": {"description": "The organization to show to users", "readOnly": true, "allOf": [{"$ref": "#/definitions/OrganizationReference"}]}, "last_modified_at": {"type": "string", "format": "date-time", "description": "The message last edit date", "readOnly": true}, "permissions": {"readOnly": true, "allOf": [{"$ref": "#/definitions/DiscussionMessagePermissions"}]}}, "type": "object"}, "DiscussionMessagePermissions": {"properties": {"delete": {"type": "boolean"}, "edit": {"type": "boolean"}}, "type": "object"}, "DiscussionPermissions": {"properties": {"delete": {"type": "boolean"}, "edit": {"type": "boolean"}, "close": {"type": "boolean"}}, "type": "object"}, "ReuseSearchPage": {"required": ["page", "page_size", "total"], "properties": {"data": {"type": "array", "description": "The page data", "items": {"$ref": "#/definitions/Reuse"}}, "page": {"type": "integer", "description": "The current page", "minimum": 1}, "page_size": {"type": "integer", "description": "The page size used for pagination", "minimum": 0}, "total": {"type": "integer", "description": "The total paginated items", "minimum": 0}, "next_page": {"type": "string", "description": "The next page URL if exists"}, "previous_page": {"type": "string", "description": "The previous page URL if exists"}, "facets": {"type": "object", "description": "Facets/aggregations for filtering"}}, "type": "object"}, "Reuse": {"required": ["created_at", "description", "id", "last_modified", "slug", "title", "topic", "type", "url"], "properties": {"id": {"type": "string", "readOnly": true}, "owner": {"description": "Only present if organization is not set. Can only be set to the current authenticated user.", "allOf": [{"$ref": "#/definitions/UserReference"}]}, "organization": {"description": "Only present if owner is not set. Can only be set to an organization of the current authenticated user.", "allOf": [{"$ref": "#/definitions/OrganizationReference"}]}, "badges": {"type": "array", "readOnly": true, "items": {"readOnly": true, "allOf": [{"$ref": "#/definitions/Badge (read)"}]}}, "metrics": {"type": "object", "readOnly": true}, "created_at": {"type": "string", "format": "date-time", "readOnly": true}, "last_modified": {"type": "string", "format": "date-time", "readOnly": true}, "title": {"type": "string"}, "slug": {"type": "string", "readOnly": true, "maxLength": 255}, "description": {"type": "string", "format": "markdown"}, "type": {"type": "string", "example": "api", "enum": ["api", "application", "idea", "news_article", "paper", "post", "visualization", "hardware"]}, "url": {"type": "string", "description": "The remote URL (website)"}, "image": {"type": "string", "description": "URL of the image", "readOnly": true}, "image_thumbnail": {"type": "string", "description": "URL of the cropped and squared image (500x500)", "readOnly": true}, "datasets": {"type": "object", "description": "Link to the reuse datasets"}, "dataservices": {"type": "object", "description": "Link to the reuse dataservices"}, "tags": {"type": "array", "items": {"type": "string"}}, "topic": {"type": "string", "example": "health", "enum": ["health", "transport_and_mobility", "housing_and_development", "food_and_agriculture", "culture_and_recreation", "economy_and_business", "environment_and_energy", "work_and_training", "politics_and_public_life", "safety_and_security", "education_and_research", "society_and_demography", "law_and_justice", "open_data_tools", "others"]}, "private": {"type": "boolean"}, "extras": {"type": "object"}, "featured": {"type": "boolean", "readOnly": true}, "deleted": {"type": "string", "format": "date-time"}, "archived": {"type": "string", "format": "date-time"}, "page": {"type": "string", "description": "Link to the udata web page for this reuse", "readOnly": true}, "permissions": {"readOnly": true, "allOf": [{"$ref": "#/definitions/ReusePermissions"}]}, "uri": {"type": "string", "description": "Link to the API endpoint for this reuse", "readOnly": true}}, "type": "object"}, "ReusePermissions": {"properties": {"delete": {"type": "boolean"}, "edit": {"type": "boolean"}}, "type": "object"}, "ReusePage": {"required": ["page", "page_size", "total"], "properties": {"data": {"type": "array", "description": "The page data", "items": {"$ref": "#/definitions/Reuse"}}, "page": {"type": "integer", "description": "The current page", "minimum": 1}, "page_size": {"type": "integer", "description": "The page size used for pagination", "minimum": 0}, "total": {"type": "integer", "description": "The total paginated items", "minimum": 0}, "next_page": {"type": "string", "description": "The next page URL if exists"}, "previous_page": {"type": "string", "description": "The previous page URL if exists"}}, "type": "object"}, "OrganizationSearchPage": {"required": ["page", "page_size", "total"], "properties": {"data": {"type": "array", "description": "The page data", "items": {"$ref": "#/definitions/Organization (read)"}}, "page": {"type": "integer", "description": "The current page", "minimum": 1}, "page_size": {"type": "integer", "description": "The page size used for pagination", "minimum": 0}, "total": {"type": "integer", "description": "The total paginated items", "minimum": 0}, "next_page": {"type": "string", "description": "The next page URL if exists"}, "previous_page": {"type": "string", "description": "The previous page URL if exists"}, "facets": {"type": "object", "description": "Facets/aggregations for filtering"}}, "type": "object"}, "Organization (read)": {"required": ["created_at", "description", "id", "last_modified", "name", "slug"], "properties": {"id": {"type": "string", "readOnly": true}, "created_at": {"type": "string", "format": "date-time", "readOnly": true}, "last_modified": {"type": "string", "format": "date-time", "readOnly": true}, "badges": {"type": "array", "readOnly": true, "items": {"readOnly": true, "allOf": [{"$ref": "#/definitions/Badge (read)"}]}}, "metrics": {"type": "object", "readOnly": true}, "name": {"type": "string"}, "acronym": {"type": "string", "maxLength": 128}, "slug": {"type": "string", "readOnly": true, "maxLength": 255}, "description": {"type": "string", "format": "markdown"}, "url": {"type": "string"}, "image_url": {"type": "string"}, "logo": {"type": "string", "description": "URL of the image", "readOnly": true}, "logo_thumbnail": {"type": "string", "description": "URL of the cropped and squared image (100x100)", "readOnly": true}, "banner_color": {"type": "string", "description": "Hex color code (e.g. #000091) for the organization page banner"}, "banner_image": {"type": "string", "description": "The organization page banner image URL", "readOnly": true}, "banner_image_position": {"type": "integer", "description": "Vertical position of the banner image, as a percentage matching CSS background-position-y (0 = top, 50 = centered, 100 = bottom)", "minimum": 0, "maximum": 100}, "business_number_id": {"type": "string", "maxLength": 14}, "members": {"type": "array", "readOnly": true, "items": {"readOnly": true, "allOf": [{"$ref": "#/definitions/Member (read)"}]}}, "teams": {"type": "array", "readOnly": true, "items": {"readOnly": true, "allOf": [{"$ref": "#/definitions/Team (read)"}]}}, "ext": {"type": "object", "readOnly": true}, "zone": {"type": "string", "readOnly": true}, "extras": {"type": "object"}, "presentation_blocs": {"type": "array", "items": {"type": "object"}}, "presentation_blocs_published_at": {"type": "string", "format": "date-time", "description": "Publication date of the organization presentation blocs. Set it to make the blocs publicly visible; leave it empty to keep them hidden (draft). Organization administrators always see the blocs regardless of this date."}, "deleted": {"type": "string", "format": "date-time"}, "page": {"type": "string", "description": "Link to the udata web page for this organization", "readOnly": true}, "permissions": {"readOnly": true, "allOf": [{"$ref": "#/definitions/OrganizationPermissions"}]}, "uri": {"type": "string", "description": "Link to the API endpoint for this organization", "readOnly": true}}, "type": "object"}, "Member (read)": {"required": ["since"], "properties": {"user": {"readOnly": true, "allOf": [{"$ref": "#/definitions/UserReferenceWithEmail"}]}, "role": {"type": "string", "example": "admin", "enum": ["admin", "editor", "partial_editor"]}, "since": {"type": "string", "format": "date-time", "readOnly": true}, "label": {"type": "string", "readOnly": true}}, "type": "object"}, "UserReferenceWithEmail": {"properties": {"email": {"type": "string", "description": "The user email, obfuscated unless the caller may see it", "readOnly": true}, "last_login_at": {"type": "string", "format": "date-time", "readOnly": true}}, "type": "object"}, "Team (read)": {"properties": {}, "type": "object"}, "PostPage": {"required": ["page", "page_size", "total"], "properties": {"data": {"type": "array", "description": "The page data", "items": {"$ref": "#/definitions/Post (read)"}}, "page": {"type": "integer", "description": "The current page", "minimum": 1}, "page_size": {"type": "integer", "description": "The page size used for pagination", "minimum": 0}, "total": {"type": "integer", "description": "The total paginated items", "minimum": 0}, "next_page": {"type": "string", "description": "The next page URL if exists"}, "previous_page": {"type": "string", "description": "The previous page URL if exists"}, "facets": {"type": "object", "description": "Facets/aggregations for filtering"}}, "type": "object"}, "Post (read)": {"required": ["created_at", "id", "last_modified", "name", "slug"], "properties": {"id": {"type": "string", "readOnly": true}, "created_at": {"type": "string", "format": "date-time", "readOnly": true}, "last_modified": {"type": "string", "format": "date-time", "readOnly": true}, "name": {"type": "string", "maxLength": 255}, "slug": {"type": "string", "maxLength": 255}, "headline": {"type": "string"}, "content": {"type": "string", "format": "markdown"}, "blocs": {"type": "array", "items": {"type": "object"}}, "image_url": {"type": "string"}, "image": {"type": "string", "description": "URL of the image", "readOnly": true}, "image_thumbnail": {"type": "string", "description": "URL of the cropped and squared image (100x100)", "readOnly": true}, "credit_to": {"type": "string", "description": "An optional credit line (associated to the image)"}, "credit_url": {"type": "string", "description": "An optional link associated to the credits"}, "tags": {"type": "array", "description": "Some keywords to help in search", "items": {"type": "string", "description": "Some keywords to help in search"}}, "datasets": {"type": "array", "description": "The post datasets", "items": {"description": "The post datasets", "allOf": [{"$ref": "#/definitions/Dataset"}]}}, "reuses": {"type": "array", "description": "The post reuses", "items": {"description": "The post reuses", "allOf": [{"$ref": "#/definitions/ReuseReference"}]}}, "owner": {"description": "The owner user", "readOnly": true, "allOf": [{"$ref": "#/definitions/UserReference"}]}, "published": {"type": "string", "format": "date-time", "description": "The post publication date", "readOnly": true}, "body_type": {"type": "string", "example": "markdown", "enum": ["markdown", "html", "blocs"]}, "kind": {"type": "string", "description": "Post kind (news or page)", "example": "news", "enum": ["news", "page"]}, "parent": {"description": "The parent page, only for pages", "allOf": [{"$ref": "#/definitions/PostAncestor"}]}, "ancestors": {"type": "array", "description": "The ancestor pages, from the root page to the parent", "readOnly": true, "items": {"$ref": "#/definitions/PostAncestor"}}, "page": {"type": "string", "description": "The post web page URL", "readOnly": true}, "uri": {"type": "string", "description": "The API URI for this post", "readOnly": true}}, "type": "object"}, "ReuseReference": {"required": ["title"], "properties": {"title": {"type": "string"}, "image": {"type": "string", "description": "URL of the image", "readOnly": true}, "image_thumbnail": {"type": "string", "description": "URL of the cropped and squared image (500x500)", "readOnly": true}, "page": {"type": "string", "description": "Link to the udata web page for this reuse", "readOnly": true}, "uri": {"type": "string", "description": "Link to the API endpoint for this reuse", "readOnly": true}}, "type": "object"}, "PostAncestor": {"properties": {"id": {"type": "string", "description": "The post identifier", "readOnly": true}, "name": {"type": "string", "description": "The post name", "readOnly": true}, "page": {"type": "string", "description": "The post web page URL", "readOnly": true}}, "type": "object"}}, "responses": {"ParseError": {"description": "When a mask can't be parsed"}, "MaskError": {"description": "When any error occurs on mask"}, "PermissionDenied": {"description": "Error occuring when the user does not have the required permissions", "schema": {"$ref": "#/definitions/Error"}}, "ValidationError": {"description": "Error returned when validation failed", "schema": {"$ref": "#/definitions/ValidationError"}}}, "host": "www.data.gouv.fr", "schemes": ["https"]}