Skip to content

Commit fe76a63

Browse files
author
andrewwilsonnew
committed
fixup 2
1 parent f5d4d40 commit fe76a63

1 file changed

Lines changed: 32 additions & 133 deletions

File tree

  • samples/config/petstore/protobuf-schema-config

‎samples/config/petstore/protobuf-schema-config/README.md‎

Lines changed: 32 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -1,133 +1,32 @@
1-
# Documentation for CDR Banking API
2-
3-
<a id="documentation-for-api-endpoints"></a>
4-
## Documentation for API Endpoints
5-
6-
All URIs are relative to *https://mtls.dh.example.com/cds-au/v1*
7-
8-
Class | Method | HTTP request | Description
9-
------------ | ------------- | ------------- | -------------
10-
*BankingAccountBalancesApi* | [**getBankingBalance**](Apis/docs/BankingAccountBalancesApi.md#getbankingbalance) | **Get** /banking/accounts/{accountId}/balance | Get Account Balance
11-
*BankingAccountBalancesApi* | [**listBankingBalancesBulk**](Apis/docs/BankingAccountBalancesApi.md#listbankingbalancesbulk) | **Get** /banking/accounts/balances | Get Bulk Balances
12-
*BankingAccountBalancesApi* | [**listBankingBalancesSpecificAccounts**](Apis/docs/BankingAccountBalancesApi.md#listbankingbalancesspecificaccounts) | **Post** /banking/accounts/balances | Get Balances For Specific Accounts
13-
*BankingAccountDirectDebitsApi* | [**listDirectDebits**](Apis/docs/BankingAccountDirectDebitsApi.md#listdirectdebits) | **Get** /banking/accounts/{accountId}/direct-debits | Get Direct Debits For Account
14-
*BankingAccountDirectDebitsApi* | [**listDirectDebitsBulk**](Apis/docs/BankingAccountDirectDebitsApi.md#listdirectdebitsbulk) | **Get** /banking/accounts/direct-debits | Get Bulk Direct Debits
15-
*BankingAccountDirectDebitsApi* | [**listDirectDebitsSpecificAccounts**](Apis/docs/BankingAccountDirectDebitsApi.md#listdirectdebitsspecificaccounts) | **Post** /banking/accounts/direct-debits | Get Direct Debits For Specific Accounts
16-
*BankingAccountScheduledPaymentsApi* | [**listScheduledPayments**](Apis/docs/BankingAccountScheduledPaymentsApi.md#listscheduledpayments) | **Get** /banking/accounts/{accountId}/payments/scheduled | Get Scheduled Payments for Account
17-
*BankingAccountScheduledPaymentsApi* | [**listScheduledPaymentsBulk**](Apis/docs/BankingAccountScheduledPaymentsApi.md#listscheduledpaymentsbulk) | **Get** /banking/payments/scheduled | Get Scheduled Payments Bulk
18-
*BankingAccountScheduledPaymentsApi* | [**listScheduledPaymentsSpecificAccounts**](Apis/docs/BankingAccountScheduledPaymentsApi.md#listscheduledpaymentsspecificaccounts) | **Post** /banking/payments/scheduled | Get Scheduled Payments For Specific Accounts
19-
*BankingAccountTransactionsApi* | [**getBankingTransactionDetail**](Apis/docs/BankingAccountTransactionsApi.md#getbankingtransactiondetail) | **Get** /banking/accounts/{accountId}/transactions/{transactionId} | Get Transaction Detail
20-
*BankingAccountTransactionsApi* | [**listBankingTransactions**](Apis/docs/BankingAccountTransactionsApi.md#listbankingtransactions) | **Get** /banking/accounts/{accountId}/transactions | Get Transactions For Account
21-
*BankingAccountsApi* | [**getBankingAccountDetail**](Apis/docs/BankingAccountsApi.md#getbankingaccountdetail) | **Get** /banking/accounts/{accountId} | Get Account Detail
22-
*BankingAccountsApi* | [**listBankingAccounts**](Apis/docs/BankingAccountsApi.md#listbankingaccounts) | **Get** /banking/accounts | Get Accounts
23-
*BankingPayeesApi* | [**getBankingPayeeDetail**](Apis/docs/BankingPayeesApi.md#getbankingpayeedetail) | **Get** /banking/payees/{payeeId} | Get Payee Detail
24-
*BankingPayeesApi* | [**listBankingPayees**](Apis/docs/BankingPayeesApi.md#listbankingpayees) | **Get** /banking/payees | Get Payees
25-
*BankingProductsApi* | [**getBankingProductDetail**](Apis/docs/BankingProductsApi.md#getbankingproductdetail) | **Get** /banking/products/{productId} | Get Product Detail
26-
*BankingProductsApi* | [**listBankingProducts**](Apis/docs/BankingProductsApi.md#listbankingproducts) | **Get** /banking/products | Get Products
27-
28-
29-
<a id="documentation-for-models"></a>
30-
## Documentation for Models
31-
32-
- [petstore.models.BankingAccountDetailV5](Models/docs/BankingAccountDetailV5.md)
33-
- [petstore.models.BankingAccountDetailV5AllOfFeaturesInner](Models/docs/BankingAccountDetailV5AllOfFeaturesInner.md)
34-
- [petstore.models.BankingAccountInstalments](Models/docs/BankingAccountInstalments.md)
35-
- [petstore.models.BankingAccountV3](Models/docs/BankingAccountV3.md)
36-
- [petstore.models.BankingAuthorisedEntity](Models/docs/BankingAuthorisedEntity.md)
37-
- [petstore.models.BankingBalance](Models/docs/BankingBalance.md)
38-
- [petstore.models.BankingBalancePurse](Models/docs/BankingBalancePurse.md)
39-
- [petstore.models.BankingBillerPayee](Models/docs/BankingBillerPayee.md)
40-
- [petstore.models.BankingCreditCardAccount](Models/docs/BankingCreditCardAccount.md)
41-
- [petstore.models.BankingDigitalWalletPayee](Models/docs/BankingDigitalWalletPayee.md)
42-
- [petstore.models.BankingDirectDebit](Models/docs/BankingDirectDebit.md)
43-
- [petstore.models.BankingDomesticPayee](Models/docs/BankingDomesticPayee.md)
44-
- [petstore.models.BankingDomesticPayeeAccount](Models/docs/BankingDomesticPayeeAccount.md)
45-
- [petstore.models.BankingDomesticPayeeCard](Models/docs/BankingDomesticPayeeCard.md)
46-
- [petstore.models.BankingDomesticPayeePayId](Models/docs/BankingDomesticPayeePayId.md)
47-
- [petstore.models.BankingFeeAmount](Models/docs/BankingFeeAmount.md)
48-
- [petstore.models.BankingFeeDiscountAmount](Models/docs/BankingFeeDiscountAmount.md)
49-
- [petstore.models.BankingFeeDiscountRange](Models/docs/BankingFeeDiscountRange.md)
50-
- [petstore.models.BankingFeeDiscountRate](Models/docs/BankingFeeDiscountRate.md)
51-
- [petstore.models.BankingFeeRange](Models/docs/BankingFeeRange.md)
52-
- [petstore.models.BankingFeeRate](Models/docs/BankingFeeRate.md)
53-
- [petstore.models.BankingInstalmentPlanSchedule](Models/docs/BankingInstalmentPlanSchedule.md)
54-
- [petstore.models.BankingInstalmentPlans](Models/docs/BankingInstalmentPlans.md)
55-
- [petstore.models.BankingInternationalPayee](Models/docs/BankingInternationalPayee.md)
56-
- [petstore.models.BankingInternationalPayeeBankDetails](Models/docs/BankingInternationalPayeeBankDetails.md)
57-
- [petstore.models.BankingInternationalPayeeBankDetailsBankAddress](Models/docs/BankingInternationalPayeeBankDetailsBankAddress.md)
58-
- [petstore.models.BankingInternationalPayeeBeneficiaryDetails](Models/docs/BankingInternationalPayeeBeneficiaryDetails.md)
59-
- [petstore.models.BankingLoanAccountV3](Models/docs/BankingLoanAccountV3.md)
60-
- [petstore.models.BankingPayeeDetailV2](Models/docs/BankingPayeeDetailV2.md)
61-
- [petstore.models.BankingPayeeV2](Models/docs/BankingPayeeV2.md)
62-
- [petstore.models.BankingProductAdditionalInformationV2](Models/docs/BankingProductAdditionalInformationV2.md)
63-
- [petstore.models.BankingProductAdditionalInformationV2AdditionalInformationUris](Models/docs/BankingProductAdditionalInformationV2AdditionalInformationUris.md)
64-
- [petstore.models.BankingProductBundle](Models/docs/BankingProductBundle.md)
65-
- [petstore.models.BankingProductCardArt](Models/docs/BankingProductCardArt.md)
66-
- [petstore.models.BankingProductCategoryV2](Models/docs/BankingProductCategoryV2.md)
67-
- [petstore.models.BankingProductConstraintV3](Models/docs/BankingProductConstraintV3.md)
68-
- [petstore.models.BankingProductDepositRateV2](Models/docs/BankingProductDepositRateV2.md)
69-
- [petstore.models.BankingProductDetailV7](Models/docs/BankingProductDetailV7.md)
70-
- [petstore.models.BankingProductDiscountEligibility](Models/docs/BankingProductDiscountEligibility.md)
71-
- [petstore.models.BankingProductDiscountV2](Models/docs/BankingProductDiscountV2.md)
72-
- [petstore.models.BankingProductEligibilityV2](Models/docs/BankingProductEligibilityV2.md)
73-
- [petstore.models.BankingProductFeatureV4](Models/docs/BankingProductFeatureV4.md)
74-
- [petstore.models.BankingProductFeeV2](Models/docs/BankingProductFeeV2.md)
75-
- [petstore.models.BankingProductInstalments](Models/docs/BankingProductInstalments.md)
76-
- [petstore.models.BankingProductLendingRateV3](Models/docs/BankingProductLendingRateV3.md)
77-
- [petstore.models.BankingProductRateConditionV2](Models/docs/BankingProductRateConditionV2.md)
78-
- [petstore.models.BankingProductRateTierV4](Models/docs/BankingProductRateTierV4.md)
79-
- [petstore.models.BankingProductV6](Models/docs/BankingProductV6.md)
80-
- [petstore.models.BankingScheduledPaymentFrom](Models/docs/BankingScheduledPaymentFrom.md)
81-
- [petstore.models.BankingScheduledPaymentInterval](Models/docs/BankingScheduledPaymentInterval.md)
82-
- [petstore.models.BankingScheduledPaymentRecurrence](Models/docs/BankingScheduledPaymentRecurrence.md)
83-
- [petstore.models.BankingScheduledPaymentRecurrenceEventBased](Models/docs/BankingScheduledPaymentRecurrenceEventBased.md)
84-
- [petstore.models.BankingScheduledPaymentRecurrenceIntervalSchedule](Models/docs/BankingScheduledPaymentRecurrenceIntervalSchedule.md)
85-
- [petstore.models.BankingScheduledPaymentRecurrenceLastWeekday](Models/docs/BankingScheduledPaymentRecurrenceLastWeekday.md)
86-
- [petstore.models.BankingScheduledPaymentRecurrenceOnceOff](Models/docs/BankingScheduledPaymentRecurrenceOnceOff.md)
87-
- [petstore.models.BankingScheduledPaymentSetV2](Models/docs/BankingScheduledPaymentSetV2.md)
88-
- [petstore.models.BankingScheduledPaymentToV2](Models/docs/BankingScheduledPaymentToV2.md)
89-
- [petstore.models.BankingScheduledPaymentV2](Models/docs/BankingScheduledPaymentV2.md)
90-
- [petstore.models.BankingTermDepositAccount](Models/docs/BankingTermDepositAccount.md)
91-
- [petstore.models.BankingTransaction](Models/docs/BankingTransaction.md)
92-
- [petstore.models.BankingTransactionDetailV2](Models/docs/BankingTransactionDetailV2.md)
93-
- [petstore.models.BankingTransactionDetailV2AllOfExtendedData](Models/docs/BankingTransactionDetailV2AllOfExtendedData.md)
94-
- [petstore.models.BankingTransactionDetailV2AllOfExtendedDataNppPayload](Models/docs/BankingTransactionDetailV2AllOfExtendedDataNppPayload.md)
95-
- [petstore.models.CommonPAFAddress](Models/docs/CommonPAFAddress.md)
96-
- [petstore.models.CommonPhysicalAddress](Models/docs/CommonPhysicalAddress.md)
97-
- [petstore.models.CommonSimpleAddress](Models/docs/CommonSimpleAddress.md)
98-
- [petstore.models.ErrorV2](Models/docs/ErrorV2.md)
99-
- [petstore.models.ErrorV2Meta](Models/docs/ErrorV2Meta.md)
100-
- [petstore.models.Links](Models/docs/Links.md)
101-
- [petstore.models.LinksPaginated](Models/docs/LinksPaginated.md)
102-
- [petstore.models.MetaPaginated](Models/docs/MetaPaginated.md)
103-
- [petstore.models.MetaPaginatedTransaction](Models/docs/MetaPaginatedTransaction.md)
104-
- [petstore.models.NppPaymentService](Models/docs/NppPaymentService.md)
105-
- [petstore.models.RequestAccountIdListV1](Models/docs/RequestAccountIdListV1.md)
106-
- [petstore.models.RequestAccountIdListV1Data](Models/docs/RequestAccountIdListV1Data.md)
107-
- [petstore.models.ResponseBankingAccountByIdV5](Models/docs/ResponseBankingAccountByIdV5.md)
108-
- [petstore.models.ResponseBankingAccountListV3](Models/docs/ResponseBankingAccountListV3.md)
109-
- [petstore.models.ResponseBankingAccountListV3Data](Models/docs/ResponseBankingAccountListV3Data.md)
110-
- [petstore.models.ResponseBankingAccountsBalanceById](Models/docs/ResponseBankingAccountsBalanceById.md)
111-
- [petstore.models.ResponseBankingAccountsBalanceList](Models/docs/ResponseBankingAccountsBalanceList.md)
112-
- [petstore.models.ResponseBankingAccountsBalanceListData](Models/docs/ResponseBankingAccountsBalanceListData.md)
113-
- [petstore.models.ResponseBankingDirectDebitAuthorisationList](Models/docs/ResponseBankingDirectDebitAuthorisationList.md)
114-
- [petstore.models.ResponseBankingDirectDebitAuthorisationListData](Models/docs/ResponseBankingDirectDebitAuthorisationListData.md)
115-
- [petstore.models.ResponseBankingPayeeByIdV2](Models/docs/ResponseBankingPayeeByIdV2.md)
116-
- [petstore.models.ResponseBankingPayeeListV2](Models/docs/ResponseBankingPayeeListV2.md)
117-
- [petstore.models.ResponseBankingPayeeListV2Data](Models/docs/ResponseBankingPayeeListV2Data.md)
118-
- [petstore.models.ResponseBankingProductByIdV7](Models/docs/ResponseBankingProductByIdV7.md)
119-
- [petstore.models.ResponseBankingProductListV4](Models/docs/ResponseBankingProductListV4.md)
120-
- [petstore.models.ResponseBankingProductListV4Data](Models/docs/ResponseBankingProductListV4Data.md)
121-
- [petstore.models.ResponseBankingScheduledPaymentsListV2](Models/docs/ResponseBankingScheduledPaymentsListV2.md)
122-
- [petstore.models.ResponseBankingScheduledPaymentsListV2Data](Models/docs/ResponseBankingScheduledPaymentsListV2Data.md)
123-
- [petstore.models.ResponseBankingTransactionByIdV2](Models/docs/ResponseBankingTransactionByIdV2.md)
124-
- [petstore.models.ResponseBankingTransactionList](Models/docs/ResponseBankingTransactionList.md)
125-
- [petstore.models.ResponseBankingTransactionListData](Models/docs/ResponseBankingTransactionListData.md)
126-
- [petstore.models.ResponseErrorListV2](Models/docs/ResponseErrorListV2.md)
127-
128-
129-
<a id="documentation-for-authorization"></a>
130-
## Documentation for Authorization
131-
132-
Endpoints do not require authorization.
133-
1+
# gPRC for petstore
2+
3+
This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
4+
5+
## Overview
6+
These files were generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
7+
8+
- API version: 1.0.0
9+
- Package version:
10+
- Generator version: 7.14.0-SNAPSHOT
11+
- Build package: org.openapitools.codegen.languages.ProtobufSchemaCodegen
12+
13+
## Usage
14+
15+
Below are some usage examples for Go and Ruby. For other languages, please refer to https://grpc.io/docs/quickstart/.
16+
17+
### Go
18+
```
19+
# assuming `protoc-gen-go` has been installed with `go get -u github.com/golang/protobuf/protoc-gen-go`
20+
mkdir /var/tmp/go/petstore
21+
protoc --go_out=/var/tmp/go/petstore services/*
22+
protoc --go_out=/var/tmp/go/petstore models/*
23+
```
24+
25+
### Ruby
26+
```
27+
# assuming `grpc_tools_ruby_protoc` has been installed via `gem install grpc-tools`
28+
RUBY_OUTPUT_DIR="/var/tmp/ruby/petstore"
29+
mkdir $RUBY_OUTPUT_DIR
30+
grpc_tools_ruby_protoc --ruby_out=$RUBY_OUTPUT_DIR --grpc_out=$RUBY_OUTPUT_DIR/lib services/*
31+
grpc_tools_ruby_protoc --ruby_out=$RUBY_OUTPUT_DIR --grpc_out=$RUBY_OUTPUT_DIR/lib models/*
32+
```

0 commit comments

Comments
 (0)