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

Use separate repo for api docs #278

Merged
merged 5 commits into from
Nov 25, 2021
Merged

Conversation

mmacata
Copy link
Member

@mmacata mmacata commented Nov 23, 2021

To be able to release the actinia API individually from the code, this PR starts to move openAPI descriptions to a separate repository https://github.com/mundialis/actinia-api.
This PR

  • moves some of the API docs to actinia-api
  • replaces their import
  • adjusts the build to make use of the separate repository
  • adjusts the build for updated plugins regarding api/v1 -> api/v2 changes
  • add response to all old api/v1 endpoints. Example:
$ curl http://127.0.0.1:8088/api/v1/locations/nc_spm_08/mapsets | jq
[
  {
    "links": [
      "http://127.0.0.1:8088/api/v2/locations/nc_spm_08/mapsets"
    ],
    "message": "Are you looking for the current api version? Change 'v1' to 'v2' in the URL.",
    "status": "Not found"
  },
  404
]

Follow up:

@mmacata mmacata marked this pull request as ready for review November 24, 2021 16:47
Copy link
Contributor

@griembauer griembauer left a comment

Choose a reason for hiding this comment

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

Thank you, just one minor comment.

src/actinia_core/version.py Outdated Show resolved Hide resolved
src/actinia_core/version.py Show resolved Hide resolved
src/actinia_core/version.py Outdated Show resolved Hide resolved
@mmacata mmacata merged commit e8b51a4 into actinia-org:main Nov 25, 2021
@mmacata mmacata added this to the 2.0.1 milestone Nov 9, 2022
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.

4 participants