Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-04 23:17:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Evennia docbuilder action 2022-10-23 09:04:07 +00:00
parent 478c0b6473
commit 0e0cd24694
958 changed files with 41858 additions and 39649 deletions
Download patch file Download diff file Expand all files Collapse all files

54
docs/1.0-dev/api/evennia.web.api.urls.html
View file

@ -47,33 +47,8 @@
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.web.api.urls">
<span id="evennia-web-api-urls"></span><h1>evennia.web.api.urls<a class="headerlink" href="#module-evennia.web.api.urls" title="Permalink to this headline"></a></h1>
<p>The Django Rest Framework provides a way of generating urls for different
views that implement standard CRUD operations in a quick way, using ‘routers’
and ‘viewsets’. A viewset implements standard CRUD actions and any custom actions
that you want, and then a router will automatically generate URLs based on the
actions that it detects for a viewset. For example, below we create a DefaultRouter.
We then register ObjectDBViewSet, a viewset for CRUD operations for ObjectDB
instances, to the ‘objects’ base endpoint. That will generate a number of URLs
like the following:</p>
<p>list objects: action: GET, url: /objects/, view name: object-list
create object: action: POST, url: /objects/, view name: object-list
retrieve object: action: GET, url: /objects/&lt;:pk&gt;, view name: object-detail
update object: action: POST, url: /objects/&lt;:pk&gt;, view name: object-detail
delete object: action: DELETE, url: /objects/&lt;:pk&gt;, view name: object-detail
set attribute: action: POST, url: /objects/&lt;:pk&gt;/set-attribute, view name: object-set-attribute</p>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
@ -120,7 +95,32 @@ set attribute: action: POST, url: /objects/&lt;:pk&gt;/set-attribute, view nam
</div>
</div>
<div class="clearer"></div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.web.api.urls">
<span id="evennia-web-api-urls"></span><h1>evennia.web.api.urls<a class="headerlink" href="#module-evennia.web.api.urls" title="Permalink to this headline"></a></h1>
<p>The Django Rest Framework provides a way of generating urls for different
views that implement standard CRUD operations in a quick way, using ‘routers’
and ‘viewsets’. A viewset implements standard CRUD actions and any custom actions
that you want, and then a router will automatically generate URLs based on the
actions that it detects for a viewset. For example, below we create a DefaultRouter.
We then register ObjectDBViewSet, a viewset for CRUD operations for ObjectDB
instances, to the ‘objects’ base endpoint. That will generate a number of URLs
like the following:</p>
<p>list objects: action: GET, url: /objects/, view name: object-list
create object: action: POST, url: /objects/, view name: object-list
retrieve object: action: GET, url: /objects/&lt;:pk&gt;, view name: object-detail
update object: action: POST, url: /objects/&lt;:pk&gt;, view name: object-detail
delete object: action: DELETE, url: /objects/&lt;:pk&gt;, view name: object-detail
set attribute: action: POST, url: /objects/&lt;:pk&gt;/set-attribute, view name: object-set-attribute</p>
</section>
</div>
</div>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>