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

Bug #1466 - Make API documentation country agnostic #1542

Merged
merged 1 commit into from Mar 27, 2018

Conversation

micael-grilo
Copy link
Contributor

Hi,

Please see in attach my contribution to Bug #1466.
I've tried to make the examples as generic as possible.

Best!

Copy link
Contributor

@noirbizarre noirbizarre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution 👍

One possible improvement for later is to make this documentation dynamique (ie. use a real organization)

@noirbizarre noirbizarre merged commit 550cae2 into opendatateam:master Mar 27, 2018
@noirbizarre noirbizarre added this to the 1.3.4 milestone Mar 27, 2018
@noirbizarre
Copy link
Contributor

Sorry, I forgot: for every PR with user noticeable changes we try to submit a CHANGELOG entry. Can you do so (in another PR because I merged this one to quickly) ?

@micael-grilo
Copy link
Contributor Author

@noirbizarre in fact with dynamic documentation (using a real organization) it would be better.
What you have in mind? Get the top or first 20 organizations and then choose one ramdomly to display as example?

Btw, the idea is to send an organization list (limit 20) as an parameter to the JINJA template in this line, then deal with the organization in the Jinja template, is it ok? Or do you suggest a better approach.

return theme.render('apidoc.html', specs_url=api.specs_url)

I will create a new PR for the CHANGELOG.
Thanks

@micael-grilo micael-grilo deleted the bug-1466_agnostic_api branch June 20, 2018 12:25
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

Successfully merging this pull request may close these issues.

None yet

2 participants