feat: [WIP] Robotoff documentation #30
Conversation
Signed-off-by: GitHub Actions <[email protected]>
|
Staging documentation deployed to https://openfoodfacts.github.io/api-documentation-staging |
Signed-off-by: GitHub Actions <[email protected]>
|
Staging documentation deployed to https://openfoodfacts.github.io/api-documentation-staging |
…facts/api-documentation into test-update-from-pierre
Signed-off-by: GitHub Actions <[email protected]>
|
Staging documentation deployed to https://openfoodfacts.github.io/api-documentation-staging |
There was a problem hiding this comment.
A few things:
-
Use the already defined Postman variables, like
DOMAIN_NAME,API_VERSIONandPRODUCT_NUMBER. This makes it effectively easier to maintain the documentation over time, and switch between environments (.net, .org` etc...) -
Add
ROBOTOFF_API_VERSION = 1variable to the two Postman environments (.net and .org JSON files) -
Add
INSIGHT_ID=9a320966-c1dd-4699-aea4-fe6f3bf953bevariable to the two Postman environments (.net and .org JSON files) -
Get a random insightURL should behttps://robotoff.{{DOMAIN_NAME}}/api/v{{ROBOTOFF_API_VERSION}}/insights/randominstead of.../questions/... -
Get a specific insightURL should be filled (e.g:https://robotoff.{{DOMAIN_NAME}}/api/v{{ROBOTOFF_API_VERSION}}/insights/detail/{{INSIGHT_ID}} -
Get all insights for a specific productURL can be set tohttps://robotoff.{{DOMAIN_NAME}}/api/v{{ROBOTOFF_API_VERSION}}/insights?barcode={{PRODUCT_NUMBER}}orhttps://robotoff.openfoodfacts.org/api/v1/insights/24094870(not sure why the two work but they don't return the same number of fields, maybe explain this in the docs) -
Get questionscan be changed toGet random questionand URL set tohttps://robotoff.{{DOMAIN_NAME}}/api/v{{ROBOTOFF_API_VERSION}}/questions/random -
Get spelling correctionsURL can be set tohttps://robotoff.{{DOMAIN_NAME}}/api/v{{ROBOTOFF_API_VERSION}}/predict/ingredients/spellcheck
For reference, here is the list of endpoint not documented yet (can be added in further PRs):
api.add_route("/api/v1/insights", InsightCollection())
api.add_route("/api/v1/insights/annotate", AnnotateInsightResource())
api.add_route("/api/v1/predict/nutrient", NutrientPredictorResource())
api.add_route("/api/v1/predict/ocr_insights", OCRInsightsPredictorResource())
api.add_route("/api/v1/predict/category", CategoryPredictorResource())
api.add_route("/api/v1/products/dataset", UpdateDatasetResource())
api.add_route("/api/v1/webhook/product", WebhookProductResource())
api.add_route("/api/v1/images/import", ImageImporterResource())
api.add_route("/api/v1/images/crop", ImageCropResource())
api.add_route("/api/v1/images/predictions/import", ImagePredictionImporterResource())
api.add_route("/api/v1/images/predictions", ImagePredictionFetchResource())
api.add_route("/api/v1/images/predict", ImagePredictorResource())
api.add_route("/api/v1/images/logos", ImageLogoResource())
api.add_route("/api/v1/images/logos/{logo_id:int}", ImageLogoDetailResource())
api.add_route("/api/v1/images/logos/annotate", ImageLogoAnnotateResource())
api.add_route("/api/v1/images/logos/update", ImageLogoUpdateResource())
api.add_route("/api/v1/status", StatusResource())
api.add_route("/api/v1/dump", DumpResource())
api.add_route("/api/v1/users/statistics/{username}", UserStatisticsResource())
Signed-off-by: GitHub Actions <[email protected]>
|
Staging documentation deployed to https://openfoodfacts.github.io/api-documentation-staging |
Signed-off-by: GitHub Actions <[email protected]>
|
Staging documentation deployed to https://openfoodfacts.github.io/api-documentation-staging |
…facts/api-documentation into test-update-from-pierre
Signed-off-by: GitHub Actions <[email protected]>
|
Staging documentation deployed to https://openfoodfacts.github.io/api-documentation-staging |
…facts/api-documentation into test-update-from-pierre
Signed-off-by: GitHub Actions <[email protected]>
|
Staging documentation deployed to https://openfoodfacts.github.io/api-documentation-staging |
…facts/api-documentation into test-update-from-pierre
Signed-off-by: GitHub Actions <[email protected]>
|
Staging documentation deployed to https://openfoodfacts.github.io/api-documentation-staging |
…facts/api-documentation into test-update-from-pierre
Signed-off-by: GitHub Actions <[email protected]>
|
Staging documentation deployed to https://openfoodfacts.github.io/api-documentation-staging |
… in available models
Signed-off-by: GitHub Actions <[email protected]>
|
Staging documentation deployed to https://openfoodfacts.github.io/api-documentation-staging |
Signed-off-by: GitHub Actions <[email protected]>
|
Staging documentation deployed to https://openfoodfacts.github.io/api-documentation-staging |
…facts/api-documentation into test-update-from-pierre
Signed-off-by: GitHub Actions <[email protected]>
|
Staging documentation deployed to https://openfoodfacts.github.io/api-documentation-staging |
Signed-off-by: GitHub Actions <[email protected]>
|
Staging documentation deployed to https://openfoodfacts.github.io/api-documentation-staging |
Signed-off-by: GitHub Actions <[email protected]>
|
Staging documentation deployed to https://openfoodfacts.github.io/api-documentation-staging |
Signed-off-by: GitHub Actions <[email protected]>
|
Staging documentation deployed to https://openfoodfacts.github.io/api-documentation-staging |
teolemon
changed the title
Robotoff documentation. The non Robotoff docs have been copied to a new PR.