Skip to content

Commit

Permalink
fix_megalinter_format_comments
Browse files Browse the repository at this point in the history
  • Loading branch information
PedroDiez committed Apr 12, 2024
1 parent 6cc4c10 commit ac5f082
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 54 deletions.
8 changes: 4 additions & 4 deletions code/API_definitions/carrier_billing.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -673,10 +673,10 @@ components:
type: string
description: Currency code in which amount is expressed as defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).
example: "EUR"
# description:
# type: string
# description: Description text to be used for information and billing text referred to a specific item.
# example: "FIFA EA Sports 24"
description:
type: string
description: Description text (human readable) to contextualize this amount. Optionally indicated by Telco Operator.
example: "Current Amount not refunded so far"
isTaxIncluded:
type: boolean
default: false
Expand Down
100 changes: 50 additions & 50 deletions code/API_definitions/carrier_billing_refund.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ info:
CAMARA guidelines defines a set of authorization flows which can grant API clients access to the API functionality, as outlined in the document [CAMARA-API-access-and-user-consent.md](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-API-access-and-user-consent.md). Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
# Further info and support
(FAQs will be added in a later version of the documentation)
Expand Down Expand Up @@ -190,7 +190,7 @@ paths:
- $ref: "#/components/parameters/EndRefundCreationDate"
- $ref: "#/components/parameters/Order"
- $ref: "#/components/parameters/TransactionOperationStatus"
# - $ref: "#/components/parameters/MerchantIdentifier" (OPEN)
#- $ref: "#/components/parameters/MerchantIdentifier" (OPEN)

Check failure on line 193 in code/API_definitions/carrier_billing_refund.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter

193:10 [comments] missing starting space in comment
responses:
"200":
description: OK
Expand Down Expand Up @@ -290,8 +290,8 @@ components:
$ref: "#/components/schemas/AmountTransactionInput"
type:
type: string
description: |-
Type of refund.
description: |-
Type of refund.
- `total` stands for a final refund, whose amount can be indicated by API Consumer (PENDING POINT). No more refunds are allowed for that `paymentId`.
- `partial` stands for a partial refund, whose amount is indicated by API Consumer. More refunds are allowed for that `paymentId`.
enum:
Expand All @@ -318,8 +318,8 @@ components:
example: "AK234rfweSBuWGFUEWFGWEVWRV"
type:
type: string
description: |-
Type of refund.
description: |-
Type of refund.
- `total` stands for a final refund, whose amount can be indicated by API Consumer. No more refunds are allowed for that `paymentId`.
- `partial` stands for a partial refund, whose amount is indicated by API Consumer. More refunds are allowed for that `paymentId`.
enum:
Expand Down Expand Up @@ -362,8 +362,8 @@ components:
example: "AK234rfweSBuWGFUEWFGWEVWRV"
type:
type: string
description: |-
Type of refund.
description: |-
Type of refund.
- `total` stands for a final refund, whose amount can be indicated by API Consumer. No more refunds are allowed for that `paymentId`.
- `partial` stands for a partial refund, whose amount is indicated by API Consumer. More refunds are allowed for that `paymentId`.
enum:
Expand Down Expand Up @@ -462,8 +462,8 @@ components:
properties:
chargingInformation:
$ref: "#/components/schemas/ChargingInformation"
# chargingMetaData:
# $ref: "#/components/schemas/ChargingMetaData"
#chargingMetaData:

Check failure on line 465 in code/API_definitions/carrier_billing_refund.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter

465:10 [comments] missing starting space in comment
#$ref: "#/components/schemas/ChargingMetaData"

Check failure on line 466 in code/API_definitions/carrier_billing_refund.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter

466:12 [comments] missing starting space in comment

Check failure on line 466 in code/API_definitions/carrier_billing_refund.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter

466:11 [comments-indentation] comment not indented like content
refundDetails:
$ref: "#/components/schemas/RefundDetails"
RefundDetails:
Expand Down Expand Up @@ -536,39 +536,39 @@ components:
description: |
The tax amount refunded by the merchant. Indicated when the merchant is the one applying taxes. This field also provides an indicator to the downstream billing system.
example: 21
# ChargingMetaData:
# type: object
# properties:
# merchantName:
# type: string
# description: Indicates the merchant name. Allows aggregators/partners to specify the actual merchant name
# example: "EA Sports"
# merchantIdentifier:
# type: string
# description: Indicates the merchant identifier. Allows aggregators/partners to specify the actual merchant identifier
# example: "eas-12345"
# fee:
# type: number
# format: float
# multipleOf: 0.01
# description: Percentage of the amount to be received by the requester
# example: 10
# purchaseCategoryCode:
# type: string
# description: A category defining the type of service, product or media being purchased
# example: "games"
# channel:
# type: string
# description: The channel over which the requester is interacting with the merchant (e.g. WAP, Web, SMS...)
# example: "web"
# serviceId:
# type: string
# description: The identifier of the partner/merchant service being purchased
# example: "games-online"
# productId:
# type: string
# description: The product identifier to be combined with the `serviceId` to uniquely identify the product being purchased. For example if the `serviceId` relates to a VOD service, the `productId` can specify the movie rented
# example: "138235321"
#ChargingMetaData:

Check failure on line 539 in code/API_definitions/carrier_billing_refund.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter

539:6 [comments] missing starting space in comment
#type: object

Check failure on line 540 in code/API_definitions/carrier_billing_refund.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter

540:8 [comments] missing starting space in comment

Check failure on line 540 in code/API_definitions/carrier_billing_refund.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter

540:7 [comments-indentation] comment not indented like content
#properties:

Check failure on line 541 in code/API_definitions/carrier_billing_refund.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter

541:8 [comments] missing starting space in comment
#merchantName:

Check failure on line 542 in code/API_definitions/carrier_billing_refund.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter

542:10 [comments] missing starting space in comment

Check failure on line 542 in code/API_definitions/carrier_billing_refund.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter

542:9 [comments-indentation] comment not indented like content
#type: string
#description: Indicates the merchant name. Allows aggregators/partners to specify the actual merchant name
#example: "EA Sports"
#merchantIdentifier:
#type: string
#description: Indicates the merchant identifier. Allows aggregators/partners to specify the actual merchant identifier
#example: "eas-12345"
#fee:
#type: number
#format: float
#multipleOf: 0.01
#description: Percentage of the amount to be received by the requester
#example: 10
#purchaseCategoryCode:
#type: string
#description: A category defining the type of service, product or media being purchased
#example: "games"
#channel:
#type: string
#description: The channel over which the requester is interacting with the merchant (e.g. WAP, Web, SMS...)
#example: "web"
#serviceId:
#type: string
#description: The identifier of the partner/merchant service being purchased
#example: "games-online"
#productId:
#type: string
#description: The product identifier to be combined with the `serviceId` to uniquely identify the product being purchased. For example if the `serviceId` relates to a VOD service, the `productId` can specify the movie rented
#example: "138235321"
CloudEvent:
description: The notification format
required:
Expand Down Expand Up @@ -1049,13 +1049,13 @@ components:
- processing
- denied
- succeeded
# MerchantIdentifier:
# description: Merchant identifier to filter the results
# in: query
# name: merchantIdentifier
# required: false
# schema:
# type: string
#MerchantIdentifier:
#description: Merchant identifier to filter the results
#in: query
#name: merchantIdentifier
#required: false
#schema:
#type: string
headers:
x-correlator:
description: Correlation id for the different services
Expand Down

0 comments on commit ac5f082

Please sign in to comment.