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

REST API documentation does not reflect some actual endpoints #3630

Closed
didithilmy opened this issue May 23, 2020 · 0 comments · Fixed by #3631
Closed

REST API documentation does not reflect some actual endpoints #3630

didithilmy opened this issue May 23, 2020 · 0 comments · Fixed by #3631

Comments

@didithilmy
Copy link
Member

Motivation

Some REST endpoints path in the documentation differs from the actual API path. Several instances of this:

  1. /rules endpoint, listed in the docs as /rule
  2. /config endpoint, listed in the docs as /configs
  3. /tmp_dids endpoint, listed in the docs as /temporary_dids
  4. /accountlimits endpoint, listed in the docs as /accounts

Additionally, there are endpoints that exist in the source but lack the accompanying docs:

  1. /credentials endpoint
  2. /export endpoint
  3. /import endpoint

Modification

Several files need to be edited/added:

  • lib/rucio/web/rest/flaskapi/v1/{account_limit|config|rule|temporary_dids}.py need to be edited to change the doc_app.register_blueprint(bp, url_prefix='/<endpoint prefix>') portion.
  • Add new .rst files
bari12 added a commit that referenced this issue May 29, 2020
…int_paths_in_docs

Documentation: Change url_prefix to match actual endpoint Fix #3630
bari12 added a commit that referenced this issue May 29, 2020
…int_paths_in_docs

Documentation: Change url_prefix to match actual endpoint Fix #3630
@bari12 bari12 added this to the 1.22.7 milestone May 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants