Scope API Specification
- One GET request to retrieve the list of available scopes (same endpoint shared between all producers and platforms)
Reponse looking like:
{
"@context": "https://github.com/datafoodconsortium/ontology/blob/master/src/DFC_TechnicalOntology.owl",
"@id": "https://myplatform.com/scopes"
"dfc-t:scopes": {
"@type": "rdf:List",
"@list": [
{
"@id": "https://example.com/scopes/ReadEnterprise",
"dfc-t:scope": "ReadEnterprise",
"dfc-t:name": "Read enterprise data",
"dfc-t:hasDescription": "This scope allows portals to access the associated producers enterprise data"
},
{
"@id": "https://example.com/scopes/WriteEnterprise",
"dfc-t:scope": "WriteEnterprise",
"dfc-t:name": "Write enterprise data",
"dfc-t:hasDescription": "This scope allows portals to modify the associated producers enterprise data"
},
{
"@id": "https://example.com/scopes/ReadProducts",
"dfc-t:scope": "ReadProducts",
"dfc-t:name": "Read enterprise products",
"dfc-t:hasDescription": "This scope allows portals to access the associated producers enterprise products"
},
{
"@id": "https://example.com/scopes/WriteProducts",
"dfc-t:scope": "WriteProducts",
"dfc-t:name": "Write enterprise products",
"dfc-t:hasDescription": "This scope allows portals to modify the associated producers enterprise products"
},
{
"@id": "https://example.com/scopes/ReadOrders",
"dfc-t:scope": "ReadOrders",
"dfc-t:name": "Read enterprise products",
"dfc-t:hasDescription": "This scope allows portals to modify the associated producers enterprise products"
},
{
"@id": "https://example.com/scopes/WriteOrders",
"dfc-t:scope": "WriteOrders",
"dfc-t:name": "Write enterprise orders",
"dfc-t:hasDescription": "This scope allows portals to modify the associated producers enterprise products"
}
]
}
}
Ping @garethe I am working on having an issue per endpoint for a clearer overview.
Edited by Marjolaine Le Bon