help: replace curl command by simpler request instruction (#76276)
gitea/wcs/pipeline/head This commit looks good
Details
gitea/wcs/pipeline/head This commit looks good
Details
This commit is contained in:
parent
ae2325aefb
commit
f8b2fde53a
|
@ -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 l’URL :
|
|||
</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 l’appel 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 d’une 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 l’identifiant de celle-ci à l’adresse, 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 d’un 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 d’un 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" : [
|
||||
{
|
||||
|
|
|
@ -32,7 +32,7 @@ L’adresse 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 d’un é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": [
|
||||
{
|
||||
|
|
|
@ -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>
|
||||
|
||||
|
|
|
@ -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>&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>&signature…</var></input>
|
||||
<input>GET https://www.example.net/api/forms/inscriptions/list?filter-type=gratuit</input>
|
||||
</screen>
|
||||
|
||||
<p>
|
||||
|
@ -339,8 +335,7 @@ l’adresse.
|
|||
</p>
|
||||
|
||||
<screen>
|
||||
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
|
||||
https://www.example.net/api/forms/inscriptions/list?full=on<var>&signature…</var></input>
|
||||
<input>GET https://www.example.net/api/forms/inscriptions/list?full=on</input>
|
||||
</screen>
|
||||
|
||||
<p>
|
||||
|
@ -361,10 +356,8 @@ n’est pas nécessaire de préciser l’identifiant d’un utilisateur.
|
|||
</p>
|
||||
|
||||
<screen>
|
||||
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
|
||||
https://www.example.net/api/forms/inscriptions/list?full=on&anonymise<var>&signature…</var></input>
|
||||
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
|
||||
https://www.example.net/api/forms/inscriptions/10/?anonymise<var>&signature…</var></input>
|
||||
<input>GET https://www.example.net/api/forms/inscriptions/list?full=on&anonymise</input>
|
||||
<input>GET https://www.example.net/api/forms/inscriptions/10/?anonymise</input>
|
||||
</screen>
|
||||
|
||||
</section>
|
||||
|
@ -379,8 +372,7 @@ n’est pas nécessaire de préciser l’identifiant d’un 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>&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 @@ l’ensemble 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 l’existence d’un 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>
|
||||
|
|
|
@ -36,14 +36,6 @@ d’exemples. Les différentes pages détaillent les points d’accès à
|
|||
utiliser pour réaliser les différentes opérations.
|
||||
</p>
|
||||
|
||||
<note>
|
||||
<p>
|
||||
Les exemples donnés dans ce document utilisent pour la plupart l’outil en
|
||||
ligne de commande <app>curl</app> qui permet de manière simple l’envoi de
|
||||
requêtes HTTP à un serveur.
|
||||
</p>
|
||||
</note>
|
||||
|
||||
</section>
|
||||
|
||||
</page>
|
||||
|
|
|
@ -28,8 +28,7 @@ l’URL <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 à l’URL <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 d’une catégorie précise sont disponibles à l’URL
|
|||
</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 à l’URL <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":
|
||||
[
|
||||
|
|
|
@ -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": [
|
||||
|
|
|
@ -45,9 +45,13 @@ la référence à l’identifiant de déclencheur (<code>validate</code> dans
|
|||
l’exemple qui suit).
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Lors de cette requête, il est nécessaire d’inclure l’entê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 d’une 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>
|
||||
|
||||
|
|
Loading…
Reference in New Issue