[Pulp-dev] REST API Milestone/alpha?

[Brian Bouterse]

+1 to working towards a REST API alpha overall. I am happy enough with the
URLs structure. FYI I think the status API is missing from there maybe.

Is it possible for us to get the API docs auto generating and posted online
in the nightly docs? That way as we continue to change them, the nightly
docs will always be up to date. I remember this effort being started but
I'm not sure where we are at with it. Do we have redmine tasks for this?

Also for the browsable docs that you get on a Pulp3 installation, is it
documented how to configure Pulp so that you have browsable API docs?

I think we should have a quickstart guide that is short because it would
link to the pulp_example instructions [0] which are a good user facing set
of instructions. We could put the quickstart page as a top level page in
the docs even though it would be mostly used to send traffic to the
pulp_example instructions.

[0]:
https://github.com/pulp/pulp_example/blob/master/README.rst#create-a-repository-foo

-Brian



On Thu, Oct 5, 2017 at 12:49 PM, Austin Macdonald <austin at redhat.com> wrote:

> I think we are ready to start considering an alpha for our REST API. (REST
> API and plugin API are versioned separately.) I've started a list of all
> our endpoints along with accepted methods and the expected responses. I
> hope this list will be useful for QE as well.
>
> http://pad-katello.rhcloud.com/p/pulp3_REST_API
>
> The questions that I have:
>
>    1. Which other endpoints do we need to add before an alpha of the REST
>    API? (Publications?)
>    2. Are we happy with the general structure?
>    3. What else should we do before we call it an alpha?
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/pulp-dev/attachments/20171005/bc43d97a/attachment.htm>