Uploaded image for project: 'jboss.org'
  1. jboss.org
  2. ORG-1446

Expose Project information as a HTTP API

    XMLWordPrintable

Details

    • Story
    • Resolution: Done
    • Medium
    • None
    • None
    • None
    • None

    Description

      All projects, individually, give JBoss.org information about them selves. Now JBoss.org knows 'everything' about project X, Y, Z. But Project X does not have information about Project Y.

      So instead of Project X asking Project Y for their project information or project properties URL, Point To Point. JBoss.org could provide a API with what it knows. Project X can now ask JBoss.org for the information about Project Y and function like a Hub.

      Example:

      JBoss.org is given ProjectX's URL: http://project.org/api/project.json
      Which could return:

      {
        name: ProjectX
        doc {
          guides: URL,
          reference: URL
        },
        sub_projects: [
          {
            name: ProjectX Sub A 
          },
          {
            name: ProjectX Sub B
          }
        ] 
      }
      

      Same goes for ProjectZ,Y etc

      Now when Project X wants to know what JBoss.org knows, it could call JBoss.org's project URL: http://api.jboss.org/project/

      [
        {
          name: ProjectX
          ...
        },
        {
          name: ProjectZ
          ...
        },
        {
          name: ProjectY
          ...
        }
      ]
      

      JBoss.org would then return a list of all known projects, optionally with a http://api.jboss.org/project/ProjectX as a 'filter' if you only want one specific project.

      {
        name: ProjectX
        ...
      }
      

      Ideally the structure used by the Project to feed jboss.org with information would be the same structure JBoss.org returns in it's APIs (only wrapped as a list notation since we're talking about multiple entries)

      Attachments

        Activity

          People

            dhladky@redhat.com David Hladky
            aslak@redhat.com Aslak Knutsen
            Votes:
            0 Vote for this issue
            Watchers:
            7 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: