Project

Profile

Help

Story #3473

Updated by bmbouter over 3 years ago

Working on the Ansible plugin, I need to define a live api that can serve up Galaxy galaxy metadata. I'm imagining for roles for example, this might live at "/api/v3/roles/" but I have some concerns obviously. Namely, is my url going to conflict with other plugins or pulpcore? Also what docs do I look at to know how to add these urls?

Add a new page called 'Adding Views' as a top-level section of the "Plugin Writer's Guide":https://docs.pulpproject.org/en/3.0/nightly/plugins/plugin-writer/index.html . This some documentation must:

1. Document
about how to define a url endpoint that Pulp core will serve
2. Document
and advise plugin writers to namespace their Live API routes whenever possible to:

<pre>
v3/plugins/<plugin_type>/something/
</pre>

Back