templates: relayout endpoint description with proper padding (#43039)

This commit is contained in:
Frédéric Péters 2020-05-18 22:48:08 +02:00
parent 8274541262
commit c7b387f4eb
13 changed files with 166 additions and 158 deletions

View File

@ -11,37 +11,37 @@ Service URL : {{ object.service_url }}
<ul class="endpoints">
{% url 'bdp-resources' slug=object.slug resources='resources' as resources_url%}
<li class="get-method">
<span class="description">{% trans 'Listing resources:' %}</span>
<a class="example-url" href="{{ resources_url }}">{{ resources_url }}</a>
<div class="description"><span class="description--label">{% trans 'Listing resources:' %}</span>
<a class="example-url" href="{{ resources_url }}">{{ resources_url }}</a></div>
</li>
{% url 'bdp-post-adherent' slug=object.slug as adherent_url%}
<li class="post-method">
<span class="description">{% trans 'Creating a new user:' %}</span>
<a class="example-url" href="adherent_url" >{{ adherent_url }}</a>
<div class="description"><span class="description--label">{% trans 'Creating a new user:' %}</span>
<a class="example-url" href="adherent_url" >{{ adherent_url }}</a></div>
</li>
</ul>
<h3>{% trans 'Examples' %}</h3>
<ul class="endpoints">
<li class="get-method">
<span class="description">{% trans 'Libraries:' %}</span>
<div class="description"><span class="description--label">{% trans 'Libraries:' %}</span>
<a class="example-url" href="{{ site_base_uri }}{% url 'bdp-resources' slug=object.slug resources='bibliotheques' %}"
>{{ site_base_uri }}{% url 'bdp-resources' slug=object.slug resources='bibliotheques' %}</a>
>{{ site_base_uri }}{% url 'bdp-resources' slug=object.slug resources='bibliotheques' %}</a></div>
</li>
{% url 'bdp-resources' slug=object.slug resources='bibliotheques' as bibliotheques_url %}
<li class="get-method">
<span class="description">{% trans 'Libraries with a text label:' %}</span>
<a class="example-url" href="{{ bibliotheques_url }}?text_key=nom">{{ bibliotheques_url }}?text_key=nom</a>
<div class="description"><span class="description--label">{% trans 'Libraries with a text label:' %}</span>
<a class="example-url" href="{{ bibliotheques_url }}?text_key=nom">{{ bibliotheques_url }}?text_key=nom</a></div>
</li>
{% url 'bdp-resources' slug=object.slug resources='adherents' as adherents_url %}
<li class="get-method">
<span class="description">{% trans 'Members:' %}</span>
<a class="example-url" href="{{ adherents_url }}">{{ adherents_url }}</a>
<div class="description"><span class="description--label">{% trans 'Members:' %}</span>
<a class="example-url" href="{{ adherents_url }}">{{ adherents_url }}</a></div>
</li>
{% url 'bdp-resources' slug=object.slug resources='adherents' as adherents_filter_url %}
<li class="get-method">
<span class="description">{% trans 'Filtered Members:' %}</span>
<a class="example-url" href="{{ adherents_filter_url }}?filter[0][field]=email&filter[0][operator]=eq&filter[0][value]=login@example.net">{{ adherents_filter_url }}?filter[0][field]=email&filter[0][operator]=eq&filter[0][value]=login@example.net</a>
<div class="description"><span class="description--label">{% trans 'Filtered Members:' %}</span>
<a class="example-url" href="{{ adherents_filter_url }}?filter[0][field]=email&filter[0][operator]=eq&filter[0][value]=login@example.net">{{ adherents_filter_url }}?filter[0][field]=email&filter[0][operator]=eq&filter[0][value]=login@example.net</a></div>
</li>
</ul>

View File

@ -10,36 +10,36 @@ Server: {{ object.server }}
{% block endpoints %}
<ul class="endpoints">
<li class="get-method">
<span class="description">{% trans 'Listing all sets:' %}</span>
<div class="description"><span class="description--label">{% trans 'Listing all sets:' %}</span>
{% url 'generic-endpoint' connector="clicrdv" slug=object.slug endpoint="interventionsets" slug=object.slug as interventionsets_url %}
<a class="example-url" href="{{ interventionsets_url }}">{{ site_base_uri }}{{ interventionsets_url }}</a>
<a class="example-url" href="{{ interventionsets_url }}">{{ site_base_uri }}{{ interventionsets_url }}</a></div>
</li>
<li class="get-method">
<span class="description">{% trans 'Listing interventions in a set:' %}</span>
<a class="example-url" href="{{ interventionsets_url }}">{{ site_base_uri }}{{ interventionsets_url }}/<i>&lt;set_id&gt;</i></a>
<div class="description"><span class="description--label">{% trans 'Listing interventions in a set:' %}</span>
<a class="example-url" href="{{ interventionsets_url }}">{{ site_base_uri }}{{ interventionsets_url }}/<i>&lt;set_id&gt;</i></a></div>
</li>
<li class="get-method">
{% url 'clicrdv-view' slug=object.slug as view_url %}
<span class="description">{% trans 'Listing of free dates and times for an intervention:' %}</span>
<a class="example-url">{{ site_base_uri }}{{ view_url }}interventions/<i>&lt;intervention_id&gt;</i>/datetimes</a></a>
<div class="description"><span class="description--label">{% trans 'Listing of free dates and times for an intervention:' %}</span>
<a class="example-url">{{ site_base_uri }}{{ view_url }}interventions/<i>&lt;intervention_id&gt;</i>/datetimes</a></a></div>
</li>
<li class="get-method">
<span class="description">{% trans 'Listing of free dates for an intervention:' %}</span>
<a class="example-url">{{ site_base_uri }}{{ view_url }}interventions/<i>&lt;intervention_id&gt;</i>/dates</a>
<div class="description"><span class="description--label">{% trans 'Listing of free dates for an intervention:' %}</span>
<a class="example-url">{{ site_base_uri }}{{ view_url }}interventions/<i>&lt;intervention_id&gt;</i>/dates</a></div>
</li>
<li class="get-method">
<span class="description">{% trans 'Listing of free times a given date for an intervention:' %}</span>
<a class="example-url">{{ site_base_uri }}{{ view_url }}interventions/<i>&lt;intervention_id&gt;</i>/<i>&lt;date&gt;</i></a>
<div class="description"><span class="description--label">{% trans 'Listing of free times a given date for an intervention:' %}</span>
<a class="example-url">{{ site_base_uri }}{{ view_url }}interventions/<i>&lt;intervention_id&gt;</i>/<i>&lt;date&gt;</i></a></div>
</li>
<li class="post-method">
{% url 'clicrdv-create-appointment-qs' slug=object.slug as create_appointment_url %}
<span class="description">{% trans 'Creating a new appointment:' %}</span>
<a class="example-url" href="{{ create_appointment_url }}">{{ site_base_uri }}{{ create_appointment_url }}</a>
<div class="description"><span class="description--label">{% trans 'Creating a new appointment:' %}</span>
<a class="example-url" href="{{ create_appointment_url }}">{{ site_base_uri }}{{ create_appointment_url }}</a></div>
</li>
<li class="get-method">
{% url 'clicrdv-cancel-appointment' slug=object.slug appointment_id='000' as appointment_cancel_url %}
<span class="description">{% trans 'Cancelling an appointment:' %}</span>
<a class="example-url">{{ site_base_uri }}{{ view_url }}<i>&lt;appointment_id&gt;</i>/cancel</a>
<div class="description"><span class="description--label">{% trans 'Cancelling an appointment:' %}</span>
<a class="example-url">{{ site_base_uri }}{{ view_url }}<i>&lt;appointment_id&gt;</i>/cancel</a></div>
</li>
</ul>
{% endblock %}

View File

@ -16,16 +16,16 @@
<ul class="endpoints">
{% url 'generic-endpoint' connector='csvdatasource' slug=object.slug endpoint='data' as csvdatasource_data_url %}
<li class="get-method">
<span class="description">{% trans "Returning all file lines:" %}</span>
<a class="example-url" href="{{ csvdatasource_data_url }}">{{ csvdatasource_data_url }}</a>
<div class="description"><span class="description--label">{% trans "Returning all file lines:" %}</span>
<a class="example-url" href="{{ csvdatasource_data_url }}">{{ csvdatasource_data_url }}</a></div>
</li>
<li class="get-method">
<span class="description">{% trans "Returning lines containing 'abc' in 'text' column (case insensitive):" %}</span>
<a class="example-url" href="{{ csvdatasource_data_url }}?q=abc">{{ csvdatasource_data_url }}?q=abc</a>
<div class="description"><span class="description--label">{% trans "Returning lines containing 'abc' in 'text' column (case insensitive):" %}</span>
<a class="example-url" href="{{ csvdatasource_data_url }}?q=abc">{{ csvdatasource_data_url }}?q=abc</a></div>
</li>
{% for query in object.queries.all %}
<li class="get-method"><span class="description">{{ query.label }}:</span>
<a class="example-url" href="{% url 'generic-endpoint' connector='csvdatasource' slug=object.slug endpoint='query' rest=query.slug %}/">{% url 'generic-endpoint' connector='csvdatasource' slug=object.slug endpoint='query' rest=query.slug %}/</a>
<li class="get-method"><div class="description"><span class="description--label">{{ query.label }}:</span>
<a class="example-url" href="{% url 'generic-endpoint' connector='csvdatasource' slug=object.slug endpoint='query' rest=query.slug %}/">{% url 'generic-endpoint' connector='csvdatasource' slug=object.slug endpoint='query' rest=query.slug %}/</a></div>
{% if query.description %}&mdash; {{ query.description }}{% endif %}
</li>
{% endfor %}

View File

@ -6,56 +6,56 @@
<ul class="endpoints">
<li class="get-method">
{% url 'generic-endpoint' connector='family' slug=object.slug endpoint='family' rest='link/' as link_url %}
<span class="description">{% trans 'Link to a family:' %}</span>
<a class="example-url" href="{{ link_url }}">{{ site_base_uri }}{{ link_url }}?NameID=...&login=...&password=...</a>
<div class="description"><span class="description--label">{% trans 'Link to a family:' %}</span>
<a class="example-url" href="{{ link_url }}">{{ site_base_uri }}{{ link_url }}?NameID=...&login=...&password=...</a></div>
</li>
<li class="get-method">
{% url 'generic-endpoint' connector='family' slug=object.slug endpoint='family' rest='unlink/' as unlink_url %}
<span class="description">{% trans 'Unlink from a family:' %}</span>
<a class="example-url" href="{{ unlink_url }}">{{ site_base_uri }}{{ unlink_url }}?NameID=...</a>
<div class="description"><span class="description--label">{% trans 'Unlink from a family:' %}</span>
<a class="example-url" href="{{ unlink_url }}">{{ site_base_uri }}{{ unlink_url }}?NameID=...</a></div>
</li>
<li class="get-method">
{% url 'generic-endpoint' connector='family' slug=object.slug endpoint='family' as family_url %}
<span class="description">{% trans 'Get family informations:' %}</span>
<a class="example-url" href="{{ family_url }}">{{ site_base_uri }}{{ family_url }}?NameID=...</a>
<div class="description"><span class="description--label">{% trans 'Get family informations:' %}</span>
<a class="example-url" href="{{ family_url }}">{{ site_base_uri }}{{ family_url }}?NameID=...</a></div>
</li>
<li class="get-method">
{% url 'generic-endpoint' connector='family' slug=object.slug endpoint='family' rest='adults/' as adults_url %}
<span class="description">{% trans 'Get family adults:' %}</span>
<a class="example-url" href="{{ adults_url }}">{{ site_base_uri }}{{ adults_url }}?NameID=...</a>
<div class="description"><span class="description--label">{% trans 'Get family adults:' %}</span>
<a class="example-url" href="{{ adults_url }}">{{ site_base_uri }}{{ adults_url }}?NameID=...</a></div>
</li>
<li class="get-method">
{% url 'generic-endpoint' connector='family' slug=object.slug endpoint='family' rest='children/' as children_url %}
<span class="description">{% trans 'Get family children:' %}</span>
<a class="example-url" href="{{ children_url }}">{{ site_base_uri }}{{ children_url }}?NameID=...</a>
<div class="description"><span class="description--label">{% trans 'Get family children:' %}</span>
<a class="example-url" href="{{ children_url }}">{{ site_base_uri }}{{ children_url }}?NameID=...</a></div>
</li>
</ul>
<h4>{% trans "Invoices" %}</h4>
<ul class="endpoints">
<li class="get-method">
{% url 'generic-endpoint' connector='family' slug=object.slug endpoint='regie' rest='invoices/' as invoices_url %}
<span class="description">{% trans 'Get payable invoices:' %}</span>
<a class="example-url" href="{{ invoices_url }}">{{ site_base_uri }}{{ invoices_url }}?NameID=...</a>
<div class="description"><span class="description--label">{% trans 'Get payable invoices:' %}</span>
<a class="example-url" href="{{ invoices_url }}">{{ site_base_uri }}{{ invoices_url }}?NameID=...</a></div>
</li>
<li class="get-method">
{% url 'generic-endpoint' connector='family' slug=object.slug endpoint='regie' rest='invoices/history/' as invoices_history_url %}
<span class="description">{% trans 'Get invoices history:' %}</span>
<a class="example-url" href="{{ invoices_history_url }}">{{ site_base_uri }}{{ invoices_history_url }}?NameID=...</a>
<div class="description"><span class="description--label">{% trans 'Get invoices history:' %}</span>
<a class="example-url" href="{{ invoices_history_url }}">{{ site_base_uri }}{{ invoices_history_url }}?NameID=...</a></div>
</li>
<li class="get-method">
{% url 'generic-endpoint' connector='family' slug=object.slug endpoint='regie' rest='invoice/invoice_id/' as invoice_url %}
<span class="description">{% trans 'Get invoice details:' %}</span>
<a class="example-url" href="{{ invoice_url }}">{{ site_base_uri }}{{ invoice_url }}</a>
<div class="description"><span class="description--label">{% trans 'Get invoice details:' %}</span>
<a class="example-url" href="{{ invoice_url }}">{{ site_base_uri }}{{ invoice_url }}</a></div>
</li>
<li class="get-method">
{% url 'generic-endpoint' connector='family' slug=object.slug endpoint='regie' rest='invoice/invoice_id/pdf/' as invoice_pdf_url %}
<span class="description">{% trans 'Get invoice PDF:' %}</span>
<a href="{{ invoice_pdf_url }}">{{ site_base_uri }}{{ invoice_pdf_url }}</a>
<div class="description"><span class="description--label">{% trans 'Get invoice PDF:' %}</span>
<a href="{{ invoice_pdf_url }}">{{ site_base_uri }}{{ invoice_pdf_url }}</a></div>
</li>
<li class="post-method">
{% url 'generic-endpoint' connector='family' slug=object.slug endpoint='regie' rest='invoice/invoice_id/pay/' as invoice_pay_url %}
<span class="description">{% trans 'Pay invoice:' %}</span>
<a class="example-url" href="{{ invoice_pay_url }}">{{ site_base_uri }}{{ invoice_pay_url }}</a>
<div class="description"><span class="description--label">{% trans 'Pay invoice:' %}</span>
<a class="example-url" href="{{ invoice_pay_url }}">{{ site_base_uri }}{{ invoice_pay_url }}</a></div>
</li>
</ul>
{% endblock %}

View File

@ -16,14 +16,14 @@
{% block endpoints %}
<ul class="endpoints">
<li class="get-method"><span class="description">{% trans 'Listing communes:' %}</span> <a class="example-url" href="{% url 'generic-endpoint' connector="gdc" slug=object.slug endpoint="communes" %}"
>{{ site_base_uri }}{% url 'generic-endpoint' connector="gdc" slug=object.slug endpoint="communes" %}</a></li>
<li class="get-method"><span class="description">{% trans 'Listing streets:' %}</span> <a class="example-url" href="{% url 'gdc-voies' slug=object.slug insee=34022%}"
>{{ site_base_uri }}{% url 'gdc-view' slug=object.slug %}/voies/<i>&lt;insee&gt;</i></a></li>
<li class="get-method"><span class="description">{% trans 'Listing subjects:' %}</span> <a class="example-url" href="{% url 'generic-endpoint' connector="gdc" slug=object.slug endpoint="objets" %}"
>{{ site_base_uri }}{% url 'generic-endpoint' connector="gdc" slug=object.slug endpoint="objets" %}</a></li>
<li class="post-method"><span class="description">{% trans 'Posting a new request:' %}</span> <a class="example-url" href="{% url 'gdc-post' slug=object.slug %}"
>{{ site_base_uri }}{% url 'gdc-post' slug=object.slug %}</a></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Listing communes:' %}</span> <a class="example-url" href="{% url 'generic-endpoint' connector="gdc" slug=object.slug endpoint="communes" %}"
>{{ site_base_uri }}{% url 'generic-endpoint' connector="gdc" slug=object.slug endpoint="communes" %}</a></div></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Listing streets:' %}</span> <a class="example-url" href="{% url 'gdc-voies' slug=object.slug insee=34022%}"
>{{ site_base_uri }}{% url 'gdc-view' slug=object.slug %}/voies/<i>&lt;insee&gt;</i></a></div></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Listing subjects:' %}</span> <a class="example-url" href="{% url 'generic-endpoint' connector="gdc" slug=object.slug endpoint="objets" %}"
>{{ site_base_uri }}{% url 'generic-endpoint' connector="gdc" slug=object.slug endpoint="objets" %}</a></div></li>
<li class="post-method"><div class="description"><span class="description--label">{% trans 'Posting a new request:' %}</span> <a class="example-url" href="{% url 'gdc-post' slug=object.slug %}"
>{{ site_base_uri }}{% url 'gdc-post' slug=object.slug %}</a></div></li>
</ul>
{% endblock %}

View File

@ -4,9 +4,9 @@
{% block endpoints %}
<ul class="endpoints">
<li class="post-method">
<span class="description">{%trans 'Create Demand'%}</span>
<div class="description"><span class="description--label">{%trans 'Create Demand'%}</span>
{% url "generic-endpoint" connector="mdel" slug=object.slug endpoint="create" as create %}
<a class="example-url" href="{{create}}">{{create}}</a>
<a class="example-url" href="{{create}}">{{create}}</a></div>
<ul class="params">
<li>ILE-LA PAYLOAD
<div class="body-schemas">
@ -112,9 +112,9 @@
</ul>
</li>
<li class="get-method">
<span class="description">{%trans 'Get Demand Status'%}</span>
<div class="description"><span class="description--label">{%trans 'Get Demand Status'%}</span>
{% url "generic-endpoint" connector="mdel" slug=object.slug endpoint="status" as get_status %}
<a class="example-url" href="{{get_status}}?demand_id=1-14-ILE-LA">{{get_status}}?demand_id=1-14-ILE-LA</a>
<a class="example-url" href="{{get_status}}?demand_id=1-14-ILE-LA">{{get_status}}?demand_id=1-14-ILE-LA</a></div>
<div>
<samp>
{

View File

@ -15,79 +15,79 @@ This API provides an access to <a href="https://www.okina.fr/">Okina</a> API.
{% block endpoints %}
<h4>{% trans 'General' %}</h4>
<ul class="endpoints">
<li class="get-method"><span class="description">{% trans 'Cities:' %}</span> <a class="example-url" href="cities/"
>{{ site_base_uri }}{{ object.get_absolute_url }}cities</a></li>
<li class="get-method"><span class="description">{% trans 'Classes:' %}</span><a class="example-url" href="classes/"
>{{ site_base_uri }}{{ object.get_absolute_url }}classes</a></li>
<li class="get-method"><span class="description">{% trans 'Institutions:' %}</span>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Cities:' %}</span> <a class="example-url" href="cities/"
>{{ site_base_uri }}{{ object.get_absolute_url }}cities</a></div></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Classes:' %}</span><a class="example-url" href="classes/"
>{{ site_base_uri }}{{ object.get_absolute_url }}classes</a></div></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Institutions:' %}</span>
<a class="example-url" href="institutions/"
>{{ site_base_uri }}{{ object.get_absolute_url }}institutions</a></li>
>{{ site_base_uri }}{{ object.get_absolute_url }}institutions</a></div></li>
</ul>
<h4><span class="description">{% trans 'Journeys' %}</h4>
<h4>{% trans 'Journeys' %}</h4>
<ul class="endpoints">
<li class="get-method"><span class="description">{% trans 'Get stop points based on a starting position and an arrival institution (API 2020)' %}</span>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Get stop points based on a starting position and an arrival institution (API 2020)' %}</span>
<a class="example-url" href="search?lat=46.828652&lon=1.701463&institution=277"
>{{ site_base_uri }}{{ object.get_absolute_url }}search?lat=...&lon=...&institution=<i>institution_id</i></a></li>
>{{ site_base_uri }}{{ object.get_absolute_url }}search?lat=...&lon=...&institution=<i>institution_id</i></a></div></li>
<li class="get-method"><span class="description">{% trans 'Institutions in a city (API 2020)' %}</span>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Institutions in a city (API 2020)' %}</span>
<a class="example-url" href="institutions?insee=36005"
>{{ site_base_uri }}{{ object.get_absolute_url }}institutions?insee=<i>city-insee-code</i></a></li>
>{{ site_base_uri }}{{ object.get_absolute_url }}institutions?insee=<i>city-insee-code</i></a></div></li>
<li class="get-method"><span class="description">{% trans 'Institutions accessible from a city:' %}</span>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Institutions accessible from a city:' %}</span>
<a class="example-url" href="institutions/from-city/36005/"
>{{ site_base_uri }}{{ object.get_absolute_url }}institutions/from-city/<i>city-insee-code</i>/</a></li>
>{{ site_base_uri }}{{ object.get_absolute_url }}institutions/from-city/<i>city-insee-code</i>/</a></div></li>
<li class="get-method"><span class="description">{% trans 'Stop areas from a city to an institution:' %}</span>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Stop areas from a city to an institution:' %}</span>
<a class="example-url" href="stop-areas/from-city/36005/to-institution/276/"
>{{ site_base_uri }}{{ object.get_absolute_url }}stop-areas/from-city/<i>city-insee-code</i>/to-institution/<i>institution_id</i>/</a></li>
>{{ site_base_uri }}{{ object.get_absolute_url }}stop-areas/from-city/<i>city-insee-code</i>/to-institution/<i>institution_id</i>/</a></div></li>
<li class="get-method"><span class="description">{% trans 'Origin/Destinations:' %}</span><a class="example-url" href="origin-destinations/"
>{{ site_base_uri }}{{ object.get_absolute_url }}origin-destinations</a></li>
<li class="get-method"><span class="description">{% trans 'Origin/Destinations to an institution:' %}</span>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Origin/Destinations:' %}</span><a class="example-url" href="origin-destinations/"
>{{ site_base_uri }}{{ object.get_absolute_url }}origin-destinations</a></div></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Origin/Destinations to an institution:' %}</span>
<a class="example-url" href="origin-destinations/to-institution/276/"
>{{ site_base_uri }}{{ object.get_absolute_url }}origin-destinations/to-institution/<i>institution_id</i>/</a></li>
<li class="get-method"><span class="description">{% trans 'Origin/Destinations from a stop area to an institution:' %}</span>
>{{ site_base_uri }}{{ object.get_absolute_url }}origin-destinations/to-institution/<i>institution_id</i>/</a></div></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Origin/Destinations from a stop area to an institution:' %}</span>
<a class="example-url" href="origin-destinations/from-stop-area/3282/to-institution/276/"
>{{ site_base_uri }}{{ object.get_absolute_url }}origin-destinations/from-stop-area/<i>stop_area_id</i>/to-institution/<i>institution_id</i>/</a></li>
<li class="get-method"><span class="description">{% trans 'Origin/Destinations from a city to an institution:' %}</span>
>{{ site_base_uri }}{{ object.get_absolute_url }}origin-destinations/from-stop-area/<i>stop_area_id</i>/to-institution/<i>institution_id</i>/</a></div></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Origin/Destinations from a city to an institution:' %}</span>
<a class="example-url" href="origin-destinations/from-city/36005/to-institution/276/"
>{{ site_base_uri }}{{ object.get_absolute_url }}origin-destinations/from-city/<i>city_insee_code</i>/to-institution/<i>institution_id</i></a></li>
<li class="get-method"><span class="description">{% trans 'Origin/Destinations from a city:' %}</span>
>{{ site_base_uri }}{{ object.get_absolute_url }}origin-destinations/from-city/<i>city_insee_code</i>/to-institution/<i>institution_id</i></a></div></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Origin/Destinations from a city:' %}</span>
<a class="example-url" href="origin-destinations/from-city/36005/"
>{{ site_base_uri }}{{ object.get_absolute_url }}origin-destinations/from-city/<i>city_insee_code</i>/</a></li>
>{{ site_base_uri }}{{ object.get_absolute_url }}origin-destinations/from-city/<i>city_insee_code</i>/</a></div></li>
</ul>
<h4><span class="description">{% trans 'Subscriptions' %}</h4>
<h4>{% trans 'Subscriptions' %}</h4>
<ul class="endpoints">
<li class="post-method"><span class="description">{% trans 'Create a subscriber:' %}</span>
<li class="post-method"><div class="description"><span class="description--label">{% trans 'Create a subscriber:' %}</span>
<a class="example-url" href="subscriber/"
>{{ site_base_uri }}{{ object.get_absolute_url }}subscriber/</a>
>{{ site_base_uri }}{{ object.get_absolute_url }}subscriber/</a></div>
<div class="body-schemas">{% trans 'Same payload as for the Okina POST /b2b/subscribers endpoint' %}</div></li>
<li class="get-method"><span class="description">{% trans 'Informations about a subscriber:' %}</span>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Informations about a subscriber:' %}</span>
<a class="example-url" href="subscriber/284/"
>{{ site_base_uri }}{{ object.get_absolute_url }}subscriber/<i>id</i>/</a></li>
<li class="get-method"><span class="description">{% trans "Get subscriber's QR Code:" %}</span>
>{{ site_base_uri }}{{ object.get_absolute_url }}subscriber/<i>id</i>/</a></div></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans "Get subscriber's QR Code:" %}</span>
<a class="example-url" href="subscriber/284/qrcode/"
>{{ site_base_uri }}{{ object.get_absolute_url }}subscriber/<i>id</i>/qrcode/</a></li>
<li class="post-method"><span class="description">{% trans 'Create a subscription:' %}</span>
>{{ site_base_uri }}{{ object.get_absolute_url }}subscriber/<i>id</i>/qrcode/</a></div></li>
<li class="post-method"><div class="description"><span class="description--label">{% trans 'Create a subscription:' %}</span>
<a class="example-url" href="subscription/"
>{{ site_base_uri }}{{ object.get_absolute_url }}subscription/</a>
>{{ site_base_uri }}{{ object.get_absolute_url }}subscription/</a></div>
<div class="body-schemas">{% trans 'Same payload as for the Okina POST /b2b/subscriptions endpoint' %}</div></li>
<li class="get-method"><span class="description">{% trans 'Informations about a subscription:' %}</span>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Informations about a subscription:' %}</span>
<a class="example-url" href="subscription/283/"
>{{ site_base_uri }}{{ object.get_absolute_url }}subscription/<i>id</i>/</a></li>
>{{ site_base_uri }}{{ object.get_absolute_url }}subscription/<i>id</i>/</a></div></li>
</ul>
<h4><span class="description">{% trans 'Topology' %}</h4>
<h4>{% trans 'Topology' %}</h4>
<ul class="endpoints">
<li class="get-method"><span class="description">{% trans 'Lines:' %}</span><a class="example-url" href="topology/lines/"
>{{ site_base_uri }}{{ object.get_absolute_url }}topology/lines/</a></li>
<li class="get-method"><span class="description">{% trans 'Networks:' %}</span><a class="example-url" href="topology/networks/"
>{{ site_base_uri }}{{ object.get_absolute_url }}topology/networks/</a></li>
<li class="get-method"><span class="description">{% trans 'Vehicle journeys:' %}</span><a class="example-url" href="topology/vehicle-journeys/"
>{{ site_base_uri }}{{ object.get_absolute_url }}topology/vehicle-journeys/</a></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Lines:' %}</span><a class="example-url" href="topology/lines/"
>{{ site_base_uri }}{{ object.get_absolute_url }}topology/lines/</a></div></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Networks:' %}</span><a class="example-url" href="topology/networks/"
>{{ site_base_uri }}{{ object.get_absolute_url }}topology/networks/</a></div></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Vehicle journeys:' %}</span><a class="example-url" href="topology/vehicle-journeys/"
>{{ site_base_uri }}{{ object.get_absolute_url }}topology/vehicle-journeys/</a></div></li>
</ul>
{% endblock %}

View File

@ -7,52 +7,53 @@
{% block endpoints %}
<ul class="endpoints">
{% url 'generic-endpoint' connector='iparapheur' slug=object.slug endpoint='wsdl' as wsdl_url %}
<li class="get-method"><span class="description">{% trans 'Download WSDL file:' %}</span>
<a class="example-url" href="{{ wsdl_url }}">{{ site_base_uri }}{{ wsdl_url }}</a>[?debug]
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Download WSDL file:' %}</span>
<a class="example-url" href="{{ wsdl_url }}">{{ site_base_uri }}{{ wsdl_url }}</a>[?debug]</div>
</li>
{% url 'generic-endpoint' connector='iparapheur' slug=object.slug endpoint='ping' as ping_url %}
<li class="get-method"><span class="description">{% trans 'Check WS availability:' %}</span>
<a class="example-url" href="{{ ping_url }}">{{ site_base_uri }}{{ ping_url }}</a>[?debug]
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Check WS availability:' %}</span>
<a class="example-url" href="{{ ping_url }}">{{ site_base_uri }}{{ ping_url }}</a>[?debug]</div>
</li>
{% url 'generic-endpoint' connector='iparapheur' slug=object.slug endpoint='types' as types_url %}
<li class="get-method"><span class="description">{% trans 'Get technical types:' %}</span>
<a class="example-url" href="{{ types_url }}">{{ site_base_uri }}{{ types_url }}</a>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Get technical types:' %}</span>
<a class="example-url" href="{{ types_url }}">{{ site_base_uri }}{{ types_url }}</a></div>
</li>
{% url 'generic-endpoint' connector='iparapheur' slug=object.slug endpoint='subtypes' as subtypes_url %}
<li class="get-method"><span class="description">{% trans 'Get sub types of a given technical type:' %}</span>
<a class="example-url" href="{{ subtypes_url }}">{{ site_base_uri }}{{ subtypes_url }}</a>[?type=type]</li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Get sub types of a given technical type:' %}</span>
<a class="example-url" href="{{ subtypes_url }}">{{ site_base_uri }}{{ subtypes_url }}</a>[?type=type]</div>
</li>
<li class="get-method">
{% url 'generic-endpoint' connector='iparapheur' slug=object.slug endpoint='files' as files_url %}
<span class="description">{% trans 'List files by status:' %}</span>
<a class="example-url" href="{{ files_url }}">{{ site_base_uri }}{{ files_url }}</a>[?status=status]
<div class="description"><span class="description--label">{% trans 'List files by status:' %}</span>
<a class="example-url" href="{{ files_url }}">{{ site_base_uri }}{{ files_url }}</a>[?status=status]</div>
</li>
<li class="post-method">
{% url 'generic-endpoint' connector='iparapheur' slug=object.slug endpoint='create-file' as create_file_url %}
<span class="description">{% trans 'Create file:' %}</span>
<a class="example-url" href="{{ create_file_url }}">{{ site_base_uri }}{{ create_file_url }}</a>
<p><span class="description">{% trans "In the payload" %}
<div class="description"><span class="description--label">{% trans 'Create file:' %}</span>
<a class="example-url" href="{{ create_file_url }}">{{ site_base_uri }}{{ create_file_url }}</a></div>
<p>{% trans "In the payload" %}
<ul>
<li><em>type</em> - <span class="description">{% trans "file type" %}</li>
<li><em>subtype</em> - <span class="description">{% trans "file subtype" %}</li>
<li><em>title</em> - <span class="description">{% trans "file title" %}</li>
<li><em>visibility</em> - <span class="description">{% trans "file visibility" %}</li>
<li><em>data</em> - <span class="description">{% trans "base64 encoded data" %}</li>
<li><em>content_type</em> - <span class="description">{% trans "file mime type (optional)" %}</li>
<li><em>email</em> - <span class="description">{% trans "optional issuer's email" %}</li>
<li><em>type</em> - {% trans "file type" %}</li>
<li><em>subtype</em> - {% trans "file subtype" %}</li>
<li><em>title</em> - {% trans "file title" %}</li>
<li><em>visibility</em> - {% trans "file visibility" %}</li>
<li><em>data</em> - {% trans "base64 encoded data" %}</li>
<li><em>content_type</em> - {% trans "file mime type (optional)" %}</li>
<li><em>email</em> - {% trans "optional issuer's email" %}</li>
</ul>
</p>
</li>
<li class="get-method">
{% url 'generic-endpoint' connector='iparapheur' slug=object.slug endpoint='get-file' rest="5e6fc120-f2f7-4dfa-91d0-44414205a2b9" as get_file_url %}
<span class="description">{% trans 'Get file:' %}</span>
<div class="description"><span class="description--label">{% trans 'Get file:' %}</span>
<a class="example-url" href="{{ get_file_url }}">{{ site_base_uri }}{{ get_file_url }}</a><br />
<em>5e6fc120-f2f7-4dfa-91d0-44414205a2b9</em> - file id
<em>5e6fc120-f2f7-4dfa-91d0-44414205a2b9</em> - file id</div>
</li>
<li class="get-method">
{% url 'generic-endpoint' connector='iparapheur' slug=object.slug endpoint='get-file-status' rest="5e6fc120-f2f7-4dfa-91d0-44414205a2b9" as get_file_status_url %}
<span class="description">{% trans 'Get file status:' %}</span>
<div class="description"><span class="description--label">{% trans 'Get file status:' %}</span>
<a class="example-url" href="{{ get_file_status_url }}">{{ site_base_uri }}{{ get_file_status_url }}</a><br />
<em>5e6fc120-f2f7-4dfa-91d0-44414205a2b9</em> - file id
<em>5e6fc120-f2f7-4dfa-91d0-44414205a2b9</em> - file id</div>
</li>
</ul>
{% endblock %}

View File

@ -6,9 +6,9 @@
<div>
<ul class="endpoints">
<li class="post-method">
<span class="description">{% trans 'Book date' %}</span>
<div class="description"><span class="description--label">{% trans 'Book date' %}</span>
{% url "generic-endpoint" connector="iws" slug=object.slug endpoint="bookdate" as bookdate %}
<a class="example-url" href="{{bookdate}}">{{bookdate}}</a>
<a class="example-url" href="{{bookdate}}">{{bookdate}}</a></div>
<div class="body-schemas">
<span class="params-title">{% trans "Request body" %}</span>
<pre>

View File

@ -33,7 +33,7 @@
{% block endpoints %}
<ul class="endpoints">
<li class="get-method">
<span class="description">{% trans "Request : "%}</span>
<div class="description"><span class="description--label">{% trans "Request : "%}</span>
{% url "generic-endpoint" connector="nancypoll" slug=object.slug endpoint="data" as get_poll %}
<a class="example-url" href="{{get_poll}}?street_no=37&street_name=Marechal Juin">{{get_poll}}?street_no=37&street_name=Marechal Juin</a>
<br />
@ -47,6 +47,7 @@
}]
}
</samp>
</div>
</li>
</ul>
{% endblock %}

