help: replace curl command by simpler request instruction (#76276)
gitea/wcs/pipeline/head This commit looks good Details

This commit is contained in:
Valentin Deniaud 2023-04-11 10:58:20 +02:00
parent ae2325aefb
commit f8b2fde53a
8 changed files with 44 additions and 98 deletions

View File

@ -86,16 +86,12 @@ schémas de données associés.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Content-type: application/json" \
-H "Accept: application/json" \
-d@donnees.json \
https://www.example.net/api/cards/parkings/submit<var>?signature…</var></input>
<input>POST https://www.example.net/api/cards/parkings/submit</input>
<output>{"err": 0, "data": {"id": "5"}}</output>
</screen>
<p>
Le fichier de données utilisé (<file>donnees.json</file>) contient le
dictionnaire JSON suivant :
Avec les données suivantes en entrée :
</p>
<code mime="application/json">
@ -134,10 +130,7 @@ le workflow correspondant.
</p>
<screen>
<output style="prompt">$ </output><input>curl -X PUT -H "Content-Type: text/csv" \
-H "Accept: application/json" \
https://www.example.net/api/cards/<var>slug</var>/import-csv<var>?signature…</var>
--data-binary @fichier.csv</input>
<input>PUT https://www.example.net/api/cards/<var>slug</var>/import-csv</input>
<output>{"err": 0}</output>
</screen>
@ -160,10 +153,7 @@ paramètres de lURL :
</p>
<screen>
<output style="prompt">$ </output><input>curl -X PUT -H "Content-Type: text/csv" \
-H "Accept: application/json" \
https://www.example.net/api/cards/<var>slug</var>/import-csv<var>?async=on</var>
--data-binary @fichier.csv</input>
<input>PUT https://www.example.net/api/cards/<var>slug</var>/import-csv<var>?async=on</var></input>
<output>{
"err": 0,
"data": {
@ -182,8 +172,7 @@ suivre la progression en appellant son URL indiquée en retour de lappel PUT.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/jobs/1234/</input>
<input>GET https://www.example.net/api/jobs/1234/</input>
<output>{
"err": 0,
"data": {
@ -215,8 +204,7 @@ de fiche a comme identifiant « parkings ».
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/cards/parkings/5/<var>?signature…</var></input>
<input>GET https://www.example.net/api/cards/parkings/5/</input>
</screen>
<p>
@ -270,11 +258,8 @@ Les données attendues sont similaires à la création dune nouvelle fiche
(<link xref="#create"/>), seuls les champs présents seront pris en compte.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Content-Type: application/json" \
-H "Accept: application/json" \
-d@donnees.json \
https://www.example.net/api/cards/parkings/5/<var>?signature…</var></input>
<screen>
<input>POST https://www.example.net/api/cards/parkings/5/</input>
</screen>
</section>
@ -296,8 +281,7 @@ effacées, puis effectuera pour chacune les actions nécessaires.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/cards/parkings/list<var>?signature…</var></input>
<input>GET https://www.example.net/api/cards/parkings/list</input>
<output>{
"data": [
{
@ -346,8 +330,7 @@ vue personnalisée, en ajoutant lidentifiant de celle-ci à ladresse, ex 
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/cards/parkings/list/vue-personnalisee<var>?signature…</var></input>
<input>GET https://www.example.net/api/cards/parkings/list/vue-personnalisee</input>
<output>{
"data": [
{
@ -382,8 +365,7 @@ Une API existe pour récupérer le schéma de données dun modèle de fiches.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/cards/parkings/@schema<var>?signature…</var></input>
<input>GET https://www.example.net/api/cards/parkings/@schema</input>
<output>{
"always_advertise" : false,
"appearance_keywords" : null,
@ -440,8 +422,7 @@ Une API existe pour récupérer le schéma de données dun modèle de fiches.
<p>Une API permet de récupérer la liste des modèles de fiches.</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/cards/@list<var>?signature…</var></input>
<input>GET https://www.example.net/api/cards/@list</input>
<output>{
"data" : [
{

View File

@ -32,7 +32,7 @@ Ladresse appelée doit répondre aux exigences suivantes :
<example>
<title>Exemple JSON</title>
<screen>
<output style="prompt">$ </output><input>curl https://www.example.net/data/fruits</input>
<input>GET https://www.example.net/data/fruits</input>
<output>{
"data": [
{
@ -63,7 +63,7 @@ doit respecter les exigences supplémentaires suivantes :
<example>
<title>Exemple JSON dun élément unique désigné par son identifiant</title>
<screen>
<output style="prompt">$ </output><input>curl https://www.example.net/data/fruits?id=1</input>
<input>GET https://www.example.net/data/fruits?id=1</input>
<output>{
"data": [
{
@ -77,7 +77,7 @@ doit respecter les exigences supplémentaires suivantes :
<example>
<title>Exemple JSON filtré par contenu</title>
<screen>
<output style="prompt">$ </output><input>curl https://www.example.net/data/fruits?q=pom</input>
<input>GET https://www.example.net/data/fruits?q=pom</input>
<output>{
"data": [
{
@ -98,7 +98,7 @@ de contexte du formulaire.
<example>
<title>Exemple JSON enrichi</title>
<screen>
<output style="prompt">$ </output><input>curl https://www.example.net/data/fruits</input>
<input>GET https://www.example.net/data/fruits</input>
<output>{
"data": [
{

View File

@ -128,16 +128,12 @@ formulaire existant.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Content-type: application/json" \
-H "Accept: application/json" \
-d@donnees.json \
https://www.example.net/api/formdefs/newsletter/submit<var>?signature…</var></input>
<input>POST https://www.example.net/api/formdefs/newsletter/submit</input>
<output>{"err": 0, "data": {"id": "1"}}</output>
</screen>
<p>
Le fichier de données utilisé (<file>donnees.json</file>) contient le
dictionnaire JSON suivant :
Avec les données suivantes en entrée :
</p>
<code mime="application/json">
@ -174,10 +170,7 @@ formulaire existant.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Content-type: application/json" \
-H "Accept: application/json" \
-d@donnees.json \
https://www.example.net/api/forms/newsletter/1/<var>?signature…</var></input>
<input>POST https://www.example.net/api/forms/newsletter/1/</input>
<output>{"err": 0}</output>
</screen>

View File

@ -30,8 +30,7 @@ newsletter.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/forms/newsletter/16/<var>?signature…</var></input>
<input>GET https://www.example.net/api/forms/newsletter/16/</input>
</screen>
<p>
@ -269,8 +268,7 @@ etc.).
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/forms/inscriptions/list<var>?signature…</var></input>
<input>GET https://www.example.net/api/forms/inscriptions/list</input>
</screen>
<code mime="application/json">
@ -298,8 +296,7 @@ demandes non terminées (pending) :
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/forms/inscriptions/list?filter=pending<var>&amp;signature…</var></input>
<input>GET https://www.example.net/api/forms/inscriptions/list?filter=pending</input>
</screen>
<p>
@ -310,8 +307,7 @@ possibles est « gratuit » :
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/forms/inscriptions/list?filter-type=gratuit<var>&amp;signature…</var></input>
<input>GET https://www.example.net/api/forms/inscriptions/list?filter-type=gratuit</input>
</screen>
<p>
@ -339,8 +335,7 @@ ladresse.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/forms/inscriptions/list?full=on<var>&amp;signature…</var></input>
<input>GET https://www.example.net/api/forms/inscriptions/list?full=on</input>
</screen>
<p>
@ -361,10 +356,8 @@ nest pas nécessaire de préciser lidentifiant dun utilisateur.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/forms/inscriptions/list?full=on&amp;anonymise<var>&amp;signature…</var></input>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/forms/inscriptions/10/?anonymise<var>&amp;signature…</var></input>
<input>GET https://www.example.net/api/forms/inscriptions/list?full=on&amp;anonymise</input>
<input>GET https://www.example.net/api/forms/inscriptions/10/?anonymise</input>
</screen>
</section>
@ -379,8 +372,7 @@ nest pas nécessaire de préciser lidentifiant dun utilisateur.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/forms/<var>?signature…</var></input>
<input>GET https://www.example.net/api/forms/</input>
</screen>
<code mime="application/json">
@ -415,8 +407,7 @@ Par exemple, pour avoir une liste limitée aux demandes terminées :
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/forms/?status=done<var>&amp;signature…</var></input>
<input>GET https://www.example.net/api/forms/?status=done</input>
</screen>
<note><p>
@ -436,8 +427,7 @@ webservice <code>/geojson</code>.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/forms/inscriptions/geojson<var>?signature…</var></input>
<input>GET https://www.example.net/api/forms/inscriptions/geojson</input>
<output>{
"type": "FeatureCollection",
"features": [
@ -473,8 +463,7 @@ lensemble des demandes :
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/forms/geojson<var>?signature…</var></input>
<input>GET https://www.example.net/api/forms/geojson</input>
</screen>
</section>
@ -488,8 +477,7 @@ Une API existe pour déterminer lexistence dun code de suivi et, le cas
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/code/QRFPTSLR<var>?signature…</var></input>
<input>GET https://www.example.net/api/code/QRFPTSLR</input>
<output>{"url": "...",
"load_url": "...",
"err": 0}</output>

View File

@ -36,14 +36,6 @@ dexemples. Les différentes pages détaillent les points daccès à
utiliser pour réaliser les différentes opérations.
</p>
<note>
<p>
Les exemples donnés dans ce document utilisent pour la plupart loutil en
ligne de commande <app>curl</app> qui permet de manière simple lenvoi de
requêtes HTTP à un serveur.
</p>
</note>
</section>
</page>

View File

@ -28,8 +28,7 @@ lURL <code>/api/formdefs/</code>.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/formdefs/<var>?signature…</var></input>
<input>GET https://www.example.net/api/formdefs/</input>
<output>
[{"url": "https://www.example.net/inscriptions/newsletter",
"title": "Newsletter",
@ -95,8 +94,7 @@ La liste des catégories est disponible à lURL <code>/api/categories/</code>
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/categories/<var>?signature…</var></input>
<input>GET https://www.example.net/api/categories/</input>
<output>
{"data":
[
@ -124,8 +122,7 @@ Les formulaires dune catégorie précise sont disponibles à lURL
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/categories/inscriptions/formdefs/<var>?signature…</var></input>
<input>GET https://www.example.net/api/categories/inscriptions/formdefs/</input>
</screen>
<p>
@ -146,8 +143,7 @@ La liste des rôles est disponible à lURL <code>/api/roles</code>.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/roles<var>?signature…</var></input>
<input>GET https://www.example.net/api/roles</input>
<output>
{"data":
[

View File

@ -29,7 +29,7 @@ associées aux usagers enregistrés.
</p>
<screen>
<output style="prompt">$ </output><input>curl --user <var>…</var> https://www.example.net/api/users/<var>uuid</var>/forms</input>
<input>GET https://www.example.net/api/users/<var>uuid</var>/forms</input>
<output>{
"err": 0,
"data": [
@ -124,7 +124,7 @@ particulier.
</p>
<screen>
<output style="prompt">$ </output><input>curl --user <var>…</var> https://www.example.net/api/user/<var>uuid</var>/drafts</input>
<input>GET https://www.example.net/api/user/<var>uuid</var>/drafts</input>
<output>{
"err": 0,
"data": [

View File

@ -45,9 +45,13 @@ la référence à lidentifiant de déclencheur (<code>validate</code> dans
lexemple qui suit).
</p>
<p>
Lors de cette requête, il est nécessaire dinclure lentête
<code>Accept: application/json</code>.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" -X POST \
https://www.example.net/inscriptions/newsletter/14/jump/trigger/validate/<var>?signature…</var></input>
<input>POST https://www.example.net/inscriptions/newsletter/14/jump/trigger/validate/</input>
<output>{"url": null, "err": 0}</output>
</screen>
@ -57,13 +61,6 @@ de statut dune série de données, qui seront enregistrées dans les données
workflow du formulaire.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Content-type: application/json" -H "Accept: application/json" \
-X POST -d@donnes.json \
https://www.example.net/inscriptions/newsletter/14/jump/trigger/validate/<var>?signature…</var></input>
<output>{"url": null, "err": 0}</output>
</screen>
<p>
Il est également possible de définir des déclencheurs au niveau des actions
globales du workflow, ils pourront alors être appelés quel que soit le statut
@ -76,8 +73,7 @@ ferait ainsi :
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" -X POST \
https://www.example.net/api/forms/newsletter/14/hooks/urgent/<var>?signature…</var></input>
<input>POST https://www.example.net/api/forms/newsletter/14/hooks/urgent/</input>
<output>{"err": 0}</output>
</screen>