raggedstaff/openfoodnetwork
1
0
Fork 0
mirror of https://github.com/openfoodfoundation/openfoodnetwork synced 2026-02-26 01:33:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update DFC API docs

Browse Source
This commit is contained in:
Maikel Linke
2024-04-05 10:09:00 +11:00
parent 4e7fed9c4b
commit 965ca5ca92
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
swagger/dfc.yaml
View File

@@ -64,6 +64,8 @@ paths:
dfc-b:hasPostalCode: '20170'
dfc-b:hasCity: Herndon
dfc-b:hasCountry: Australia
dfc-b:latitude: 0.0
dfc-b:longitude: 0.0
dfc-b:region: Victoria
'404':
description: not found
@@ -92,10 +94,12 @@ paths:
"@graph":
- "@id": http://test.host/api/dfc/persons/12345
"@type": dfc-b:Person
dfc-b:logo: ''
dfc-b:affiliates: http://test.host/api/dfc/enterprises/10000
- "@id": http://test.host/api/dfc/enterprises/10000
"@type": dfc-b:Enterprise
dfc-b:hasAddress: http://test.host/api/dfc/addresses/40000
dfc-b:logo: ''
dfc-b:name: Fred's Farm
dfc-b:hasDescription: Beautiful
dfc-b:manages: http://test.host/api/dfc/enterprises/10000/catalog_items/10001
@@ -111,7 +115,6 @@ paths:
"@type": dfc-b:SuppliedProduct
dfc-b:name: Apple - 1g
dfc-b:description: Red
dfc-b:hasType: dfc-pt:non-local-vegetable
dfc-b:hasQuantity:
"@type": dfc-b:QuantitativeValue
dfc-b:hasUnit: dfc-m:Gram
@@ -300,9 +303,11 @@ paths:
"@graph":
- "@id": http://test.host/api/dfc/persons/12345
"@type": dfc-b:Person
dfc-b:logo: ''
dfc-b:affiliates: http://test.host/api/dfc/enterprise_groups/60000
- "@id": http://test.host/api/dfc/enterprise_groups/60000
"@type": dfc-b:Enterprise
dfc-b:logo: ''
dfc-b:name: Sustainable Farmers
dfc-b:hasDescription: this is a group
dfc-b:VATnumber: ''
@@ -331,6 +336,7 @@ paths:
- "@id": http://test.host/api/dfc/enterprise_groups/60000
"@type": dfc-b:Enterprise
dfc-b:hasAddress: http://test.host/api/dfc/addresses/40000
dfc-b:logo: ''
dfc-b:name: Sustainable Farmers
dfc-b:hasDescription: this is a group
dfc-b:VATnumber: ''
@@ -341,6 +347,8 @@ paths:
dfc-b:hasPostalCode: '20170'
dfc-b:hasCity: Herndon
dfc-b:hasCountry: Australia
dfc-b:latitude: 0.0
dfc-b:longitude: 0.0
dfc-b:region: Victoria
"/api/dfc/enterprises/{id}":
get:
@@ -370,6 +378,7 @@ paths:
dfc-b:email: hello@example.org
dfc-b:websitePage: openfoodnetwork.org
dfc-b:hasSocialMedia: http://test.host/api/dfc/enterprises/10000/social_medias/facebook
dfc-b:logo: ''
dfc-b:name: Fred's Farm
dfc-b:hasDescription: This is an awesome enterprise
dfc-b:VATnumber: 123 456
@@ -386,12 +395,13 @@ paths:
dfc-b:hasPostalCode: '20170'
dfc-b:hasCity: Herndon
dfc-b:hasCountry: Australia
dfc-b:latitude: 0.0
dfc-b:longitude: 0.0
dfc-b:region: Victoria
- "@id": http://test.host/api/dfc/enterprises/10000/supplied_products/10001
"@type": dfc-b:SuppliedProduct
dfc-b:name: Apple - 1g
dfc-b:description: Round
dfc-b:hasType: dfc-pt:non-local-vegetable
dfc-b:hasQuantity:
"@type": dfc-b:QuantitativeValue
dfc-b:hasUnit: dfc-m:Gram
@@ -484,6 +494,7 @@ paths:
"@context": https://www.datafoodconsortium.org
"@id": http://test.host/api/dfc/persons/10000
"@type": dfc-b:Person
dfc-b:logo: ''
'404':
description: not found
"/api/dfc/enterprises/{enterprise_id}/social_medias/{name}":