Skip to content

fix: point the api index page into GitHub instead of trac/svn #3627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jennifer-richards merged 1 commit into from
Mar 11, 2022
Merged

fix: point the api index page into GitHub instead of trac/svn #3627

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 4 additions & 14 deletions ietf/templates/api/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,11 @@ <h3 id="framework" class="anchor-target">Framework API</h3>
to generate an API which mirrors the Django ORM (Object Relational Mapping)
for the database. Each Django model class maps down to the SQL database
tables and up to the API. The Django models classes are defined in the
models.py files of the datatracker:
</p>

<p>
<a href="http://svn.ietf.org/svn/tools/ietfdb/trunk/ietf/doc/models.py">https://svn.ietf.org/svn/tools/ietfdb/trunk/ietf/doc/models.py</a>
<br>
<a href="http://svn.ietf.org/svn/tools/ietfdb/trunk/ietf/group/models.py">https://svn.ietf.org/svn/tools/ietfdb/trunk/ietf/group/models.py</a>
<br>
<a href="http://svn.ietf.org/svn/tools/ietfdb/trunk/ietf/iesg/models.py">http://svn.ietf.org/svn/tools/ietfdb/trunk/ietf/iesg/models.py</a>
<br>
&hellip;

models.py files of the datatracker. Browse the <a href="https://github.com/ietf-tools/datatracker">code tree</a>
for the models file in each app (such as <a href="https://github.com/ietf-tools/datatracker/blob/main/ietf/doc/models.py">ietf/doc/models.py</a>,
<a href="https://github.com/ietf-tools/datatracker/blob/main/ietf/group/models.py">ietf/group/models.py</a>, &hellip;).
</p>
<p>

The API top endpoint is at <a href="https://datatracker.ietf.org/api/v1/">https://datatracker.ietf.org/api/v1/</a>. The top
endpoint lists inferior endpoints, and thus permits some autodiscovery,
but there's really no substitute for looking at the actual ORM model classes.
Expand All @@ -45,7 +35,7 @@ <h3 id="framework" class="anchor-target">Framework API</h3>

<a href="https://datatracker.ietf.org/api/v1/group/group/">https://datatracker.ietf.org/api/v1/group/group/</a>
<br>
<a href="https://trac.ietf.org/trac/ietfdb/browser/trunk/ietf/group/models.py">https://trac.ietf.org/trac/ietfdb/browser/trunk/ietf/group/models.py</a>
<a href="https://github.com/ietf-tools/datatracker/blob/main/ietf/group/models.py">ietf/group/models.py</a>

</p>
<p>
Expand Down