-
Notifications
You must be signed in to change notification settings - Fork 26
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
[CIVIS-1775] MAINT update civis_api_spec.json
#440
[CIVIS-1775] MAINT update civis_api_spec.json
#440
Conversation
civis_api_spec.json
civis_api_spec.json
BASE_RESOURCES_V1 = sorted( | ||
set(path.split("/", 2)[1] for path in API_SPEC["paths"].keys()) | ||
) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Practically, BASE_RESOURCES_V1
is now a reference list of the publicly available API endpoints, used only by the Sphinx docs to auto-generate the API resources documentation (see docs/source/conf.py
). As I've just updated civis_api_spec.json
, this list now looks like the following:
In [1]: from civis.resources._resources import BASE_RESOURCES_V1
In [2]: BASE_RESOURCES_V1
Out[2]:
['admin',
'aliases',
'announcements',
'clusters',
'credentials',
'databases',
'endpoints',
'enhancements',
'exports',
'feature_flags',
'files',
'git_repos',
'groups',
'imports',
'jobs',
'json_values',
'match_targets',
'media',
'models',
'notebooks',
'notifications',
'ontology',
'permission_sets',
'predictions',
'projects',
'queries',
'remote_hosts',
'reports',
'roles',
'saml_service_providers',
'scripts',
'search',
'services',
'storage_hosts',
'table_tags',
'tables',
'templates',
'users',
'workflows']
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, assuming some successful runs to produce new docs.
This PR updates
civis_api_spec.json
, moves it to undercivis/resources/
, and checks in a script for maintainers to facilitate updating it again.Closes #157
CHANGELOG.md
at the repo's root level