Pulp

Yes we need a way to have a plugin provide a view at a URL like /mytoplevelview/ This comes from the live API MVP requirements since some content APIs have hard-coded expectations. This may make some plugins incompatible but that's because their live APIs fundamentally are. I can't give an example because the idea of colliding viewsets is still a theoretical problem.

I'm +1 on option 2. I think it would be good for core to document a recommended a convention whereby plugin views are namespaced by plugin name.

I do not think we need a way to enforce or guarantee that plugin views won't collide.

I think it would be nice to prevent collisions, but for the time being Option 2 seems good.

In addition to "encouraging namespacing" we could encourage a specific convention.

@asmacdo, +1. What about for a convention we use /api/v3/plugin/<plugin name>/.../? So like /api/v3/plugin/ansible/something/.

I like the story as it's written.

Which page in the docs is this going on? I couldn't find a section on "adding Live APIs". If not we should add one along w/ this ticket. Or maybe another docs piece of work is adding something like that?

Also another idea: since /api/v3/ is kind of popular maybe the Pulp prefix should be be /pulpapi/v3/ instead?

I moved the renaming idea to its own issue: https://pulp.plan.io/issues/3532

I'm imagining that the scope of this is much larger than just Live APIs so I think it would be best to either add this to the plugins/plugin-writer/basics.rst under an "API routes" section or maybe add a completely new page about how to define new routes/views in plugins.

I think a topic this important would benefit from its own page.

My current plan is not to include live-api docs in the main plugin writer walkthrough, instead to include it in a reference section, which will be be linked to at the end of the walkthrough as "next steps" or "advanced".

Please open a PR to a feature branch for plugin-writer docs:
https://github.com/asmacdo/plugin_template/tree/add-plugin-writer-docs

The change should go here:
https://github.com/asmacdo/plugin_template/blob/add-plugin-writer-docs/docs/plugin-writer/reference/live-api.rst

Note, please review whats already there. I'm not sure its correct to say that this is primarily a publishing thing.