Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issues in voucher/enrollment status telemetry message examples in BRSKI-43 #144

Open
EskoDijk opened this issue Sep 18, 2020 · 1 comment
Labels

Comments

@EskoDijk
Copy link

The example in 5.7

{
"version":"1",
"status":false,
"reason":"Informative human readable message",
"reason-context": { "additional" : "JSON" }
}

should have the version be a uint/int , just like in the section 5.9.4 where it is defined as a uint by CDDL, not as text. (Also , ideally the Section 5.7 should have a CDDL definition.)

The example in 5.9.4:

{
"version":"1",
"status":true,
"reason":"Informative human readable message",
"reason-context": { "additional" : "JSON" }
}

Same problem with version number (uint). Also a successful status should not have the reason and reason-context fields - these are only for error reporting . See the text above it:

"with a Reason string indicating why the most recent enrollment failed."

"reason-context attribute ... which provides additional information specific to the failure "

So a success example should not have these fields, and a failure example may be added that does have the fields.

@EskoDijk
Copy link
Author

EskoDijk commented Nov 2, 2020

Text in -44 looks almost correct now. There is one minor issue in Section 5.9.4: It has the below two sentences
In the case of a SUCCESS the Reason string MAY be omitted.
In the case of a SUCCESS the Reason string is omitted.

Suggestion is to only keep the first one:
In the case of a SUCCESS the Reason string MAY be omitted.

@mcr mcr added the auth48 label Nov 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants