story #7684 access to wiki pages with REST API

Artifact

Summary

As a

phpwiki user

I want to *

access to wiki pages with REST API

So that

I can automate document extraction when building my product

We need to integrate some wiki pages in batch mode into another portal in order to not duplicate the documentation effort on a project.
This currently blocks us in authoring further browsable documentation in the codendi wiki, or we may have to duplicate the wiki authoring, which is very unfortunate.

Acceptance criteria

Add into /v1/projects/:id resources

{
    "type": "phpwiki",
    "uri": "projects/:id/phpwiki"
}

OPTIONS /v1/projects/:id/phpwiki
GET /v1/projects/:id/phpwiki
{
    "pages": [
        {
            "id": 1234,
            "uri": "phpwiki/1234",
            "name": "HomePage",
        },
        {
            "id": 5464,
            "uri": "phpwiki/5464",
            "name": "Some Other Page",
        },
    ]
}
WARNING -> This route is paginated

GET /v1/projects/:id/phpwiki?pagename=Some+Other+Page
{
    "id": 5464,
    "uri": "/wiki/5464",
    "name": "Some Other FPage",
}

GET /v1/projects/:id/phpwiki?pagename=With
{  
    "pages": [
      {
        "id": 6100,
        "uri": "phpwiki/6100",
        "name": "With Space"
      },
      {
        "id": 6097,
        "uri": "phpwiki/6097",
        "name": "WithContent"
      }
    ]
}

OPTIONS /v1/phpwiki/5464
GET /v1/phpwiki/5464
{
    "id": 5464,
    "uri": "/wiki/5464",
    "name": "Some Other Page",
    "last_version": 2,
    "versions": [
        {
            "id": "1",
            "uri": "phpwiki/5464/versions?version_id=1"
        },
        {
            "id": "2",
            "uri": "phpwiki/5464/versions?version_id=2"
        }
    ]
}

OPTIONS phpwiki/5464/versions?version_id=2
GET phpwiki/5464/versions?version_id=2

{

    "id": 5464,
    "uri": "phpwiki/5464/versions?version_id=2",
    "wiki_content": "_My content in italic_",

    "formatted_content": "<div class ....> <i> My content in italic </i> ... </div>"

}

In order to have your HTML content, you can simply do a "json_decode" on the formatted content.

Accept: "text/html" GET /wiki/5464/2
-> returns the content in HTML

WARNING: this route relies on HTTP content negociation (Accept header) to return HTML (instead of param).

AttachmentsEmpty

CC listNouha Terzi (terzino), Hanen Ben Elarbi (Hanen)

Status

CategoryEmpty

StatusDone

Development

Checklist

[ ] Does it involves User Interface?
[ ] Are there any mockups?
[ ] Are permissions checked?
[ ] Does it need Javascript development?
[ ] Does it need a forge upgrade bucket?
[ ] Does it need to execute things in system events?
[ ] Does it impact project creation (templates)?
[ ] Is it exploratory?

Technical informationsEmpty

Details

Artifact ID#7684

Submitted ByManuel Vacelet (vaceletm)

Last Modified On2015-05-26 17:19

Submitted On2014-12-11 09:07

Rank7682

Permissions

Restrict access to this artifact for the following user groups:

References

Is related to

Artifact links

Empty

Reverse artifact links

Releases

Cross References

Referencing story #7684

Artifact Tracker v5

rel #8037 8.2

Git commit

tuleap/tuleap/stable

Merge commit 'refs/changes/49/3949/3' of ssh://gerrit.tuleap.net:29418/tuleap into HEAD bc9ddc5185

Martin GOYOT (goyotm) , 2015-05-13 16:39

story #7684 access to wiki pages with REST API dbaeabe587

Yannis ROSSETTO (rossettoy) , 2015-05-13 14:45

Merge commit 'refs/changes/63/3963/5' of ssh://gerrit.tuleap.net:29418/tuleap into HEAD b852b068da

dylan bowden (dylan) , 2015-05-19 10:14

story #7684: Add wiki/:pageid route 3d4f7cb2f8

Yannis ROSSETTO (rossettoy) , 2015-05-18 15:07

Merge commit 'refs/changes/66/3966/3' of ssh://gerrit.tuleap.net:29418/tuleap into HEAD 976cdb3786

dylan bowden (dylan) , 2015-05-19 10:20

story #7684: Add projects/:id/wiki?pagename 4d93018f53

Yannis ROSSETTO (rossettoy) , 2015-05-18 15:44

Merge commit 'refs/changes/75/3975/11' of ssh://gerrit.tuleap.net:29418/tuleap into HEAD 4b2f75c6de

dylan bowden (dylan) , 2015-05-26 08:40

story #7684: Add route phpwiki/:pageid/versions 72e4f47118

Yannis ROSSETTO (rossettoy) , 2015-05-25 18:01

Show items referenced by story #7684

Referenced by story #7684

Other

gerrit #3963

gerrit #3966

Follow-ups

Manuel Vacelet (vaceletm)

2015-05-26 17:19

Status changed from On going to Done
Category set to

Yannis ROSSETTO (rossettoy)

2015-05-25 10:56

Acceptance criteria

