Clarify use of X-Project-Id in documentation
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Barbican |
Fix Released
|
Low
|
Priti Desai |
Bug Description
Many of the example API calls in Barbican documents use the unauthorized context without explanation.
As Barbican adoption is increasing, this is leading to confusion, as users attempt to follow the examples with a deployment that includes authorization.
I think all of the API examples should be based on the authorized context, and a separate page should be added detailing how to use unauthorized context.
Here's a example:
http://
curl -X POST -H 'content-
-d '{"payload": "my-secret-here", "payload_
http://
This is confusing because, without explanation, new users expect to use X-Project-Id header.
Changed in barbican: | |
milestone: | none → mitaka-1 |
importance: | Undecided → Low |
milestone: | mitaka-1 → mitaka-2 |
Changed in barbican: | |
status: | Fix Committed → Fix Released |
Yup, I understand the pain, was recently referring to these doc. There should be a -H 'X-Auth-Token: 12345' in every request instead of 'X-Project-ID'. Do you foresee adding one page for every API type? I think adding a note in the end of each API type should be sufficient. Thoughts?