OpenAPI specification for Beckn Network Observability

[rajaneeshk90]

Add OpenAPI specification for Beckn Network Observability

Summary

This pull request introduces the complete OpenAPI 3.1.0 definition for the Beckn Network Observability APIs, allowing any client to push and validate transaction logs against a formal schema.

Details

• New folder api/network-observability/ containing all spec artifacts
  • components/io/Observe.yaml – defines the POST /observe request payload (context + log entry)
  • components/io/Response.yaml – defines the standard acknowledgement/error response
  • components/schema/LogEntry.yaml – schema for each observability log entry (type + data)
  • components/schema/TransactionType.yaml – enum of all supported transaction types (e.g. init, on_search, confirm, etc.)
  • components/index.yaml – unresolved spec assembling all IO and schema components
  • build/network-observability.yaml – bundled, compiled OpenAPI file (generated via swagger-cli bundle)
  • README.md – instructions for editing components and regenerating the build artifact

Impact

• No breaking changes to existing specs.
• Consumers can now validate and push observability logs against a formal API.

Migration / Build Steps

1. Update or add any IO/schema files under components/.
2. Install and run swagger-cli to regenerate the bundled spec:

   npm install -g swagger-cli
   swagger-cli bundle components/index.yaml \
     --outfile build/network-observability.yaml \
     --type yaml

[ravi-prakash-v]

Hi @rajaneeshk90 please submit an RFC on Observability before creating specs. Also, please your PR to draft and not master.