Skip to content

Allow removing transaction extension endpoints from API docs #506

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

Closed
geospatial-jeff opened this issue Dec 20, 2022 · 2 comments
Closed
Labels
documentation Improvements or additions to documentation

Comments

@geospatial-jeff
Copy link
Collaborator

Users may want to differentiate between read/write access and hiding the write endpoints from API docs helps with this.

@gadomski gadomski added the documentation Improvements or additions to documentation label Jan 31, 2023
@keul
Copy link
Contributor

keul commented Mar 30, 2023

@geospatial-jeff in our application which instantiate a custom Client, we are removing stuff don't implemented in this way:

app = api.app

def catalogue_openapi() -> dict[str, Any]:
    """OpenAPI, but with not implemented paths removed."""
    del openapi_schema["paths"]["/collections/{collection_id}/items"]
    del openapi_schema["paths"]["/collections/{collection_id}/items/{item_id}"]
    del openapi_schema["paths"]["/search"]

    return openapi_schema

app.openapi = catalogue_openapi

@gadomski gadomski self-assigned this Mar 30, 2023
@gadomski gadomski removed their assignment May 12, 2023
@vincentsarago
Copy link
Member

I don't think we need to add settings for this. user can simply initialize the Transaction with a custom APIRouter

TransactionExtension(
    router=APIRouter(include_in_schema=False),
    client=TransactionsClient(),
    settings=settings,
)

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

No branches or pull requests

4 participants