14 releases (breaking)
0.11.0 | Nov 8, 2021 |
---|---|
0.9.0 | Sep 10, 2021 |
0.1.3 | Jun 30, 2021 |
#5 in #governance
34 downloads per month
505KB
9K
SLoC
Rust API for hvcg_governance_openapi_catholic-polity
This is a server for Catholic Polity info.
Overview
This client/server was generated by the [openapi-generator] (https://openapi-generator.tech) project. By using the OpenAPI-Spec from a remote server, you can easily generate a server stub.
To see how to make this your own, look here:
- API version: 0.11.0
- Build date: 2021-11-08T08:22:53.842619534Z[Etc/UTC]
This autogenerated project defines an API crate hvcg_governance_openapi_catholic-polity
which contains:
- An
Api
trait defining the API in Rust. - Data types representing the underlying data model.
- A
Client
type which implementsApi
and issues HTTP requests for each operation. - A router which accepts HTTP requests and invokes the appropriate
Api
method for each operation.
It also contains an example server and client which make use of hvcg_governance_openapi_catholic-polity
:
- The example server starts up a web server using the
hvcg_governance_openapi_catholic-polity
router, and supplies a trivial implementation ofApi
which returns failure for every operation. - The example client provides a CLI which lets you invoke
any single operation on the
hvcg_governance_openapi_catholic-polity
client by passing appropriate arguments on the command line.
You can use the example server and client as a basis for your own code. See below for more detail on implementing a server.
Examples
Run examples with:
cargo run --example <example-name>
To pass in arguments to the examples, put them after --
, for example:
cargo run --example client -- --help
Running the example server
To run the server, follow these simple steps:
cargo run --example server
Running the example client
To run a client, follow one of the following simple steps:
cargo run --example client DeleteDeanery
cargo run --example client GetDeaneries
cargo run --example client GetDeaneryById
cargo run --example client DeleteDiocese
cargo run --example client GetDioceseById
cargo run --example client GetDioceses
cargo run --example client DeleteInstitute
cargo run --example client GetInstituteById
cargo run --example client GetInstitutes
cargo run --example client AddParish
cargo run --example client DeleteParish
cargo run --example client GetParishById
cargo run --example client GetParishes
cargo run --example client UpdateParish
cargo run --example client AddProvince
cargo run --example client DeleteProvince
cargo run --example client GetProvinceById
cargo run --example client GetProvinces
cargo run --example client UpdateProvince
HTTPS
The examples can be run in HTTPS mode by passing in the flag --https
, for example:
cargo run --example server -- --https
This will use the keys/certificates from the examples directory. Note that the
server chain is signed with CN=localhost
.
Using the generated library
The generated library has a few optional features that can be activated through Cargo.
server
- This defaults to enabled and creates the basic skeleton of a server implementation based on hyper
- To create the server stack you'll need to provide an implementation of the API trait to provide the server function.
client
- This defaults to enabled and creates the basic skeleton of a client implementation based on hyper
- The constructed client implements the API trait by making remote API call.
conversions
- This defaults to disabled and creates extra derives on models to allow "transmogrification" between objects of structurally similar types.
See https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section for how to use features in your Cargo.toml
.
Documentation for API Endpoints
All URIs are relative to https://dev-sg.portal.hocvienconggiao.com
Method | HTTP request | Description |
---|---|---|
addDeanery | POST /mutation-api/catholic-polity-service/deaneries | Add new deanery |
deleteDeanery | DELETE /mutation-api/catholic-polity-service/deaneries/{id} | Delete deanery by ID |
getDeaneries | GET /query-api/catholic-polity-service/deaneries | Get deaneries |
getDeaneryById | GET /query-api/catholic-polity-service/deaneries/{id} | Find deanery by ID |
updateDeanery | PUT /mutation-api/catholic-polity-service/deaneries/{id} | Update an existing deanery |
addDiocese | POST /mutation-api/catholic-polity-service/dioceses | Add new diocese |
deleteDiocese | DELETE /mutation-api/catholic-polity-service/dioceses/{id} | Delete diocese by ID |
getDioceseById | GET /query-api/catholic-polity-service/dioceses/{id} | Find diocese by ID |
getDioceses | GET /query-api/catholic-polity-service/dioceses | Get all dioceses |
updateDiocese | PUT /mutation-api/catholic-polity-service/dioceses/{id} | Update an existing diocese |
addInstitute | POST /mutation-api/catholic-polity-service/institutes | Add new institute |
deleteInstitute | DELETE /mutation-api/catholic-polity-service/institutes/{id} | Delete institute by ID |
getInstituteById | GET /query-api/catholic-polity-service/institutes/{id} | Find institute by ID |
getInstitutes | GET /query-api/catholic-polity-service/institutes | Get institutes |
updateInstitute | PUT /mutation-api/catholic-polity-service/institutes/{id} | Update an existing institute |
addParish | POST /mutation-api/catholic-polity-service/parishes | Add new parish |
deleteParish | DELETE /mutation-api/catholic-polity-service/parishes/{id} | Delete parish by ID |
getParishById | GET /query-api/catholic-polity-service/parishes/{id} | Find parish by ID |
getParishes | GET /query-api/catholic-polity-service/parishes | Get all parishes |
updateParish | PUT /mutation-api/catholic-polity-service/parishes/{id} | Update an existing parish |
addProvince | POST /mutation-api/catholic-polity-service/provinces | Add new province |
deleteProvince | DELETE /mutation-api/catholic-polity-service/provinces/{id} | Delete province by ID |
getProvinceById | GET /query-api/catholic-polity-service/provinces/{id} | Find province by ID |
getProvinces | GET /query-api/catholic-polity-service/provinces | Get all provinces |
updateProvince | PUT /mutation-api/catholic-polity-service/provinces/{id} | Update an existing province |
Documentation For Models
- Code
- DeaneryCollection
- DeaneryMutation
- DeaneryView
- DioceseCollection
- DioceseMutation
- DioceseSortCriteria
- DioceseView
- InstituteCollection
- InstituteMutation
- InstituteSortCriteria
- InstituteView
- ParishCollection
- ParishMutation
- ParishView
- Polity
- ProvinceCollection
- ProvinceMutation
- ProvinceView
Documentation For Authorization
polity_auth
- Type: Bearer token authentication
Example
Author
Dependencies
~12–24MB
~350K SLoC