DGNum/demarches-normaliennes
13
1
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity

Swagger docs

Browse source
This commit is contained in:
Xavier J 2016-02-18 18:02:07 +01:00
parent a643f34621
commit c3410c104b
10 changed files with 280 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

20
public/api-docs.json Normal file
View file

@ -0,0 +1,20 @@
{
"apiVersion": "1.0",
"swaggerVersion": "1.2",
"basePath": "http://localhost:3000",
"apis": [
{
"path": "/api/v1/dossiers.{format}",
"description": "Dossiers"
},
{
"path": "/api/v1/procedures.{format}",
"description": "Procédures"
}
],
"authorizations": null,
"info": {
"title": "API TéléProcédure Simplifiée",
"description": ""
}
}

102
public/api/v1/dossiers.json Normal file
View file

@ -0,0 +1,102 @@
{
"apiVersion": "1.0",
"swaggerVersion": "1.2",
"basePath": "http://localhost:3000",
"resourcePath": "dossiers",
"apis": [
{
"path": "/api/v1/procedures/{procedure_id}/dossiers",
"operations": [
{
"summary": "Récupérer la liste de ses dossiers.",
"parameters": [
{
"paramType": "path",
"name": "procedure_id",
"type": "integer",
"description": null,
"required": false
},
{
"paramType": "query",
"name": "token",
"type": "integer",
"description": null,
"required": false
}
],
"responseMessages": [
{
"code": 200,
"responseModel": "Dossier",
"message": "Success"
},
{
"code": 401,
"responseModel": null,
"message": "Unauthorized"
},
{
"code": 404,
"responseModel": null,
"message": "Not Found"
}
],
"nickname": "API::V1::Dossiers#index",
"method": "get"
}
]
},
{
"path": "/api/v1/procedures/{procedure_id}/dossiers/{id}",
"operations": [
{
"summary": "Récupérer le détails d'un dossier.",
"parameters": [
{
"paramType": "path",
"name": "procedure_id",
"type": "integer",
"description": null,
"required": false
},
{
"paramType": "path",
"name": "id",
"type": "integer",
"description": null,
"required": false
},
{
"paramType": "query",
"name": "token",
"type": "integer",
"description": null,
"required": false
}
],
"responseMessages": [
{
"code": 200,
"responseModel": "Dossier",
"message": "Success"
},
{
"code": 401,
"responseModel": null,
"message": "Unauthorized"
},
{
"code": 404,
"responseModel": null,
"message": "Not Found"
}
],
"nickname": "API::V1::Dossiers#show",
"method": "get"
}
]
}
],
"authorizations": null
}

52
public/api/v1/procedures.json Normal file
View file

@ -0,0 +1,52 @@
{
"apiVersion": "1.0",
"swaggerVersion": "1.2",
"basePath": "http://localhost:3000",
"resourcePath": "procedures",
"apis": [
{
"path": "/api/v1/procedures/{id}",
"operations": [
{
"summary": "Récupérer la liste de ses procédures.",
"parameters": [
{
"paramType": "path",
"name": "id",
"type": "integer",
"description": null,
"required": false
},
{
"paramType": "query",
"name": "token",
"type": "integer",
"description": null,
"required": false
}
],
"responseMessages": [
{
"code": 200,
"responseModel": "Procedure",
"message": "Success"
},
{
"code": 401,
"responseModel": null,
"message": "Unauthorized"
},
{
"code": 404,
"responseModel": null,
"message": "Not Found"
}
],
"nickname": "API::V1::Procedures#show",
"method": "get"
}
]
}
],
"authorizations": null
}