search

mojaloop / mojaloop-specification

This repo contains the specification document set of the Open API for FSP Interoperability
https://docs.mojaloop.io/api
Other
19 stars 40 forks source link

Change Request: Resolve unused/unreferenced components. #77

Open kleyow opened 3 years ago

kleyow commented 3 years ago

Open API for FSP Interoperability - Change Request

Table of Contents

1. Preface

This section contains basic information regarding the change request.

1.1 Change Request Information

__ __
Requested By Kevin Leyow, Modusbox
Change Request Status In review ☒ / Approved ☐ / Rejected ☐
Approved/Rejected Date

2. Problem Description

2.1 Background

The OpenApi definitions of v1.0 and v1.1 of the FSPIOP Specification defines components that are not used.

2.2 Current Behaviour

Current definition has unused components which are redundant or needs updating. Using bundling libraries can lead to unwanted behaviour when rending out a microservice interface.

2.3 Requested Behaviour

References are updated. Redundant components are removed.

3. Proposed Solution Options

Update references in v1.0 and v1.1 document sets.

List of defined but unused components

v1.0

Amount
AmountType
AuthenticationInfo
AuthenticationType
AuthenticationValue
AuthorizationResponse
BalanceOfPayments
BinaryString
BinaryString32
BulkTransferState
Code
CorrelationId
Currency
Date
DateOfBirth
DateTime
ErrorCode
ErrorDescription
ExtensionKey
ExtensionValue
FirstName
FspId
IlpCondition
IlpFulfilment
IlpPacket
IndividualQuote
Integer
LastName
Latitude
Longitude
MerchantClassificationCode
MiddleName
Name
Note
OtpValue
PartyIdentifier
PartyIdType
PartyName
PartySubIdOrType
PersonalIdentifierType
RefundReason
QRCODE
TokenCode
Transaction
TransactionInitiator
TransactionInitiatorType
TransactionRequestState
TransactionScenario
TransactionState
TransactionSubScenario
TransferState
UndefinedEnum

v1.1

BinaryString
BinaryString32
Date
Integer
Name
PersonalIdentifierType
TokenCode
Transaction
UndefinedEnum
elnyry-sam-k commented 3 years ago

@kleyow - don't think this is an issue with the API Definition as such; more with the tooling we use - Swagger/Open API.. Its possible that we simply leave these out of the swagger while referencing those items that fall under this type (use same regular expressions, etc) to the basic types (in the description text) in the API Definition doc.

At the time of drafting, these were included knowing that these basic types are not going to be referenced as-is.

kleyow commented 3 years ago

@elnyry-sam-k Sorry Sam. I'm really bad at using proper nomenclature.

I have no issue with the API definition. Yes this ticket is more to fix the tooling and the OpenAPI definition files that are found in this repo. Since I use them as the accurate representation of the API definition which is turned into the OpenApi definition.

Is it not possible to just fix the references in the Openapi definition.

elnyry-sam-k commented 3 years ago

hi Kevin, no need to apologize.. Lets have a meeting to discuss this and the other one on the Operation IDs. Thank you!

kleyow commented 3 years ago

Sure. Send me an invite whenever you're free.

On Thu, Feb 25, 2021, 9:28 AM Sam notifications@github.com wrote:

hi Kevin, no need to apologize.. Lets have a meeting to discuss this and the other one on the Operation IDs. Thank you!

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/mojaloop/mojaloop-specification/issues/77#issuecomment-785934852, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABNILGTRPN25QGBRG2BAVKDTAZNCNANCNFSM4XXPTMIA .