View File

@ -5,56 +5,61 @@
<h4>{% trans "Family related" %}</h4>
<ul class="endpoints">
{% url "generic-endpoint" connector="teamnet-axel" slug=object.slug endpoint="ping" as endpoint_ping %}
<li class="get-method"><span class="description">{% trans 'Check WSDL availability:' %}</span> <a class="example-url" href="{{ endpoint_ping }}">{{ endpoint_ping }}</a>[?debug]</li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Check WSDL availability:' %}</span> <a class="example-url" href="{{ endpoint_ping }}">{{ endpoint_ping }}</a>[?debug]</div></li>
{% url "generic-endpoint" connector="teamnet-axel" slug=object.slug endpoint="auth" as endpoint_auth %}
<li class="get-method"><span class="description">{% trans 'Authentication:' %}</span> <a class="example-url" href="{{ endpoint_auth }}?login=foo&password=bar">{{ endpoint_auth }}?login=foo&password=bar</a></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Authentication:' %}</span> <a class="example-url" href="{{ endpoint_auth }}?login=foo&password=bar">{{ endpoint_auth }}?login=foo&password=bar</a></div></li>
{% url "generic-endpoint" connector="teamnet-axel" slug=object.slug endpoint="family" rest="link/" as endpoint_link %}
<li class="get-method"><span class="description">{% trans 'Link:' %}</span> <a class="example-url" href="{{ endpoint_link }}?NameID=...&login=foo&password=bar">{{ endpoint_link }}?NameID=...&login=foo&password=bar</a></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Link:' %}</span> <a class="example-url" href="{{ endpoint_link }}?NameID=...&login=foo&password=bar">{{ endpoint_link }}?NameID=...&login=foo&password=bar</a></div></li>
{% url "generic-endpoint" connector="teamnet-axel" slug=object.slug endpoint="family" rest="unlink/" as endpoint_unlink %}
<li class="get-method"><span class="description">{% trans 'Unlink:' %}</span> <a class="example-url" href="{{ endpoint_unlink }}?NameID=...">{{ endpoint_unlink }}?NameID=...</a></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Unlink:' %}</span> <a class="example-url" href="{{ endpoint_unlink }}?NameID=...">{{ endpoint_unlink }}?NameID=...</a></div></li>
{% url "generic-endpoint" connector="teamnet-axel" slug=object.slug endpoint="family" rest="" as endpoint_family %}
<li class="get-method"><span class="description">{% trans 'Get all family informations:' %}</span> <a class="example-url" href="{{ endpoint_family }}?NameID">{{ endpoint_family }}?NameID=...</a></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Get all family informations:' %}</span> <a class="example-url" href="{{ endpoint_family }}?NameID">{{ endpoint_family }}?NameID=...</a></div></li>
{% url "generic-endpoint" connector="teamnet-axel" slug=object.slug endpoint="family" rest="adults/" as endpoint_family %}
<li class="get-method"><span class="description">{% trans 'Get family adults informations:' %}</span> <a class="example-url" href="{{ endpoint_family }}?NameID">{{ endpoint_family }}?NameID=...</a></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Get family adults informations:' %}</span> <a class="example-url" href="{{ endpoint_family }}?NameID">{{ endpoint_family }}?NameID=...</a></div></li>
{% url "generic-endpoint" connector="teamnet-axel" slug=object.slug endpoint="family" rest="children/" as endpoint_family %}
<li class="get-method"><span class="description">{% trans 'Get family children informations:' %}</span> <a class="example-url" href="{{ endpoint_family }}?NameID">{{ endpoint_family }}?NameID=...</a></li>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Get family children informations:' %}</span> <a class="example-url" href="{{ endpoint_family }}?NameID">{{ endpoint_family }}?NameID=...</a></div></li>
</ul>
<h4>{% trans "Invoices related" %}</h4>
<ul class="endpoints">
<li class="get-method"><span class="description">{% trans 'Get invoice history list:' %}</span>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Get invoice history list:' %}</span>
{% url "generic-endpoint" connector="teamnet-axel" slug=object.slug endpoint="regie" rest="42/invoices/history/" as invoices_history_url %}
<a class="example-url" href="{{ invoices_history_url }}?NameID"> {{ invoices_history_url }}?NameID=...</a>
<em>42</em> <span class="description">{% trans 'is regie identifier' %}
<em>42</em> {% trans 'is regie identifier' %}
</div>
</li>
<li class="get-method"><span class="description">{% trans 'Get invoice list:' %}</span>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Get invoice list:' %}</span>
{% url "generic-endpoint" connector="teamnet-axel" slug=object.slug endpoint="regie" rest="42/invoices/" as invoices_url %}
<a class="example-url" href="{{ invoices_url }}?NameID"> {{ invoices_url }}?NameID=... </a>
<em>42</em> <span class="description">{% trans 'is regie identifier' %}
<em>42</em> {% trans 'is regie identifier' %}
</div>
</li>
<li class="get-method"><span class="description">{% trans 'Show invoice details:' %}</span>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Show invoice details:' %}</span>
{% url "generic-endpoint" connector="teamnet-axel" slug=object.slug endpoint="regie" rest="42/invoices/2345-20150916/" as invoice_details_url %}
<a class="example-url" href="{{ invoice_details_url }}"> {{ site_base_uri }}{{ invoice_details_url }} </a>
<em>42</em> <span class="description">{% trans 'is regie identifier' %},
<em>2345</em> <span class="description">{% trans 'is family identifier' %},
<em>20150916</em> <span class="description">{% trans 'is invoice identifier' %}
<em>42</em> {% trans 'is regie identifier' %},
<em>2345</em> {% trans 'is family identifier' %},
<em>20150916</em> {% trans 'is invoice identifier' %}
</div>
</li>
<li class="get-method"><span class="description">{% trans 'Get invoice pdf:' %}</span>
<li class="get-method"><div class="description"><span class="description--label">{% trans 'Get invoice pdf:' %}</span>
{% url "generic-endpoint" connector="teamnet-axel" slug=object.slug endpoint="regie" rest="42/invoices/2345-20150916/pdf/" as invoice_download_url %}
<a class="example-url" href="{{ invoice_download_url }}"> {{ site_base_uri }}{{ invoice_download_url }} </a>
</div>
</li>
<li class="post-method"><span class="description">{% trans 'Pay invoice:' %}</span>
<li class="post-method"><div class="description"><span class="description--label">{% trans 'Pay invoice:' %}</span>
{% url "generic-endpoint" connector="teamnet-axel" slug=object.slug endpoint="regie" rest="42/invoices/2345-20150916/pay/" as payment_url %}
<a class="example-url" href="{{ payment_url }}"> {{ site_base_uri }}{{ payment_url }}?NameID=... </a>
</div>
</li>
</ul>
{% endblock %}

