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

[CIVIS-1775] MAINT update civis_api_spec.json #440

Merged
merged 5 commits into from
Dec 2, 2021

Conversation

jacksonlee-civis
Copy link
Member

This PR updates civis_api_spec.json, moves it to under civis/resources/, and checks in a script for maintainers to facilitate updating it again.

Closes #157

  • (For Civis employees only) Reference to a relevant ticket in the pull request title
  • Changelog entry added to CHANGELOG.md at the repo's root level
  • Description of change in the pull request description
  • If applicable, unit tests have been added and/or updated
  • The CircleCI builds have all passed

@jacksonlee-civis jacksonlee-civis added this to the v1.16.0 milestone Dec 2, 2021
@jacksonlee-civis jacksonlee-civis changed the title [CIVIS-1775] ENH update civis_api_spec.json [CIVIS-1775] MAINT update civis_api_spec.json Dec 2, 2021
Comment on lines +31 to +33
BASE_RESOURCES_V1 = sorted(
set(path.split("/", 2)[1] for path in API_SPEC["paths"].keys())
)
Copy link
Member Author

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']

Copy link

@madopal madopal left a 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.

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

Successfully merging this pull request may close these issues.

add development section to README
2 participants