arcanis/ahriman
1
0
Fork 0
mirror of https://github.com/arcan1s/ahriman.git synced 2025-06-28 06:41:43 +00:00
Code Issues Projects Releases Wiki Activity

rewrite api under single /api endpoint

Browse Source
This commit is contained in:
Evgenii Alekseev
2022-05-29 17:15:49 +03:00
parent d7966e419d
commit 1ea3911531
19 changed files with 119 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/ahriman/core/auth/oauth.py
View File

@ -56,7 +56,7 @@ class OAuth(Mapping):
self.client_secret = configuration.get("auth", "client_secret")
# in order to use OAuth feature the service must be publicity available
# thus we expect that address is set
self.redirect_uri = f"""{configuration.get("web", "address")}/user-api/v1/login"""
self.redirect_uri = f"""{configuration.get("web", "address")}/api/v1/login"""
self.provider = self.get_provider(configuration.get("auth", "oauth_provider"))
# it is list but we will have to convert to string it anyway
self.scopes = configuration.get("auth", "oauth_scopes")
@ -69,7 +69,7 @@ class OAuth(Mapping):
Returns:
str: login control as html code to insert
"""
return """<a class="nav-link" href="/user-api/v1/login" title="login via OAuth2">login</a>"""
return """<a class="nav-link" href="/api/v1/login" title="login via OAuth2">login</a>"""
@staticmethod
def get_provider(name: str) -> Type[aioauth_client.OAuth2Client]:

6
src/ahriman/core/status/web_client.py
View File

@ -65,7 +65,7 @@ class WebClient(Client):
Returns:
str: full url for web service to login
"""
return f"{self.address}/user-api/v1/login"
return f"{self.address}/api/v1/login"
@property
def _status_url(self) -> str:
@ -75,7 +75,7 @@ class WebClient(Client):
Returns:
str: full url for web service for status
"""
return f"{self.address}/status-api/v1/status"
return f"{self.address}/api/v1/status"
@staticmethod
def parse_address(configuration: Configuration) -> str:
@ -126,7 +126,7 @@ class WebClient(Client):
Returns:
str: full url of web service for specific package base
"""
return f"{self.address}/status-api/v1/packages/{base}"
return f"{self.address}/api/v1/packages/{base}"
def add(self, package: Package, status: BuildStatusEnum) -> None:
"""

64
src/ahriman/web/routes.py
View File

@ -41,32 +41,32 @@ def setup_routes(application: Application, static_path: Path) -> None:
Available routes are:
* GET / get build status page
* GET /index.html same as above
* ``GET /`` get build status page
* ``GET /index.html`` same as above
* POST /service-api/v1/add add new packages to repository
* ``POST /api/v1/service/add`` add new packages to repository
* POST /service-api/v1/remove remove existing package from repository
* ``POST /api/v1/service/remove`` remove existing package from repository
* POST /service-api/v1/request request to add new packages to repository
* ``POST /api/v1/service/request`` request to add new packages to repository
* GET /service-api/v1/search search for substring in AUR
* ``GET /api/v1/service/search`` search for substring in AUR
* POST /service-api/v1/update update packages in repository, actually it is just alias for add
* ``POST /api/v1/service/update`` update packages in repository, actually it is just alias for add
* GET /status-api/v1/packages get all known packages
* POST /status-api/v1/packages force update every package from repository
* ``GET /api/v1/packages`` get all known packages
* ``POST /api/v1/packages`` force update every package from repository
* DELETE /status-api/v1/package/:base delete package base from status page
* GET /status-api/v1/package/:base get package base status
* POST /status-api/v1/package/:base update package base status
* ``DELETE /api/v1/package/:base`` delete package base from status page
* ``GET /api/v1/package/:base`` get package base status
* ``POST /api/v1/package/:base`` update package base status
* GET /status-api/v1/status get service status itself
* POST /status-api/v1/status update service status itself
* ``GET /api/v1/status`` get service status itself
* ``POST /api/v1/status`` update service status itself
* GET /user-api/v1/login OAuth2 handler for login
* POST /user-api/v1/login login to service
* POST /user-api/v1/logout logout from service
* ``GET /api/v1/login`` OAuth2 handler for login
* ``POST /api/v1/login`` login to service
* ``POST /api/v1/logout`` logout from service
Args:
application(Application): web application instance
@ -77,26 +77,26 @@ def setup_routes(application: Application, static_path: Path) -> None:
application.router.add_static("/static", static_path, follow_symlinks=True)
application.router.add_post("/service-api/v1/add", AddView)
application.router.add_post("/api/v1/service/add", AddView)
application.router.add_post("/service-api/v1/remove", RemoveView)
application.router.add_post("/api/v1/service/remove", RemoveView)
application.router.add_post("/service-api/v1/request", RequestView)
application.router.add_post("/api/v1/service/request", RequestView)
application.router.add_get("/service-api/v1/search", SearchView, allow_head=False)
application.router.add_get("/api/v1/service/search", SearchView, allow_head=False)
application.router.add_post("/service-api/v1/update", AddView)
application.router.add_post("/api/v1/service/update", AddView)
application.router.add_get("/status-api/v1/packages", PackagesView, allow_head=True)
application.router.add_post("/status-api/v1/packages", PackagesView)
application.router.add_get("/api/v1/packages", PackagesView, allow_head=True)
application.router.add_post("/api/v1/packages", PackagesView)
application.router.add_delete("/status-api/v1/packages/{package}", PackageView)
application.router.add_get("/status-api/v1/packages/{package}", PackageView, allow_head=True)
application.router.add_post("/status-api/v1/packages/{package}", PackageView)
application.router.add_delete("/api/v1/packages/{package}", PackageView)
application.router.add_get("/api/v1/packages/{package}", PackageView, allow_head=True)
application.router.add_post("/api/v1/packages/{package}", PackageView)
application.router.add_get("/status-api/v1/status", StatusView, allow_head=True)
application.router.add_post("/status-api/v1/status", StatusView)
application.router.add_get("/api/v1/status", StatusView, allow_head=True)
application.router.add_post("/api/v1/status", StatusView)
application.router.add_get("/user-api/v1/login", LoginView)
application.router.add_post("/user-api/v1/login", LoginView)
application.router.add_post("/user-api/v1/logout", LogoutView)
application.router.add_get("/api/v1/login", LoginView)
application.router.add_post("/api/v1/login", LoginView)
application.router.add_post("/api/v1/logout", LogoutView)