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

Document how to customize OpenAPI info per country package #222

Open
alexsoble opened this issue Jan 6, 2020 · 1 comment
Open

Document how to customize OpenAPI info per country package #222

alexsoble opened this issue Jan 6, 2020 · 1 comment
Assignees

Comments

@alexsoble
Copy link
Contributor

As a developer working on building a prototype using OpenFisca, I want to be able to customize the OpenAPI info returned by my API's /spec endpoint.

I see that the OpenFisca-France API includes a custom "contact" field, contact@openfisca.fr:

https://fr.openfisca.org/api/v21/spec

In my prototype API, the "contact" remains contact@openfisca.org, even though I specified author_email="" in setup.py:

https://prototype-openfisca-usa-headstart.app.cloud.gov/spec
— https://github.com/18F/prototype-openfisca-usa-headstart/blob/master/setup.py#L9

I would ideally want to see this documentation under "OpenAPI specification configuration": https://openfisca.org/doc/openfisca-web-api/config-openapi.html.

If someone can point me in the right direction for how to customize this OpenAPI config, I'd be more than happy to open a PR that adds instructions to the docs! 😄

@alexsoble alexsoble changed the title Document how to customize OpenAPI info per country Document how to customize OpenAPI info per country package Jan 6, 2020
@sandcha sandcha self-assigned this Jan 10, 2020
@MattiSG
Copy link
Member

MattiSG commented Mar 10, 2024

This already has to be implemented, see openfisca/openfisca-core#1207.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants