{"openapi":"3.1.0","info":{"title":"FIP Dashboard Service","description":"\nBrowse the FAIR enabling resources of the Czech National Data\nInfrastructure (part of EOSC CZ) and the FAIR Implementation Profiles\nof the communities that use them.\n","version":"0.1.0"},"paths":{"/api/meta":{"get":{"tags":["fip"],"summary":"Provenance of the bundled dataset","operationId":"get_meta_api_meta_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetMeta"}}}}}}},"/api/principles":{"get":{"tags":["fip"],"summary":"The FAIR guiding principles","operationId":"get_principles_api_principles_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Principle"},"type":"array","title":"Response Get Principles Api Principles Get"}}}}}}},"/api/resource-types":{"get":{"tags":["fip"],"summary":"Categories of enabling resources","operationId":"get_resource_types_api_resource_types_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResourceType"},"type":"array","title":"Response Get Resource Types Api Resource Types Get"}}}}}}},"/api/organizations":{"get":{"tags":["fip"],"summary":"Communities and resource providers","operationId":"get_organizations_api_organizations_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Organization"},"type":"array","title":"Response Get Organizations Api Organizations Get"}}}}}}},"/api/organizations/{organization_id}":{"get":{"tags":["fip"],"summary":"One organisation","operationId":"get_organization_api_organizations__organization_id__get","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string","title":"Organization Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/resources":{"get":{"tags":["fip"],"summary":"Browse FAIR enabling resources","operationId":"get_resources_api_resources_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Q"}},{"name":"types","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"title":"Types"}},{"name":"principles","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"title":"Principles"}},{"name":"scopes","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/Scope"},"title":"Scopes"}},{"name":"fips","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"title":"Fips"}},{"name":"providers","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"title":"Providers"}},{"name":"verifiers","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"title":"Verifiers"}},{"name":"verified","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Verified"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResourceDetail"},"title":"Response Get Resources Api Resources Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/resources/{resource_id}":{"get":{"tags":["fip"],"summary":"One enabling resource","operationId":"get_resource_api_resources__resource_id__get","parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/fips":{"get":{"tags":["fip"],"summary":"FAIR Implementation Profiles","operationId":"get_fips_api_fips_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Fip"},"type":"array","title":"Response Get Fips Api Fips Get"}}}}}}},"/api/fips/{fip_id}":{"get":{"tags":["fip"],"summary":"One profile with its declarations","operationId":"get_fip_api_fips__fip_id__get","parameters":[{"name":"fip_id","in":"path","required":true,"schema":{"type":"string","title":"Fip Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FipDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/stats":{"get":{"tags":["fip"],"summary":"Aggregated numbers for the overview","operationId":"get_stats_api_stats_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stats"}}}}}}},"/api/matrix":{"get":{"tags":["fip"],"summary":"FAIR convergence matrix","operationId":"get_matrix_api_matrix_get","parameters":[{"name":"fips","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Profile ids, comma-separated","title":"Fips"},"description":"Profile ids, comma-separated"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Matrix"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/search":{"get":{"tags":["fip"],"summary":"Search across profiles and resources","operationId":"search_api_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":1,"title":"Q"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResults"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/health":{"get":{"tags":["health"],"summary":"Health Check","operationId":"health_check_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"CountByKey":{"properties":{"key":{"type":"string","title":"Key"},"label":{"$ref":"#/components/schemas/LocalizedText"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["key","label","count"],"title":"CountByKey"},"DatasetMeta":{"properties":{"name":{"$ref":"#/components/schemas/LocalizedText"},"description":{"$ref":"#/components/schemas/LocalizedText"},"disclaimer":{"$ref":"#/components/schemas/LocalizedText"},"version":{"type":"string","title":"Version"},"updated":{"type":"string","format":"date","title":"Updated"},"sources":{"items":{"type":"string"},"type":"array","title":"Sources"}},"type":"object","required":["name","description","disclaimer","version","updated"],"title":"DatasetMeta","description":"Provenance of the bundled example dataset."},"Declaration":{"properties":{"principle":{"type":"string","title":"Principle"},"resource":{"type":"string","title":"Resource"},"status":{"$ref":"#/components/schemas/DeclarationStatus","default":"in-use"},"note":{"anyOf":[{"$ref":"#/components/schemas/LocalizedText"},{"type":"null"}]}},"type":"object","required":["principle","resource"],"title":"Declaration","description":"A single choice of a resource for one FAIR principle."},"DeclarationDetail":{"properties":{"principle":{"type":"string","title":"Principle"},"resource":{"type":"string","title":"Resource"},"status":{"$ref":"#/components/schemas/DeclarationStatus","default":"in-use"},"note":{"anyOf":[{"$ref":"#/components/schemas/LocalizedText"},{"type":"null"}]},"resource_detail":{"anyOf":[{"$ref":"#/components/schemas/Resource"},{"type":"null"}]}},"type":"object","required":["principle","resource"],"title":"DeclarationDetail","description":"A declaration enriched with the declared resource."},"DeclarationStatus":{"type":"string","enum":["in-use","planned","under-consideration","to-be-replaced"],"title":"DeclarationStatus"},"Fip":{"properties":{"id":{"type":"string","title":"Id"},"title":{"$ref":"#/components/schemas/LocalizedText"},"acronym":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Acronym"},"community":{"type":"string","title":"Community"},"domain":{"$ref":"#/components/schemas/LocalizedText"},"summary":{"$ref":"#/components/schemas/LocalizedText"},"version":{"type":"string","title":"Version"},"updated":{"type":"string","format":"date","title":"Updated"},"status":{"$ref":"#/components/schemas/FipStatus","default":"draft"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"declarations":{"items":{"$ref":"#/components/schemas/Declaration"},"type":"array","title":"Declarations"},"verification":{"items":{"$ref":"#/components/schemas/Verification"},"type":"array","title":"Verification"}},"type":"object","required":["id","title","community","domain","summary","version","updated"],"title":"Fip","description":"A FAIR Implementation Profile of one community."},"FipDetail":{"properties":{"id":{"type":"string","title":"Id"},"title":{"$ref":"#/components/schemas/LocalizedText"},"acronym":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Acronym"},"community":{"type":"string","title":"Community"},"domain":{"$ref":"#/components/schemas/LocalizedText"},"summary":{"$ref":"#/components/schemas/LocalizedText"},"version":{"type":"string","title":"Version"},"updated":{"type":"string","format":"date","title":"Updated"},"status":{"$ref":"#/components/schemas/FipStatus","default":"draft"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"declarations":{"items":{"$ref":"#/components/schemas/Declaration"},"type":"array","title":"Declarations"},"verification":{"items":{"$ref":"#/components/schemas/Verification"},"type":"array","title":"Verification"},"community_detail":{"anyOf":[{"$ref":"#/components/schemas/Organization"},{"type":"null"}]},"verification_detail":{"items":{"$ref":"#/components/schemas/VerificationDetail"},"type":"array","title":"Verification Detail"},"declarations_detail":{"items":{"$ref":"#/components/schemas/DeclarationDetail"},"type":"array","title":"Declarations Detail"},"resource_count":{"type":"integer","title":"Resource Count","default":0},"principle_count":{"type":"integer","title":"Principle Count","default":0}},"type":"object","required":["id","title","community","domain","summary","version","updated"],"title":"FipDetail","description":"A profile enriched with its community and expanded declarations."},"FipStatus":{"type":"string","enum":["published","draft"],"title":"FipStatus"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"LocalizedText":{"properties":{"en":{"type":"string","title":"En"},"cs":{"type":"string","title":"Cs"}},"type":"object","required":["en","cs"],"title":"LocalizedText","description":"A short text available in every supported language."},"Matrix":{"properties":{"fips":{"items":{"$ref":"#/components/schemas/Fip"},"type":"array","title":"Fips"},"rows":{"items":{"$ref":"#/components/schemas/MatrixRow"},"type":"array","title":"Rows"},"shared_resources":{"items":{"$ref":"#/components/schemas/TopResource"},"type":"array","title":"Shared Resources"}},"type":"object","required":["fips","rows","shared_resources"],"title":"Matrix","description":"The FAIR convergence matrix: principles x profiles."},"MatrixCell":{"properties":{"fip":{"type":"string","title":"Fip"},"resources":{"items":{"type":"string"},"type":"array","title":"Resources"},"statuses":{"items":{"$ref":"#/components/schemas/DeclarationStatus"},"type":"array","title":"Statuses"}},"type":"object","required":["fip"],"title":"MatrixCell"},"MatrixRow":{"properties":{"principle":{"type":"string","title":"Principle"},"group":{"$ref":"#/components/schemas/PrincipleGroup"},"title":{"$ref":"#/components/schemas/LocalizedText"},"cells":{"items":{"$ref":"#/components/schemas/MatrixCell"},"type":"array","title":"Cells"}},"type":"object","required":["principle","group","title","cells"],"title":"MatrixRow"},"Organization":{"properties":{"id":{"type":"string","title":"Id"},"name":{"$ref":"#/components/schemas/LocalizedText"},"acronym":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Acronym"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"ror":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ror"},"scope":{"$ref":"#/components/schemas/Scope","default":"national"},"description":{"$ref":"#/components/schemas/LocalizedText"}},"type":"object","required":["id","name","description"],"title":"Organization","description":"A provider of resources or a FAIR Implementation Community."},"Principle":{"properties":{"id":{"type":"string","title":"Id"},"group":{"$ref":"#/components/schemas/PrincipleGroup"},"title":{"$ref":"#/components/schemas/LocalizedText"},"statement":{"$ref":"#/components/schemas/LocalizedText"},"explanation":{"$ref":"#/components/schemas/LocalizedText"}},"type":"object","required":["id","group","title","statement","explanation"],"title":"Principle","description":"One of the fifteen FAIR guiding principles."},"PrincipleCoverage":{"properties":{"principle":{"type":"string","title":"Principle"},"group":{"$ref":"#/components/schemas/PrincipleGroup"},"title":{"$ref":"#/components/schemas/LocalizedText"},"fips_covered":{"type":"integer","title":"Fips Covered"},"fips_total":{"type":"integer","title":"Fips Total"},"resources":{"type":"integer","title":"Resources"}},"type":"object","required":["principle","group","title","fips_covered","fips_total","resources"],"title":"PrincipleCoverage","description":"How many profiles declare at least one resource for a principle."},"PrincipleGroup":{"type":"string","enum":["F","A","I","R"],"title":"PrincipleGroup"},"Resource":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"acronym":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Acronym"},"type":{"type":"string","title":"Type"},"scope":{"$ref":"#/components/schemas/Scope"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identifier"},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider"},"description":{"$ref":"#/components/schemas/LocalizedText"},"principles":{"items":{"type":"string"},"type":"array","title":"Principles"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"verification":{"items":{"$ref":"#/components/schemas/Verification"},"type":"array","title":"Verification"}},"type":"object","required":["id","name","type","scope","description"],"title":"Resource","description":"A FAIR Enabling Resource (FER)."},"ResourceDetail":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"acronym":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Acronym"},"type":{"type":"string","title":"Type"},"scope":{"$ref":"#/components/schemas/Scope"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identifier"},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider"},"description":{"$ref":"#/components/schemas/LocalizedText"},"principles":{"items":{"type":"string"},"type":"array","title":"Principles"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"verification":{"items":{"$ref":"#/components/schemas/Verification"},"type":"array","title":"Verification"},"type_detail":{"anyOf":[{"$ref":"#/components/schemas/ResourceType"},{"type":"null"}]},"provider_detail":{"anyOf":[{"$ref":"#/components/schemas/Organization"},{"type":"null"}]},"usage":{"items":{"$ref":"#/components/schemas/ResourceUsage"},"type":"array","title":"Usage"},"usage_count":{"type":"integer","title":"Usage Count","default":0},"verification_detail":{"items":{"$ref":"#/components/schemas/VerificationDetail"},"type":"array","title":"Verification Detail"}},"type":"object","required":["id","name","type","scope","description"],"title":"ResourceDetail","description":"A resource enriched with its type, provider, and declarations."},"ResourceType":{"properties":{"id":{"type":"string","title":"Id"},"label":{"$ref":"#/components/schemas/LocalizedText"},"description":{"$ref":"#/components/schemas/LocalizedText"},"icon":{"type":"string","title":"Icon"}},"type":"object","required":["id","label","description","icon"],"title":"ResourceType","description":"A category of FAIR Enabling Resource (e.g. metadata schema)."},"ResourceUsage":{"properties":{"fip":{"type":"string","title":"Fip"},"fip_title":{"$ref":"#/components/schemas/LocalizedText"},"principle":{"type":"string","title":"Principle"},"status":{"$ref":"#/components/schemas/DeclarationStatus"},"note":{"anyOf":[{"$ref":"#/components/schemas/LocalizedText"},{"type":"null"}]}},"type":"object","required":["fip","fip_title","principle","status"],"title":"ResourceUsage","description":"Where a resource has been declared, from a resource's viewpoint."},"Scope":{"type":"string","enum":["global","european","national","institutional"],"title":"Scope"},"SearchResults":{"properties":{"query":{"type":"string","title":"Query"},"resources":{"items":{"$ref":"#/components/schemas/Resource"},"type":"array","title":"Resources"},"fips":{"items":{"$ref":"#/components/schemas/Fip"},"type":"array","title":"Fips"},"organizations":{"items":{"$ref":"#/components/schemas/Organization"},"type":"array","title":"Organizations"}},"type":"object","required":["query","resources","fips","organizations"],"title":"SearchResults","description":"Everything matching a free-text query."},"Stats":{"properties":{"fips":{"type":"integer","title":"Fips"},"resources":{"type":"integer","title":"Resources"},"organizations":{"type":"integer","title":"Organizations"},"declarations":{"type":"integer","title":"Declarations"},"principles":{"type":"integer","title":"Principles"},"verified_resources":{"type":"integer","title":"Verified Resources"},"verified_fips":{"type":"integer","title":"Verified Fips"},"by_type":{"items":{"$ref":"#/components/schemas/CountByKey"},"type":"array","title":"By Type"},"by_scope":{"items":{"$ref":"#/components/schemas/CountByKey"},"type":"array","title":"By Scope"},"by_status":{"items":{"$ref":"#/components/schemas/CountByKey"},"type":"array","title":"By Status"},"by_verifier":{"items":{"$ref":"#/components/schemas/CountByKey"},"type":"array","title":"By Verifier"},"coverage":{"items":{"$ref":"#/components/schemas/PrincipleCoverage"},"type":"array","title":"Coverage"},"top_resources":{"items":{"$ref":"#/components/schemas/TopResource"},"type":"array","title":"Top Resources"}},"type":"object","required":["fips","resources","organizations","declarations","principles","verified_resources","verified_fips","by_type","by_scope","by_status","by_verifier","coverage","top_resources"],"title":"Stats","description":"Aggregated numbers for the dashboard overview."},"TopResource":{"properties":{"resource":{"type":"string","title":"Resource"},"name":{"type":"string","title":"Name"},"type":{"type":"string","title":"Type"},"usage_count":{"type":"integer","title":"Usage Count"},"fips":{"items":{"type":"string"},"type":"array","title":"Fips"}},"type":"object","required":["resource","name","type","usage_count","fips"],"title":"TopResource"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"Verification":{"properties":{"verifier":{"type":"string","title":"Verifier"},"level":{"$ref":"#/components/schemas/VerificationLevel","default":"verified"},"date":{"type":"string","format":"date","title":"Date"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"note":{"anyOf":[{"$ref":"#/components/schemas/LocalizedText"},{"type":"null"}]}},"type":"object","required":["verifier","date"],"title":"Verification","description":"A statement that some body checked this record.\n\n``verifier`` is an organisation from the dataset; ``level`` says\nwhether that body actually checked the record (``verified``), is\nchecking it (``under-review``), or only passed on what the owner\ndeclared (``self-declared``)."},"VerificationDetail":{"properties":{"verifier":{"type":"string","title":"Verifier"},"level":{"$ref":"#/components/schemas/VerificationLevel","default":"verified"},"date":{"type":"string","format":"date","title":"Date"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"note":{"anyOf":[{"$ref":"#/components/schemas/LocalizedText"},{"type":"null"}]},"verifier_detail":{"anyOf":[{"$ref":"#/components/schemas/Organization"},{"type":"null"}]}},"type":"object","required":["verifier","date"],"title":"VerificationDetail","description":"A verification enriched with the organisation that made it."},"VerificationLevel":{"type":"string","enum":["verified","self-declared","under-review"],"title":"VerificationLevel","description":"How much scrutiny a record has had."}}}}