{
  "aid": "swaggerhub.generixgroup8:afnor-flow-service-1.2.0",
  "name": "AFNOR Flow Service",
  "type": "Index",
  "description": "The __Flow Service API__ allows to:\n  - Upload a flow.\n  - Retrieve information related to a set of flows.\n  - Download a flow given its identifier\n\nThe resources of the API are :\n  - `/flows` : with creation and retrieval methods.\n  - `/webhooks` : creation, update, delete, list\n\nWorflow example:\n  - `POST /flows` : provide the flow information & content\n  - `POST /flows/search` : retrieve flows given multiple criterias.\n  - `GET /flows/{id}` : download a flow based on its id.\n  - `POST /webhooks` : subscribe to a channel of event\n \nHistory:\n  - `1.0.0` : First release\n  - `1.0.1` : Fixes following 2025/04/15 SG5 plenary meeting\n    - Remove AcknowledgementXXX enumerates from FlowType\n    - Acknowledgement is now based upon details (level, item, reason)\n    - Add the attachment number in the flow information\n    - Add query parameters docType & docIndex to aim a specific download\n    - Change pagination method, from cursors to offsets\n  - `1.0.2` : Fixes following 2025/05/06 SG5 plenary meeting\n    - FlowId & TrackingId as not only UUID for more flexibility\n    - Add sha256 fingerprint to allow integrity check\n    - Add trackingId as a filter criteria and in the Flow object\n    - Add full FlowInfo object + submission date in POST response\n    - Add comments\n  - `1.1.0` : Fixes following 2025/05/20 SG5 meeting\n    - Get operation: allows also to return the flow data when docType is set to Metadata\n    - Search operation: flowId is no longer a criteria, prefer too use the Get by Id operation\n    - Remove any reference to any attached document to the flow\n    - Refactor FullFlowInfo schema\n    - FlowType update (FRR 10.*) for reporting\n    - AcknowledgementDetail update to add a message and a code\n    - offset removal, do pagination using updatedAfter\n    - remove 206 status code\n    - Add StateInvoice & associated LC in FlowType enum\n    - Add extensible reason codes related to Life cycle errors\n    - Add ProcessingRule to the flow object & criteria\n    - Add webhooks callback contents\n  - `1.2.0` : \n    - Webhook management, create, update, list, delete, get\n    - Add new flow types: B2G, B2GInt, B2GOutOfScope\n    - Add new client credentials OAuth2 workflow\n    - Optimized FlowInfo/FullFlowInfo/Flow schemas\n    - Add name in Flow schema\n    - Add OAuth2 securityScheme\n    - Add Header parameter Organization-Id to ease delegation\n",
  "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.generixgroup8/afnor-flow-service/1.2.0/apis.json",
  "tags": [
    "swaggerhub.generixgroup8",
    "afnor-flow-service"
  ],
  "created": "2026-04-01",
  "modified": "2026-04-01",
  "specificationVersion": "0.19",
  "access": "3rd-Party",
  "maintainers": [
    {
      "FN": "Jentic",
      "X-github": "jentic",
      "url": "https://github.com/jentic"
    }
  ],
  "apis": [
    {
      "aid": "swaggerhub.generixgroup8:afnor-flow-service-1.2.0",
      "name": "AFNOR Flow Service",
      "description": "The __Flow Service API__ allows to:\n  - Upload a flow.\n  - Retrieve information related to a set of flows.\n  - Download a flow given its identifier\n\nThe resources of the API are :\n  - `/flows` : with creation and retrieval methods.\n  - `/webhooks` : creation, update, delete, list\n\nWorflow example:\n  - `POST /flows` : provide the flow information & content\n  - `POST /flows/search` : retrieve flows given multiple criterias.\n  - `GET /flows/{id}` : download a flow based on its id.\n  - `POST /webhooks` : subscribe to a channel of event\n \nHistory:\n  - `1.0.0` : First release\n  - `1.0.1` : Fixes following 2025/04/15 SG5 plenary meeting\n    - Remove AcknowledgementXXX enumerates from FlowType\n    - Acknowledgement is now based upon details (level, item, reason)\n    - Add the attachment number in the flow information\n    - Add query parameters docType & docIndex to aim a specific download\n    - Change pagination method, from cursors to offsets\n  - `1.0.2` : Fixes following 2025/05/06 SG5 plenary meeting\n    - FlowId & TrackingId as not only UUID for more flexibility\n    - Add sha256 fingerprint to allow integrity check\n    - Add trackingId as a filter criteria and in the Flow object\n    - Add full FlowInfo object + submission date in POST response\n    - Add comments\n  - `1.1.0` : Fixes following 2025/05/20 SG5 meeting\n    - Get operation: allows also to return the flow data when docType is set to Metadata\n    - Search operation: flowId is no longer a criteria, prefer too use the Get by Id operation\n    - Remove any reference to any attached document to the flow\n    - Refactor FullFlowInfo schema\n    - FlowType update (FRR 10.*) for reporting\n    - AcknowledgementDetail update to add a message and a code\n    - offset removal, do pagination using updatedAfter\n    - remove 206 status code\n    - Add StateInvoice & associated LC in FlowType enum\n    - Add extensible reason codes related to Life cycle errors\n    - Add ProcessingRule to the flow object & criteria\n    - Add webhooks callback contents\n  - `1.2.0` : \n    - Webhook management, create, update, list, delete, get\n    - Add new flow types: B2G, B2GInt, B2GOutOfScope\n    - Add new client credentials OAuth2 workflow\n    - Optimized FlowInfo/FullFlowInfo/Flow schemas\n    - Add name in Flow schema\n    - Add OAuth2 securityScheme\n    - Add Header parameter Organization-Id to ease delegation\n",
      "image": "",
      "baseURL": "https://{sub-domain}.{domain}/flow-service",
      "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.generixgroup8/afnor-flow-service/1.2.0",
      "version": "1.2.0",
      "tags": [
        "swaggerhub.generixgroup8",
        "afnor-flow-service"
      ],
      "properties": [
        {
          "type": "OpenAPI",
          "name": "OpenAPI definition",
          "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.generixgroup8/afnor-flow-service/1.2.0/openapi.json",
          "mediaType": "application/openapi+json"
        },
        {
          "type": "GitHubRepo",
          "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.generixgroup8/afnor-flow-service/1.2.0"
        }
      ],
      "contact": [
        {
          "FN": "AFNOR",
          "email": "sg5@afnor.org"
        }
      ]
    }
  ]
}