Api refrerence 404 on some URLs


#1

Hi,

I am getting 404 not found from these URLs:

http://manageiq.org/docs/reference/latest/api/reference/arbitration_rules
http://manageiq.org/docs/reference/latest/api/reference/arbitration_profiles
http://manageiq.org/docs/reference/latest/api/reference/arbitration_profiles
http://manageiq.org/docs/reference/latest/api/reference/blueprints
http://manageiq.org/docs/reference/latest/api/reference/provider_custom_attributes

Thanks in advance.


#2

Why do you expect those URLs to work and what would you expect to find there?

Is this something that used to work and stopped? Are those links present in other parts of the site? (a google search for those links reveals nothing)


#3

Hi,

As for what i do expect, i really don’t know, i noticed those items and tried to read the documentation and i was given a 404 not found error.

  1. Open http://manageiq.org on a BROWSER
  2. Click Documentation (TOP LEFT)
  3. Click API DOCS
  4. Click Reference and expand the list.

Among the other sections (that do have content), there titles are shown:

Arbitration Rules
Arbitration Profiles
Blueprint Support
Provider Custom Attributes

Are section listed there, (Same level as Primary Collections) but these gives 404 not found errors.
If they are listed there, they should be accesible.

There are 2 possible reasons that i can think of:

a) There is proper content and the links are broken and the links needs to be fixed.
b) There is no content to show because the links are a mistake and they should be deleted.

At least a proper page that says that the document is empty.
But even if it is empty, if nobody is going to put anything inside, a better approach would be to delete the links.

Cheers.


#4

Aah, thanks! :slight_smile:

Ok, so… the menu items themselves are defined in the manageiq.org repo - https://github.com/ManageIQ/manageiq.org/blob/master/site/_data/menus/api_menu.yml#L40 .

Looks like these were added by @abellotti in https://github.com/ManageIQ/manageiq.org/pull/485.

According to API history, Blueprint was added in 2.3.0 and removed in 3.0.0, that goes for Arbitration as well.

Looks like Provider Custom Attributes should still be in the API though, so maybe for these, only the url changed…

The files themselves are in the docs repo - https://github.com/ManageIQ/manageiq_docs/tree/master/api/reference

… looks like provider custom attributes were renamed to just custom attributes in https://github.com/ManageIQ/manageiq_docs/pull/676/commits/b10df2fc83d6769a1a1e9eeca3db2a7f0cb81a5e


@abellotti do you know anything more? Am I correct that the Arbitration Rules, Arbitration Profiles and Blueprint Support links should be removed, while Provider Custom Attributes shuold be renamed to just Custom Attributes? Thanks :slight_smile:


#5

v3.0.0 of the API docs got merged, i.e. http://manageiq.org/docs/reference/latest/api/reference/generic_objects is there, but the main topic needs to be rebuilt so the index on the left pane is updated too. We’re looking into this.


#6

Should now be fixed with https://github.com/ManageIQ/manageiq.org/pull/660 and https://github.com/ManageIQ/manageiq.org/pull/662