View File

@ -303,11 +303,7 @@ div.section > div > ul.endpoints {
border: 1px solid hsl(14, 100%, 87%);
}
.endpoints .description, .endpoints .long-description {
display: inline-block;
}
.endpoints .description {
.endpoints .description--label {
font-weight: bold;
}
@ -317,6 +313,10 @@ div.section > div > ul.endpoints {
margin: 0.3em 0.3em 0.3em 0.75em;
}
.endpoints .description {
padding-right: 85px;
}
.endpoints .params {
padding: 0 0.3em;
background: hsla(0, 100%, 100%, 0.65);

View File

@ -1,6 +1,7 @@
{% load i18n passerelle %}
<li class="{{ endpoint.http_method|default:"get" }}-method">{% if endpoint.description %}<span class="description">{{endpoint.description}}{% trans ':' %}</span>{% endif %}
<a href="{{endpoint.example_url}}" class="example-url">{{ site_base_uri }}{{endpoint.example_url_as_html}}</a>
<li class="{{ endpoint.http_method|default:"get" }}-method">
<div class="description">{% if endpoint.description %}<span class="description--label">{{endpoint.description}}{% trans ':' %}</span>{% endif %}
<a href="{{endpoint.example_url}}" class="example-url">{{ site_base_uri }}{{endpoint.example_url_as_html}}</a></div>
<ul class="params">
{% if endpoint.get_params %}
<li>