Improve documentation

This commit is contained in:
François Turbelin
2020-10-11 20:21:45 +02:00
parent 11f1f6cff1
commit 779241db7a
3 changed files with 4 additions and 0 deletions

View File

@@ -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.

View File

@@ -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

View File

@@ -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