Mashery Support Portals Forums

Mashery API

RSS Feed

iodocs configuration fails - 0 methods

  1. I have attempted to configure iodocs using the example JSON provided on github - https://github.com/mashery/iodocs

    It seems to save the JSON, but says there are # of methods displays as 0. I have also tried other people's configurations with the same result. When I go to our iodocs page, it is a 500 Internal Server Error.

    Any idea what's going on here?

    Message edited by Josiah Gore 2 months ago

    Tags

  2. Kelly Miyashiro – 2 years ago

    Hey Josiah, /iodocs is for our beta/alpha version. Try going to /io-docs for the new version. Unfortunately, it looks like the Lulu theme expects some custom markup so the layout is breaking... that might require some customizations via JS or CSS.

    For the schema, the github version is for the beta version. Unfortunately the docs for the new schema are not up yet (AFAIK), but here is Klout's example schema:

    1. {
    2.     "name":              "Klout API",
    3.     "version":           "1.0",
    4.     "title":             "Klout API",
    5.     "description":       "",
    6.     "documentationLink": "",
    7.     "protocol":          "rest",
    8.     "basePath":          "http://api.klout.com/1",
    9.     "auth": {
    10.         "key": {
    11.             "param": "key"
    12.         }
    13.     },
    14.     "resources": {
    15.         "Score Methods": {
    16.             "methods": {
    17.                 "Klout Score": {
    18.                     "path":        "/klout.:format",
    19.                     "httpMethod":  "GET",
    20.                     "description": "This method allows you to retrieve a Klout score.",
    21.                     "parameters": {
    22.                         "users": {
    23.                             "type":        "string",
    24.                             "required":    true,
    25.                             "default":     "",
    26.                             "description": "One or more (comma-separated) Twitter usernames.",
    27.                             "location":    "query"
    28.                         },
    29.                         ":format": {
    30.                             "type":        "string",
    31.                             "required":    true,
    32.                             "default":     "json",
    33.                             "description": "Output format as JSON or XML",
    34.                             "enum": [
    35.                                 "json",
    36.                                 "xml"
    37.                             ],
    38.                             "location":    "pathReplace"
    39.                         }
    40.                     }
    41.                 }
    42.             }
    43.         },
    44.         "User Methods": {
    45.             "methods": {
    46.                 "Show User": {
    47.                     "path":        "/users/show.:format",
    48.                     "httpMethod":  "GET",
    49.                     "description": "This method allows you to retrieve user objects.",
    50.                     "parameters": {
    51.                         "users": {
    52.                             "type":        "string",
    53.                             "required":    true,
    54.                             "default":     "",
    55.                             "description": "One or more (comma-separated) Twitter usernames.",
    56.                             "location":    "query"
    57.                         },
    58.                         ":format": {
    59.                             "type":        "string",
    60.                             "required":    true,
    61.                             "default":     "json",
    62.                             "description": "Output format as JSON or XML",
    63.                             "enum": [
    64.                                 "json",
    65.                                 "xml"
    66.                             ],
    67.                             "location":    "pathReplace"
    68.                         }
    69.                     }
    70.                 },
    71.                 "Topics": {
    72.                     "path":        "/users/topics.:format",
    73.                     "httpMethod":  "GET",
    74.                     "description": "This method allows you to retrieve the top 3 topic objects for a given user.",
    75.                     "parameters": {
    76.                         "users": {
    77.                             "type":        "string",
    78.                             "required":    true,
    79.                             "default":     "",
    80.                             "description": "One or more (comma-separated) Twitter usernames.",
    81.                             "location":    "query"
    82.                         },
    83.                         ":format": {
    84.                             "type":        "string",
    85.                             "required":    true,
    86.                             "default":     "json",
    87.                             "description": "Output format as JSON or XML",
    88.                             "enum": [
    89.                                 "json",
    90.                                 "xml"
    91.                             ],
    92.                             "location":    "pathReplace"
    93.                         }
    94.                     }
    95.                 }
    96.             }
    97.         },
    98.         "Relationship Methods": {
    99.             "methods": {
    100.                 "Influenced By": {
    101.                     "path":        "/soi/influenced_by.:format",
    102.                     "httpMethod":  "GET",
    103.                     "description": "This method allows you to retrieve up to 5 user score pairs for users that are influenced by the given influencer.",
    104.                     "parameters": {
    105.                         "users": {
    106.                             "type":        "string",
    107.                             "required":    true,
    108.                             "default":     "",
    109.                             "description": "One or more (comma-separated) Twitter usernames.",
    110.                             "location":    "query"
    111.                         },
    112.                         ":format": {
    113.                             "type":        "string",
    114.                             "required":    true,
    115.                             "default":     "json",
    116.                             "description": "Output format as JSON or XML",
    117.                             "enum": [
    118.                                 "json",
    119.                                 "xml"
    120.                             ],
    121.                             "location":    "pathReplace"
    122.                         }
    123.                     }
    124.                 },
    125.                 "Influencer Of": {
    126.                     "path":        "/soi/influenced_of.:format",
    127.                     "httpMethod":  "GET",
    128.                     "description": "This method allows you to retrieve up to 5 user score pairs for users that are influencers of the given user.",
    129.                     "parameters": {
    130.                         "users": {
    131.                             "type":        "string",
    132.                             "required":    true,
    133.                             "default":     "",
    134.                             "description": "One or more (comma-separated) Twitter usernames.",
    135.                             "location":    "query"
    136.                         },
    137.                         ":format": {
    138.                             "type":        "string",
    139.                             "required":    true,
    140.                             "default":     "json",
    141.                             "description": "Output format as JSON or XML",
    142.                             "enum": [
    143.                                 "json",
    144.                                 "xml"
    145.                             ],
    146.                             "location":    "pathReplace"
    147.                         }
    148.                     }
    149.                 }
    150.             }
    151.         }
    152.     }
    153. }

  3. Chris Hansen – 2 years ago

    Kelly, the new schema looks like it has some great improvements. Can you provide a link to the new version? https://github.com/mashery/io-docs is not found. Thanks.

  4. ManDevPro – 2 years ago

    Hi Chris, are you trying to configure the open-source version of I/O Docs or the Mashery dashboard configured version of I/O Docs? We have not yet migrated the open-source project with the capability of reading in the new JSON format we introduced with our Mashery product release. Feel free to reach out directly to me via e-mail: neil at mashery dot com.

  5. Louis St-Amour, BiblioCommons – 2 months ago

    For those hunting for it, the PDF guide with updated auth section is here: http://support.mashery.com/files/Mashery_IO_Docs_Configuration_Guide_11132012.pdf

[ Page 1 of 1 ]

Please sign in to add a post.