Skip to content

Implement mechanism to define custom endpoints descriptions #68

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 16, 2024
Merged

Implement mechanism to define custom endpoints descriptions #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions ogc_api_processes_fastapi/clients.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,18 @@
class BaseClient(abc.ABC):
"""Defines a pattern for implementing OGC API - Processes endpoints."""

endpoints_description: Dict[str, str] = {
"GetLandingPage": "Get landing page",
"GetConformance": "Get conformance classes",
"GetProcesses": "Get all available processes",
"GetProcess": "Get description of the process",
"PostProcessExecution": "Post request for execution of the process",
"GetJobs": "Get the list of submitted jobs",
"GetJob": "Get status information of the job",
"GetJobResults": "Get results of the job",
"DeleteJob": "Cancel the job",
}

@abc.abstractmethod
def get_processes(
self, limit: Optional[int] = fastapi.Query(None)
Expand Down
1 change: 1 addition & 0 deletions ogc_api_processes_fastapi/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ def register_route(
route_endpoint = endpoints.create_endpoint(route_name, client=client)
router.add_api_route(
name=route_name,
description=client.endpoints_description.get(route_name, ""),
response_model=response_model,
response_model_exclude_unset=True,
response_model_exclude_none=True,
Expand Down