Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a /entities endpoint to the API #561

Closed
MattiSG opened this issue Aug 22, 2017 · 2 comments
Closed

Add a /entities endpoint to the API #561

MattiSG opened this issue Aug 22, 2017 · 2 comments
Assignees
Labels
kind:feat A feature request, a feature deprecation

Comments

@MattiSG
Copy link
Member

MattiSG commented Aug 22, 2017

Returns a JSON object listing all modelled entities where the property names is the key property of the entity and where the value is an Object with the following properties:

  • String plural. Mandatory.
  • String documentation, coming from the entity docstring. Defaults to "".
  • Object roles if the entity is not a person (in case the entity is a person, roles must be falsy), where the name is the key property and where the value is an object with the following properties:
    • String plural. Mandatory.
    • Boolean mandatory. Defaults to false.
    • Number max (if one is defined).

subroles are not to be exposed yet.

Related to openfisca/legislation-explorer#80.

@bonjourmauko bonjourmauko added flow:support:backlog kind:feat A feature request, a feature deprecation labels Apr 12, 2018
@guillett
Copy link
Member

This endpoint is required to create a proper UI.

It would be a great addition to the web API.

@fpagnoux
Copy link
Member

fpagnoux commented Jul 26, 2018

For more discussion about subroles: #560 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:feat A feature request, a feature deprecation
Projects
None yet
Development

No branches or pull requests

5 participants