beckn / protocol-specifications

Core protocol specification for peer-to-peer consumer-provider interaction
Other
375 stars 101 forks source link

Add Documentation for Layering Network Policy Framework #449

Closed rajaneeshk90 closed 4 weeks ago

rajaneeshk90 commented 1 month ago

Summary This pull request adds documentation for a framework that layers network policies on top of the Beckn protocol specification. It provides an illustrative guide to constructing network policy layers.

For further details, refer to the draft documentation: BECKN-001: Layering Network Policy (Draft-01).

Scope This PR focuses on documentation that outlines the structure and approach for network policies using the OpenAPI 3.1 specification. It covers how smaller YAML components are compiled into a comprehensive network policy layer.

Key Components Documented

  1. The folder structure for network policies is explained, including how request and response examples, shared rules, and API-specific rules are organized.
  2. Steps for using the Swagger CLI to compile the network policy YAML from the template is outlined.