Something went wrong, the follow up content couldn't be loaded

Only formatting have been changed, you should switch to markup to see the changes

Manuel Vacelet (vaceletm)

2015-05-25 10:27

Status changed from Ready (stalled) to On going

Yannis ROSSETTO (rossettoy)

2015-05-20 08:40

Thanks @Hanen for your answer.

Just to keep you informed, we are currently facing a lot of issue regarding the HTML generated content.
To be simple, PhpWiki does not generate HTML, but some objects that are converted to HTML by the PhpWiki themes ! And requesting a PhpWiki theme outside of Tuleap's PhpWiki scope (REST) is not straightforward and the tool (PhpWiki) is not developed to give some data outside of its scope.

We will try to find another solution in order to have this HTML content.

Hanen Ben Elarbi (Hanen)

2015-05-19 18:18

Hello Yannis,

We would need to have an access to the wiki pages from command line interface.
We need to integrate some wiki pages in batch mode into another portal in order to not duplicate the documentation effort on a project.
Thus the requested functionality is to get an HTML interpreted version of a wiki page from the command line

Best regards,
Hanen

Yannis ROSSETTO (rossettoy)

2015-05-19 11:49

last edited by: Yannis ROSSETTO (rossettoy)

2015-05-19 12:07

Hello STTeam,

I've got a question about GET wiki/:pageid/version. What kind of content do you want ? Basic content or HTML interpreted content ?

I ask for this because there is some issues :

We can have HTML interpreted (with a crappy PHPWiki object) only for the page's last version (other version content is linked to PHPWiki theme to retrieve the HTML, whereas last version serialized HTML content is stored in DB)
The HTML have a lot of CSS classes linked to PHPWiki theme. So you will not have the same output as you can see in the screen.

So it's easy for us to give you the content not interpreted, but we are not confident about having HTML result that will be really useful.

In addition of that, to fully understand your needs, can you describe us precisely (step-by-step) what are you doing today manually with these wiki pages that you want to automate with REST ? Because we don't understand what you want to achieve with raw HTML.

dylan bowden (dylan)

2015-05-19 10:18

last edited by: dylan bowden (dylan)

2015-05-26 08:42

see gerrit #3963, gerrit #3966 and gerrit #3975

Yannis ROSSETTO (rossettoy)

2015-05-15 16:11

last edited by: Yannis ROSSETTO (rossettoy)

2015-05-15 17:10

Regarding pages with spaces in name, we propose something with url encode:

Page = With Space
curl -XGET "http://sonde.cro.enalean.com/api/v1/projects/255/wiki?pagename=With+Space"
{
"pages": [
{
"id": 6100,
"uri": "wiki/6100",
"name": "With+Space"
}
]
}

Example with +

Page = Page+r
curl -XGET -"http://sonde.cro.enalean.com/api/v1/projects/255/wiki?pagename=Page%2Br"
{
"pages": [
{
"id": 6103,
"uri": "wiki/6103",
"name": "Page%2Br"
}
]
}

Example with no space:

Page = WithContent
curl -XGET "http://sonde.cro.enalean.com/api/v1/projects/255/wiki?pagename=WithContent"
{
"pages": [
{
"id": 6097,
"uri": "wiki/6097",
"name": "WithContent"
}
]
}

Other question for the version content. Is it OK for you to have something like this ?
{
"id": "1",
"uri": "/wiki/5464/version?id=1"
"content": "<h1> My content </h1> <p> This is my content <a> with a link </a> </p>"
}

The content will contain HTML interpreted version content.

Hanen Ben Elarbi (Hanen)

2015-05-14 12:22

Hello Yannis,

1. How to deal with PhpWiki special pages ?
We have no special recommendation for PhpWiki special pages.
2. No, we don't need special characters. We want to get a readable page name: "Some/Other/Page" instead of "Some%2FOther%2FPage".
3. Yes, it's OK.
4. Yes.

Best regards,
Hanen

Yannis ROSSETTO (rossettoy)

2015-05-13 17:02

CC list set to Hanen Ben Elarbi (Hanen), Nouha Terzi (terzino)

Yannis ROSSETTO (rossettoy)

2015-05-13 17:00

Hello ST team,

I've got few questions:

* How to deal with PhpWiki special pages ?
* In your example, you said "Some%2FOther%2FPage". "Some Other Page" is OK for you or your need these '%2F' special characters ?
* Regarding /wiki/:pageid/ for version, we want to do /wiki/:pageid/version?id=:versionid (in order to match all existing routes behavior). Is it OK for you ?
* For the route /wiki/:pageid/version?id=:versionid, we want to return something like :

{
"id": "1",
"uri": "/wiki/5464/version?id=1"
"content": %THE PAGE CONTENT%
}

Is it OK ?

Manuel Vacelet (vaceletm)

2014-12-11 15:31

Acceptance criteria

Something went wrong, the follow up content couldn't be loaded

Only formatting have been changed, you should switch to markup to see the changes

Public

Artifact links

Reverse artifact links

Releases

Referencing story #7684

Artifact Tracker v5

Git commit

tuleap/tuleap/stable

Referenced by story #7684

Other

Follow-ups