search

AntaresSimulatorTeam / AntaREST

API REST and WebUI for Antares_Simulator
Apache License 2.0
12 stars 6 forks source link

Limit/Group api endpoints #111

Closed pl-buiquang closed 3 years ago

pl-buiquang commented 4 years ago

To make the api usage more user-friendly and, well, usable, some endpoint should be left out of the swagger documentation (possibly for the api itself if needed/possible), letting only higher level of the json accessible and returning the whole content. The list of these group cuts is :

qdesmedt commented 4 years ago

Idea: add a configuration file to the api

[swagger]

endpoints = [ "layers/layers", ... ]

If done like so, add the following conf:

server = http//localhost:8080

./server.sh --conf path_to_conf_file.ini

create-issue-branch[bot] commented 4 years ago

Branch issue-111-Limit/Group_api_endpoints created!

pl-buiquang commented 4 years ago

To make sur my explanation was clear, The "group cuts" listed are not the only endpoint we wish to see in the swagger doc. All available path should be listed. They define the paths which we do not want to see any deeper endpoint.

qdesmedt commented 3 years ago

Suite à une discussion entre @qdesmedt / @FrancoisJ:

pl-buiquang commented 3 years ago

Ne serait il pas possible d'ajouter une metadonnée dans le jsonschema pour que la génération des chemins du swagger s'arrête (ne pas construire les enfants) aux noeuds contenant cette métadonnée ? Il faudrait effectivement en plus de la génération automatique via le jsonschema (tout ce qui est en dessous de /studies/{study_id} a priori) rajouter une génération ad hoc pour les endpoints qui n'en dépendent pas.

qdesmedt commented 3 years ago

Décision:

create-issue-branch[bot] commented 3 years ago

Branch issue-111-Limit/Group_api_endpoints created!

qdesmedt commented 3 years ago

output/XXX/info(.antares-output) Not yet implemented see #119