openstack-manuals

Keystone API documentation changed, decreasing the amount of content.

Bug #1015119 reported by offline
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
High
Diane Fleming
openstack-manuals havana

Bug Description

Most of the Keystone service API documentation has disappeared. The index list shown by
    http://docs.openstack.org/api/openstack-identity-service/2.0/content/
shows only a few user and tenant Admin API operations. A notable absence is the POST operation of authenticating to generate a token. The missing pages seems to still exist, as in the link
    http://docs.openstack.org/api/openstack-identity-service/2.0/content/POST_authenticate_v2.0_tokens_Service_API_Client_Operations.html
but this page can't be reached by navigating from the above content link.

It was missing on 18 June 2012 and still missing on 19 June.

Browser : Firefox 11 with JavaScript enabled.

Tags: identity-api
Revision history for this message
Joseph Heck (heckj) wrote :

I just verified those links, and I'm not having any trouble resolving them. If it was out, it's restored and available now.

Changed in openstack-manuals:
status: New → Invalid
Anne Gentle (annegentle)
Changed in openstack-manuals:
status: Invalid → Confirmed
Revision history for this message
Anne Gentle (annegentle) wrote :

Hi Joe, it's still available as a direct link because our automated builds don't delete files on the docs server. It's not accessible through "normal" navigation any more. I'd like there to be one guide for client and admin calls for easier access.

Anne Gentle (annegentle)
summary: - Keystone API documentation has vanished.
+ Keystone API documentation changed, decreasing the amount of content.
Tom Fifield (fifieldt)
Changed in openstack-manuals:
importance: Undecided → Medium
Revision history for this message
Boden R (boden) wrote :

I raised this confusion in the email list today: https://lists.launchpad.net/openstack/msg16906.html

Would be nice to have some clarity for user facing docs..

Thanks

Dolph Mathews (dolph)
Changed in openstack-manuals:
assignee: nobody → Dolph Mathews (dolph)
Carlos Marin (carlos-marin-d)
Changed in openstack-manuals:
assignee: Dolph Mathews (dolph) → Carlos Marin (carlos-marin-d)
Revision history for this message
Carlos Marin (carlos-marin-d) wrote :

After: https://review.openstack.org/#/c/13593/

Token Operations are now shown, which includes "Authenticate for Service API", is this sufficient to close the bug?

http://docs.openstack.org/api/openstack-identity-service/2.0/content/Token_Operations.html

http://docs.openstack.org/api/openstack-identity-service/2.0/content/POST_authenticate_v2.0_tokens_Admin_API_Service_Developer_Operations-d1e1356.html

Carlos Marin (carlos-marin-d)
Changed in openstack-manuals:
status: Confirmed → Fix Committed
Revision history for this message
Anne Gentle (annegentle) wrote :

Hi Carlos -

I realize you've committed a fix for what the mailing list poster "boden" pointed out. I think to close this particular bug, we still need the correct files built and copied (FTPed) and navigation made available - is that work done? Here are the tasks:

- create two pom.xml files that make a client spec and an admin spec that includes all extensions (don't want 12 PDFs, just two)
- create build processes using the yaml configurations on the Jenkins server for both pom.xml files (CI team can help)
- update openstack-manuals/www/api/api-specs.html to point to a client spec and an admin spec for Identity 2.0

Is this something you could pick up, or shall we let some one else have a go?
Thanks,
Anne

Changed in openstack-manuals:
status: Fix Committed → Triaged
Revision history for this message
Carlos Marin (carlos-marin-d) wrote :

Hi Anne -

Given I'm not dedicated to this project it's uncertain that I can resolve the tasks you mention on a convenient time. I'll focus first on the aggregated PDFs and it's probably best that someone else more familiar with the matter pick up the Jenkins configurations changes.

Carlos

Tom Fifield (fifieldt)
affects: openstack-manuals → openstack-api-site
tags: added: identity-api
Diane Fleming (diane-fleming)
Changed in openstack-api-site:
assignee: Carlos Marin (carlos-marin-d) → Diane Fleming (diane-fleming)
Diane Fleming (diane-fleming)
affects: openstack-api-site → openstack-manuals
Revision history for this message
Diane Fleming (diane-fleming) wrote :

fixed with https://review.openstack.org/30216

Changed in openstack-manuals:
status: Triaged → In Progress
milestone: none → havana
Revision history for this message
Diane Fleming (diane-fleming) wrote :

Added extensions

Changed in openstack-manuals:
importance: Medium → High
Diane Fleming (diane-fleming)
Changed in openstack-manuals:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.