Skip to content

Document how to customize OpenAPI info per country package #222

@alexsoble

Description

@alexsoble

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, [email protected]:

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

In my prototype API, the "contact" remains [email protected], 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! 😄

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions