Investigate whether Provisioning API Client Return Code on Success

[yogeshbdeshpande]

Once a CoRIM is submitted, via the submit provisioning API, investigate and check, as to whether the caller of the Run API within SubmtConfig{} is returned with a suitable Code, so that it can display the same upon successful submission of a CoRIM Payload.

[kallal79]

Problem: The SubmitConfig.Run() method only returned error, providing no success information to callers when CoRIM submission succeeded.

Solution Implemented

API Change

// BEFORE (Issue #14)
func (cfg SubmitConfig) Run(endorsement []byte, mediaType string) error

// AFTER (Fixed)
func (cfg SubmitConfig) Run(endorsement []byte, mediaType string) (*SubmitSession, error)

Benefits

• Success Information Available: Callers now get SubmitSession with status, expiry, etc.
• User-Friendly Feedback: Applications can display meaningful success messages
• Works for Sync & Async: Both synchronous and asynchronous submissions return success info

Usage Example

// OLD WAY (no success details)
err := cfg.Run(corimBuf, "application/corim+cbor")
if err != nil {
    log.Fatal(err)
}
// No success information available

// NEW WAY (rich success information)
session, err := cfg.Run(corimBuf, "application/corim+cbor")
if err != nil {
    log.Fatal(err)
}
// Now can display: Status, Expiry time, and other details
fmt.Printf(" Success! Status: %s, Expires: %s\n", session.Status, session.Expiry)

Files Modified

1. provisioning/provisioning.go - Updated Run() and pollForSubmissionCompletion() signatures
2. provisioning/doc.go - Updated documentation
3. provisioning/provisioning_test.go - Updated all tests + added success info demonstration tests

Test Results

 TestSubmitConfig_Run_success_info_returned - Demonstrates sync success info
 TestSubmitConfig_Run_async_success_info_returned - Demonstrates async success info
 All existing tests updated and passing