From 779241db7a5e92a365e98b93c52105cd451f5fe7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Turbelin?= Date: Sun, 11 Oct 2020 20:21:45 +0200 Subject: [PATCH] Improve documentation --- engines/dfc_provider/README.md | 2 ++ .../controllers/dfc_provider/api/catalog_items_controller.rb | 1 + .../dfc_provider/api/supplied_products_controller.rb | 1 + 3 files changed, 4 insertions(+) diff --git a/engines/dfc_provider/README.md b/engines/dfc_provider/README.md index 8e73633c46..22fd5c018a 100644 --- a/engines/dfc_provider/README.md +++ b/engines/dfc_provider/README.md @@ -8,3 +8,5 @@ Basically, it allows an OFN user linked to an enterprise: * to be authenticated thanks to an Access Token from DFC Authorization server (using an OIDC implementation) The API endpoint for the catalog is `/api/dfc_provider/enterprise/prodcuts.json` and you need to pass the token inside an authentication header (`Authentication: Bearer 123mytoken456`). + +This feature is still under active development. \ No newline at end of file diff --git a/engines/dfc_provider/app/controllers/dfc_provider/api/catalog_items_controller.rb b/engines/dfc_provider/app/controllers/dfc_provider/api/catalog_items_controller.rb index f701fc471d..8e2e0944a0 100644 --- a/engines/dfc_provider/app/controllers/dfc_provider/api/catalog_items_controller.rb +++ b/engines/dfc_provider/app/controllers/dfc_provider/api/catalog_items_controller.rb @@ -1,6 +1,7 @@ # frozen_string_literal: true # Controller used to provide the API products for the DFC application +# CatalogItems are items that are being sold by the entreprise. module DfcProvider module Api class CatalogItemsController < DfcProvider::Api::BaseController diff --git a/engines/dfc_provider/app/controllers/dfc_provider/api/supplied_products_controller.rb b/engines/dfc_provider/app/controllers/dfc_provider/api/supplied_products_controller.rb index ee1d273879..c3f9e85b6a 100644 --- a/engines/dfc_provider/app/controllers/dfc_provider/api/supplied_products_controller.rb +++ b/engines/dfc_provider/app/controllers/dfc_provider/api/supplied_products_controller.rb @@ -1,6 +1,7 @@ # frozen_string_literal: true # Controller used to provide the SuppliedProducts API for the DFC application +# SuppliedProducts are products that are managed by an entrerprise. module DfcProvider module Api class SuppliedProductsController < DfcProvider::Api::BaseController